ionbal.h File Reference

#include "module.h"
#include "container_classes.h"

Include dependency graph for ionbal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	t_ionbal

Functions
void	ion_recom_calculate (void)
void	ion_zero (long int nelem)
void	ion_collis (long nelem)
void	ion_solver (long int nelem, bool lgPrintIt)
void	ion_photo (long int nelem, bool lgPrintIt)
void	ion_CX (long nelem)
void	ion_recomb (bool, long)
void	ion_recombAGN (FILE *io)
void	ion_wrapper (long nelem)
void	Badnell_rec_init (void)
void	IonNelem (bool lgPrintIt, long int nelem)
void	IonHelium (void)

Variables
static const int	NSHELLS = 7
t_ionbal	ionbal

Function Documentation

void Badnell_rec_init

(

void

)

Badnell_rec_init This code is written by Terry Yun, 2005 * It reads rate coefficient fits into 3D arrays and output array.out for testing * The testing can be commented out

References multi_arr< T, d, ALLOC, lgBC >::alloc(), ASSERT, Badnell_DR_rate_eval(), Badnell_RR_rate_eval(), cdEXIT, multi_arr< T, d, ALLOC, lgBC >::clone(), DEBUG_ENTRY, dense, freeBound::DielecRecombVsTemp, DR_Badnell_rate_coef_mean_ion, EXIT_FAILURE, exp10(), t_iso_sp::fb, FFmtRead(), fprintf(), t_ionbal::guess_noise, ionbal, ioQQQ, ipH_LIKE, ipHE_LIKE, ipHELIUM, ipHYDROGEN, iso_sp, L_, t_dense::lgElmtOn, lgMustAllocateRec, LIMELM, MAX2, MAX_FIT_PAR_DR, MAX_FIT_PAR_RR, t_iso_sp::nCollapsed_max, NISO, t_ran::normal(), NUM_DR_TEMPS, t_iso_sp::numLevels_max, open_data(), pow3(), t_iso_sp::QN2Index(), ran, read_whole_line(), RecNoise, multi_arr< T, d, ALLOC, lgBC >::reserve(), S, S_, TorF(), TotalInsanity(), and Triangle2().

Referenced by cloudy(), and ParseCompile().

Here is the call graph for this function:

void ion_collis

(

long

nelem

)

ion_collis fill in collisional ionization rates, and resulting cooling

Parameters

nelem

element number on C scale, H is 0

void ion_CX

(

long

nelem

)

charge exchange for element nelem

charge exchange ionization / recombination

References ASSERT, atmdat, t_atmdat::CharExcRecTo, t_ionbal::CX_recomb_rate_used, DEBUG_ENTRY, dense, ionbal, t_dense::IonHigh, t_dense::IonLow, iso_sp, LIMELM, MIN2, t_atmdat::NCX, NISO, and t_iso_sp::st.

Referenced by IonNelem().

void ion_photo	(	long int	nelem,
		bool	lgPrintIt
	)

ion_photo fill array PhotoRate with photoionization rates for heavy elements

Parameters

nelem	is atomic number on C scale, 0 for H
lgPrintIt	debugging flag to turn on print

References ASSERT, atmdat, atoms, t_oxy::AugerO3, t_atmdat::CharExcIonOf, t_elementnames::chElementNameShort, t_Heavy::chShell, t_ionbal::CompRecoilHeatRate, t_ionbal::CompRecoilIonRate, conv, t_oxy::d5007r, t_atoms::d5200r, t_oxy::d6300, dBaseSpecies, dBaseStates, DEBUG_ENTRY, dense, t_atmdat::EIonPot, elementnames, GrainVar::elmSumAbund, t_rfield::extin_mag_V_point, t_iso_sp::fb, fe, t_fe::fegrain, t_fe::fekcld, t_fe::fekhot, fprintf(), GammaK(), GammaPrt(), gv, t_phoHeat::HeatHiEnr, t_phoHeat::HeatLowEnr, t_phoHeat::HeatNet, Heavy, hmi, hmrate4(), t_oxy::i2d, t_oxy::i2p, t_opac::in1, Singleton< t_yield >::Inst(), ionbal, t_dense::IonHigh, t_dense::IonLow, t_opac::iopo2d, ioQQQ, ipCALCIUM, ipCARBON, TransitionProxy::ipCont(), t_opac::ipElement, ipH1s, ipH2p, ipH_LIKE, ipHELIUM, ipHYDROGEN, ipIRON, ipMAGNESIUM, t_opac::ipmgex, ipNITROGEN, t_opac::ipo1exc, t_opac::ipo3exc, t_opac::ipo3exc3, ipoint(), t_opac::ipOpMgEx, ipOXYGEN, t_atmdat::ipSpecIon, iso_sp, GrainVar::lgDustOn(), t_dense::lgElmtOn, t_mole_global::lgLeidenHack, t_ionbal::lgPhotoIoniz_On, t_opac::lgRedoStatic, GrainVar::lgWD01, LIMELM, MAX2, MIN2, mole_global, t_rfield::nflux, NISO, t_conv::nPres2Ioniz, t_Heavy::nsShells, opac, t_rfield::otslin, oxy, t_atoms::p2nit, t_ionbal::PhotoRate_Shell, phycon, t_oxy::poiexc, t_oxy::poiii2, t_oxy::poiii2Max, t_oxy::poiii3, t_oxy::poiii3Max, t_oxy::poimax, t_atoms::popMg2, t_oxy::r4363Max, t_oxy::r5007Max, rfield, t_oxy::s3727, t_oxy::s7325, t_thermal::setHeating(), SMALLFLOAT, t_phycon::te, thermal, t_iso_sp::trans(), t_hmi::UV_Cont_rel2_Habing_TH85_face, t_dense::xIonDense, and t_atoms::xMg2Max.

Referenced by IonNelem().

Here is the call graph for this function:

void ion_recom_calculate

(

void

)

    ion_recom_calculate called by conv_base to calculate radiative and dielectronic

recombination rate coefficients

References ASSERT, atmdat_dielrec_fe(), Badnell_DR_rate_eval(), Badnell_RR_rate_eval(), chDRDataSource, t_elementnames::chElementNameShort, chRRDataSource, CollisSuppres(), DEBUG_ENTRY, dense, t_ionbal::DR_Badnell_rate_coef, DR_Badnell_rate_coef_mean_ion, t_ionbal::DR_Badnell_suppress_fact, t_ionbal::DR_mean_scale, t_dense::eden, elementnames, fp_equal(), fprintf(), Singleton< t_ADfA >::Inst(), ionbal, ioQQQ, ipHELIUM, ipHYDROGEN, ipIRON, t_save::ipSDSFile, t_ionbal::lgDRsup, t_ionbal::lgRecom_Badnell_print, t_save::lgSDSOn, LIMELM, MIN2, phycon, powpq(), t_ADfA::rad_rec(), RecNoise, t_ionbal::RR_Badnell_rate_coef, t_ionbal::RR_rate_coef_used, t_ionbal::RR_Verner_rate_coef, save, sexp(), t_phycon::te, and t_phycon::te_eV.

Referenced by ConvBase().

Here is the call graph for this function:

void ion_recomb	(	bool	,
		long
	)

ion_recomb generate recombination coefficients for any species

void ion_recombAGN

(

FILE *

io

)

ion_recombAGN generate recombination coefficients for AGN table

References abund, ASSERT, t_elementnames::chElementSym, ConvBase(), DEBUG_ENTRY, dense, t_dense::eden, EdenChange(), elementnames, fprintf(), Heavy, ionbal, t_dense::IonHigh, t_dense::IonLow, ipHYDROGEN, ipLITHIUM, t_abund::lgAGN, t_dense::lgElmtOn, LIMELM, phycon, t_ionbal::RateRecomTot, t_phycon::te, TempChange(), and t_Heavy::Valence_IP_Ryd.

Referenced by SaveDo().

Here is the call graph for this function:

void ion_solver	(	long int	nelem,
		bool	lgPrintIt
	)

ion_solver solve the bi-diagonal matrix for ionization balance

Parameters

nelem	- element number on C scale, He is 1
lgPrintIt	- option to print details of matrix elements

References ASSERT, broken(), clean_up(), conv, DEBUG_ENTRY, dense, fill_array(), fill_ext_src_and_snk(), find_solution(), get_total_abundance_ions(), Heavy, HomogeneousSource(), ionbal, t_dense::IonHigh, t_dense::IonLow, ipCARBON, ipH_LIKE, iso_charge_transfer_update(), iso_departure_coefficients(), iso_satellite_update(), iso_set_ion_rates(), iso_solve(), t_prt::lgPrtArry, lgTrivialSolution(), LIMELM, MIN2, NISO, t_Heavy::nsShells, t_ionbal::PhotoRate_Shell, PrintRates(), prt, t_ionbal::RateRecomTot, t_conv::register_(), renorm_solution(), and store_new_densities().

Referenced by IonHelium(), IonHydro(), and IonNelem().

Here is the call graph for this function:

void ion_wrapper

(

long

nelem

)

ion_wrapper a wrapper that redirects to IonHelium, IonCarbo, etc..

References ASSERT, t_elementnames::chElementSym, DEBUG_ENTRY, dense, elementnames, fprintf(), t_dense::gas_phase, IonHelium(), IonHydro(), IonNelem(), ioQQQ, ipHELIUM, ipHYDROGEN, lgElemsConserved(), t_dense::lgElmtOn, t_trace::lgHeavyBug, t_trace::lgTrace, LIMELM, trace, and t_dense::xIonDense.

Referenced by ConvBase().

Here is the call graph for this function:

void ion_zero

(

long int

nelem

)

ion_zero zero out heating and charge transfer save arrays

References DEBUG_ENTRY, t_thermal::setHeating(), and thermal.

Referenced by IonNelem().

Here is the call graph for this function:

void IonHelium

(

void

)

References conv, DEBUG_ENTRY, dense, fprintf(), t_dense::gas_phase, ion_solver(), ionbal, ioQQQ, ipH_LIKE, ipHE_LIKE, ipHELIUM, iso_sp, t_dense::lgElmtOn, t_trace::lgHeBug, t_dense::lgSetIoniz, t_conv::nTotalIoniz, nzone, t_ionbal::RateIonizTot(), t_ionbal::RateRecomTot, t_ionbal::RR_rate_coef_used, t_dense::SetIoniz, t_iso_sp::st, trace, and t_dense::xIonDense.

Referenced by ion_wrapper().

Here is the call graph for this function:

void IonNelem	(	bool	lgPrintIt,
		long int	nelem
	)

References DEBUG_ENTRY, dense, fnzone, fprintf(), t_dense::gas_phase, ion_collis(), ion_CX(), ion_photo(), ion_recomb(), ion_solver(), ion_zero(), ioQQQ, t_dense::lgElmtOn, t_trace::lgHeavyBug, t_trace::lgTrace, trace, and t_dense::xIonDense.

Referenced by ion_wrapper().

Here is the call graph for this function:

Variable Documentation

t_ionbal ionbal

Referenced by atmdat_3body(), atom_level2(), Badnell_rec_init(), diatomics::CalcPhotoionizationRate(), ContCreatePointers(), ContSetIntensity(), ConvBase(), CoolEvaluate(), CoolHyperfine(), CoolZero(), da(), dBase_solve(), fill_array(), find_solution(), GammaPrtRate(), GammaPrtShells(), get_total_abundance_ions(), GrainChargeTemp(), HeatSum(), highen(), HomogeneousSource(), HydroLevel(), InitDefaultsPreparse(), ion_collis(), ion_CX(), ion_photo(), ion_recom_calculate(), ion_recomb(), ion_recombAGN(), ion_solver(), ion_trim(), ion_trim2(), ion_trim_from_set(), ion_trim_init(), ion_trim_small(), IonHelium(), iso_collide(), iso_ionize_recombine(), iso_level(), iso_photo(), iso_radiative_recomb(), iso_set_ion_rates(), iso_update_rates(), IterRestart(), IterStart(), lgNetEdenSrcSmall(), lines(), lines_general(), mole_ion_trim(), mole_solve(), OpacityAddTotal(), ParseCosmicRays(), ParseDont(), ParseSet(), PrintRates(), PrtHydroTrace1a(), PrtZone(), renorm_solution(), SaveDo(), SecIoniz(), UpdateUTAs(), and zero().

const int NSHELLS = 7

static

max number of shells we ever have to deal with

Referenced by t_ionbal::alloc().