cloudy  trunk
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Data Fields
t_ionbal Struct Reference

#include <ionbal.h>

Collaboration diagram for t_ionbal:
Collaboration graph
[legend]

Data Fields

double trimhi
 
double trimlo
 
bool lgTrimhiOn
 
double **** PhotoRate_Shell
 
bool lgPhotoIoniz_On
 
bool lgHO_ct_chem
 
double *** CollIonRate_Ground
 
double CosRayIonRate
 
double CosRayHeatNeutralParticles
 
double CosRayHeatThermalElectrons
 
double ExtraHeatRate
 
double xNeutronHeatRate
 
double PairProducPhotoRate [3]
 
bool lgCompRecoil
 
double CompRecoilHeatLocal
 
long int ** ipCompRecoil
 
double ** CompRecoilIonRate
 
double ** CompRecoilIonRateSave
 
double ** CompRecoilHeatRate
 
double ** CompRecoilHeatRateSave
 
double ** UTA_ionize_rate
 
double ** UTA_heat_rate
 
bool lgInnerShellLine_on
 
bool lgInnerShell_Kisielius
 
bool lgInnerShell_Gu06
 
double ** RateIonizTot
 
long int nCompRecoilElec [LIMELM]
 
double CompHeating_Max
 
double ** RateRecomTot
 
double ** RR_Badnell_rate_coef
 
double ** DR_Badnell_rate_coef
 
double * DR_Badnell_rate_coef_mean_ion
 
int ** lgDR_Badnell_rate_coef_exist
 
int ** lgRR_Badnell_rate_coef_exist
 
bool lg_use_DR_Badnell_rate_coef_mean_ion
 
bool lgDR_recom_Badnell_use
 
bool lgRR_recom_Badnell_use
 
bool lgRecom_Badnell_print
 
double ** DR_old_rate_coef
 
double ** RR_rate_coef_used
 
double ** DR_rate_coef_used
 
double ** RR_Verner_rate_coef
 
int nDR_S_guess
 
realnum DR_S_scale [5]
 
realnum ** GrainCreat
 
realnum ** GrainDestr
 
int lgGrainIonRecom
 
realnum DielSupprs [2][LIMELM]
 
realnum lg_guess_coef
 
realnum guess_noise
 
bool lgSupDie [2]
 
realnum GuessDiel [4]
 
bool lgNoCota
 
realnum CotaRate [LIMELM]
 
long int ilt
 
long int iltln
 
long int ilthn
 
long int ihthn
 
long int ifail
 

Detailed Description

struc definition for vars dealing with ionization balance

Definition at line 89 of file ionbal.h.

Field Documentation

double*** t_ionbal::CollIonRate_Ground

collisional ionization rate for CollidRate[nelem][ion][0], s-1 cooling, erg/s in CollidRate[nelem][ion][1] [LIMELM][LIMELM][2]

Definition at line 134 of file ionbal.h.

Referenced by ion_collis(), ion_solver(), iso_collide(), iso_level(), and zero().

double t_ionbal::CompHeating_Max

Definition at line 203 of file ionbal.h.

Referenced by lines_general(), and PrtComment().

double t_ionbal::CompRecoilHeatLocal

the local heating due to Compton recoil ionization

Definition at line 166 of file ionbal.h.

Referenced by lines_general(), and PrtZone().

double** t_ionbal::CompRecoilHeatRate

heating rate due to bound electron ionization by Compton scattering

Definition at line 178 of file ionbal.h.

Referenced by highen(), ion_photo(), iso_photo(), IterRestart(), IterStart(), and zero().

double** t_ionbal::CompRecoilHeatRateSave

save heating rate due to bound electron ionization by Compton scattering

Definition at line 181 of file ionbal.h.

Referenced by IterRestart(), IterStart(), and zero().

double** t_ionbal::CompRecoilIonRate

rate of bound electron ionization by Compton scattering

Definition at line 172 of file ionbal.h.

Referenced by highen(), hmole_step(), ion_photo(), iso_photo(), IterRestart(), IterStart(), and zero().

double** t_ionbal::CompRecoilIonRateSave

save rate of bound electron ionization by Compton scattering

Definition at line 175 of file ionbal.h.

Referenced by IterRestart(), IterStart(), and zero().

double t_ionbal::CosRayHeatNeutralParticles

cosmic ray heating rate - erg s-1 - must multiply by density of absorbers - neutral hydrogen to get volume rate

Definition at line 141 of file ionbal.h.

Referenced by highen().

double t_ionbal::CosRayHeatThermalElectrons

cosmic ray heating of thermal electrons - must multiply by electron density to obtain erg cm-3 s-1

Definition at line 145 of file ionbal.h.

Referenced by highen().

double t_ionbal::CosRayIonRate

cosmic ray ionization rate

Definition at line 137 of file ionbal.h.

Referenced by ContSetIntensity(), highen(), and ParseCosmicRays().

realnum t_ionbal::CotaRate[LIMELM]

the actual rates

Definition at line 278 of file ionbal.h.

Referenced by atmdat_3body(), ion_recomb(), PrtHydroTrace1a(), and zero().

realnum t_ionbal::DielSupprs[2][LIMELM]

suppression factors for dielectronic recombination 1 is burgess and 2 is Storey

Definition at line 258 of file ionbal.h.

Referenced by atmdat_DielSupres(), ion_recomb(), lines_lv1_li_ne(), and lines_lv1_na_ar().

double ** t_ionbal::DR_Badnell_rate_coef

Definition at line 214 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), ion_solver(), iso_radiative_recomb(), and zero().

double * t_ionbal::DR_Badnell_rate_coef_mean_ion

Definition at line 214 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), and zero().

double** t_ionbal::DR_old_rate_coef

rate coefficients [cm3 s-1] for older DR recombination

Definition at line 232 of file ionbal.h.

Referenced by ion_recomb(), ion_solver(), and zero().

double ** t_ionbal::DR_rate_coef_used

Definition at line 235 of file ionbal.h.

Referenced by ion_recomb(), and zero().

realnum t_ionbal::DR_S_scale[5]

Definition at line 246 of file ionbal.h.

Referenced by ion_recom_calculate(), and ParseSet().

double t_ionbal::ExtraHeatRate

local heating rate due to some "extra" process

Definition at line 148 of file ionbal.h.

Referenced by highen().

realnum** t_ionbal::GrainCreat

rate for recombination and ionization on grain surfaces

Definition at line 249 of file ionbal.h.

realnum ** t_ionbal::GrainDestr

Definition at line 249 of file ionbal.h.

realnum t_ionbal::guess_noise

log normal noise for guess, zero by default, turned on with noise option

Definition at line 263 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

realnum t_ionbal::GuessDiel[4]

this is fudge factor for scaled Nussbaumer and Storey dielectronic recombination, set with dielectronic kludge command, usually 1

Definition at line 271 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

long int t_ionbal::ifail

Definition at line 281 of file ionbal.h.

Referenced by da(), IterStart(), PrtComment(), and zero().

long int t_ionbal::ihthn

Definition at line 281 of file ionbal.h.

Referenced by da(), IterStart(), and zero().

long int t_ionbal::ilt

these are error flags for three-body recombination

Definition at line 281 of file ionbal.h.

Referenced by da(), IterStart(), and zero().

long int t_ionbal::ilthn

Definition at line 281 of file ionbal.h.

Referenced by da(), IterStart(), and zero().

long int t_ionbal::iltln

Definition at line 281 of file ionbal.h.

Referenced by da(), IterStart(), and zero().

long int** t_ionbal::ipCompRecoil

array indices for continuum offset of Compton recoil ionization threshold

Definition at line 169 of file ionbal.h.

Referenced by ContCreatePointers(), ContSetIntensity(), highen(), OpacityAddTotal(), and zero().

realnum t_ionbal::lg_guess_coef

flag for guess of entire range of dr - false by default, true with kludge steve

Definition at line 261 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

bool t_ionbal::lg_use_DR_Badnell_rate_coef_mean_ion

use the mean Badnell rates in place of existing hacks?

Definition at line 223 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

bool t_ionbal::lgCompRecoil

flag saying that Compton recoil ionization of bound electrons is enabled, set false with no recoil ionization command

Definition at line 163 of file ionbal.h.

Referenced by ContSetIntensity(), highen(), ParseDont(), and zero().

int** t_ionbal::lgDR_Badnell_rate_coef_exist

do these rate coefficients exist?

Definition at line 219 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), and zero().

bool t_ionbal::lgDR_recom_Badnell_use

do we use new Badnell rates?

Definition at line 226 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

int t_ionbal::lgGrainIonRecom

grecon usually true, set to 0 with no grain neutralization command

Definition at line 254 of file ionbal.h.

Referenced by GrainChargeTemp(), ion_solver(), ParseDont(), and zero().

bool t_ionbal::lgHO_ct_chem

should H - O charge transfer be done in ionization or chemistry? default is chemistry, true

Definition at line 130 of file ionbal.h.

Referenced by ChargeTransferUpdate(), hmole_step(), ParseSet(), and zero().

bool t_ionbal::lgInnerShell_Gu06

this says whether to replace the Behar 01 data with the Bu et al. 06 data - default is true, to do so, set false with SET UTA BEHAR command

Definition at line 194 of file ionbal.h.

Referenced by atmdat_readin(), ParseSet(), and zero().

bool t_ionbal::lgInnerShell_Kisielius

says whether to include the new Romas data set

Definition at line 191 of file ionbal.h.

Referenced by atmdat_readin(), ParseSet(), and zero().

bool t_ionbal::lgInnerShellLine_on

this says whether to include inner shell absorption lines

Definition at line 189 of file ionbal.h.

Referenced by ConvBase(), ParseDont(), and zero().

bool t_ionbal::lgNoCota

following all for 3-body recombination lgNoCota flag set with no three body recombination

Definition at line 275 of file ionbal.h.

Referenced by atmdat_3body(), ParseDont(), and zero().

bool t_ionbal::lgPhotoIoniz_On

set to 1 in zero, so have no effect, set to 0 with 'no photoionization' command, kills photoionization of everything

Definition at line 126 of file ionbal.h.

Referenced by GammaPrtShells(), hmole_step(), ion_photo(), iso_photo(), ParseDont(), and zero().

bool t_ionbal::lgRecom_Badnell_print

option to print rates then exit

Definition at line 226 of file ionbal.h.

Referenced by ion_recom_calculate(), ParseSet(), and zero().

int ** t_ionbal::lgRR_Badnell_rate_coef_exist

Definition at line 219 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), and zero().

bool t_ionbal::lgRR_recom_Badnell_use

Definition at line 226 of file ionbal.h.

Referenced by ion_recomb(), ParseSet(), and zero().

bool t_ionbal::lgSupDie[2]

logical flag for suppression of dielectronic recombination 1 is burgess, 2 is Nussbaumer and Storey

Definition at line 267 of file ionbal.h.

Referenced by atmdat_DielSupres(), ParseSet(), and zero().

bool t_ionbal::lgTrimhiOn

option to turn off upward ionization trimming, with set trim upper off

Definition at line 105 of file ionbal.h.

Referenced by ion_trim(), ParseSet(), and zero().

long int t_ionbal::nCompRecoilElec[LIMELM]

number of valence electrons that can participate - multiplies since electron rate

Definition at line 201 of file ionbal.h.

Referenced by highen(), InitCoreload(), and OpacityAddTotal().

int t_ionbal::nDR_S_guess

three cases for S DR - 0, default larger of guess and Badnell 1, pure Badnell 3, scaled oxygen

Definition at line 245 of file ionbal.h.

Referenced by ion_recom_calculate(), ParseSet(), and zero().

double t_ionbal::PairProducPhotoRate[3]

ionization and heating due to pair production

Definition at line 155 of file ionbal.h.

Referenced by highen(), and lines_general().

double**** t_ionbal::PhotoRate_Shell
store photoionization rates for all shells of all elements
first dim is nelem, the atomic number of element on the c scale, H is 0.
second dim is stage of ionization, on the c scale, atom is 0.
third dim is shell number, K shell is 0, valence shell depends on ion, up to 7
last dim: 0 is photo rate (s-1)
          1 is low energy heating
          2 is high energy (secondary-capable) total heating
          both will be multiplied by ion abundance to get vol rates 
some special last pairs - 
[x][0][10][0] pair production in highen 

[LIMELM][LIMELM][7][3]

Definition at line 121 of file ionbal.h.

Referenced by co_lnu_c_o_lnu(), GammaPrtRate(), GammaPrtShells(), ion_photo(), ion_solver(), IonCalci(), IonCarbo(), IonIron(), IonMagne(), IonNitro(), IonOxyge(), IonSilic(), iso_photo(), lines(), lines_lv1_na_ar(), PunchDo(), and zero().

double** t_ionbal::RateIonizTot

total ionization rate (s-1) all processes

Definition at line 197 of file ionbal.h.

Referenced by CO_solve(), ele_ion_ladder(), hmole(), HydroLevel(), ion_solver(), IonNitro(), IonOxyge(), IonSilic(), IonSulph(), iso_level(), PunchDo(), and zero().

double** t_ionbal::RateRecomTot
double** t_ionbal::RR_Badnell_rate_coef

rate coefficients [cm3 s-1] for Badnell DR recombination

Definition at line 214 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), and zero().

double** t_ionbal::RR_rate_coef_used

radiative recombination rate coefficient (cm3 s-1) used by code

Definition at line 235 of file ionbal.h.

Referenced by CoolEvaluate(), ion_recomb(), ion_solver(), IonHelium(), iso_ionize_recombine(), and zero().

double** t_ionbal::RR_Verner_rate_coef

radiative recombination rate coefficient returned from Dima Verner's routine

Definition at line 239 of file ionbal.h.

Referenced by ion_recom_calculate(), ion_recomb(), and zero().

double t_ionbal::trimhi

limits for highest and lowest stages of ionization in ion_trim, these are set with command "set trim xx" where xx is log of upper and lower ionization fractions. if only one number then both are set to it. These variables are used in trimStages to adjust the range of ionization.
limit to fractional abundance of high stage of ionization, set to 1e-6 in zero.c

Definition at line 98 of file ionbal.h.

Referenced by ion_trim(), ParseSet(), and zero().

double t_ionbal::trimlo

limit to fractional abundance of low stage of ionization, set to 1e-10 in zero.c

Definition at line 98 of file ionbal.h.

Referenced by ion_trim(), ParseSet(), and zero().

double** t_ionbal::UTA_heat_rate

inner shell UTA heating rate

Definition at line 186 of file ionbal.h.

Referenced by ConvBase(), and zero().

double** t_ionbal::UTA_ionize_rate

inner shell UTA ionization rate, includes autoionization probability

Definition at line 184 of file ionbal.h.

Referenced by ConvBase(), ion_solver(), and zero().

double t_ionbal::xNeutronHeatRate

heating erg s-1 due to fast neutrons - energy flux times cross section but does not include density

Definition at line 152 of file ionbal.h.

Referenced by highen().


The documentation for this struct was generated from the following file:

Generated for cloudy by doxygen 1.8.3.1