#include "module.h"

Include dependency graph for conv.h:

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

Data Structures
struct	t_conv

class	ConvergenceCounter

Functions
void	ConvIterCheck (void)

bool	ConvInitSolution ()

int	ConvPresTempEdenIoniz (void)

int	ConvTempEdenIoniz (void)

int	ConvEdenIoniz (void)

int	ConvIoniz (void)

void	ConvFail (const char chMode[], const char chDetail[])

int	ConvBase (long loopi)

int	eden_sum (void)

void	EdenChange (double EdenNew)

Variables
t_conv	conv

Detailed Description

this is the series of routines that converge the pressure, temperature, electron density, and ionization, for a zone. Ideally, only the top routine, ConvPresTempEdenIoniz, should be public

Definition in file conv.h.

Function Documentation

int ConvBase ( long loopi )

ConvBase main routine to drive ionization solution for all species, find total opacity called by ConvIoniz/ lgConverg check whether ionization of element nelem has converged

Parameters

loopi this tells how many times ConvBase has been called by ConvIoniz while trying to converge electron density == 0 on first call - allows logic in ConvBase to check for ots oscillations

Todo:: 0 PvH prefers test against err/10

Definition at line 188 of file conv_base.cpp.

References ASSERT, atmdat, atmdat_3body(), t_thermal::char_tran_cool, t_thermal::char_tran_heat, t_atmdat::CharExcIonOf, t_atmdat::CharExcRecTo, ChargTranEval(), ChargTranSumHeat(), t_conv::chConvIoniz(), t_elementnames::chElementSym, t_save::chHashString, conv, CoolEvaluate(), CoolSave(), t_secondaries::csupra, t_thermal::ctot, DEBUG_ENTRY, molezone::den, dense, deut, diatoms, DumpLine(), DynaIonize(), dynamics, t_dense::eden, eden_sum(), t_conv::EdenErrorAllowed, t_dense::EdenTrue, t_mole_local::elec, elementnames, findspecies(), findspecieslocal(), fnzone, fp_equal(), fprintf(), t_deuterium::gas_phase, t_dense::gas_phase, GrainDrive(), gv, t_hmi::H2_total, t_conv::HeatCoolRelErrorAllowed, HeatSum(), HeatZero(), highen(), hmi, t_thermal::htot, INPUT_LINE_LENGTH, ion_recom_calculate(), ion_trim(), ion_trim2(), ion_trim_from_set(), ion_trim_validate(), ion_widen(), ion_wrapper(), ionbal, t_dense::IonHigh, t_conv::IonizErrorAllowed, t_dense::IonLow, ioQQQ, ipH_LIKE, ipHELIUM, ipHYDROGEN, ipOXYGEN, t_save::ipTraceConvergeBase, iso_collapsed_update(), iso_multiplet_opacities(), iso_renorm(), iso_solve(), iso_sp, iso_update_rates(), iteration, lgAbort, t_dynamics::lgAdvection, lgConvBaseHeatTest, t_conv::lgConvIoniz(), lgElemsConserved(), t_deuterium::lgElmtOn, t_dense::lgElmtOn, t_conv::lgFirstSweepThisZone, GrainVar::lgGrainElectrons, t_rfield::lgIonizReevaluate, t_conv::lgIonStageTrimed, lgNetEdenSrcSmall(), t_ionbal::lgNewTrim, t_rfield::lgOpacityReevaluate, t_opac::lgOpacStatic, t_conv::lgOscilOTS, t_trace::lgOTSBug, t_opac::lgRedoStatic, t_conv::lgSearch, lgStatesConserved(), t_thermal::lgTemperatureConstant, t_dynamics::lgTimeDependentStatic, t_trace::lgTrace, t_save::lgTraceConvergeBase, t_save::lgTraceConvergeBaseHash, t_conv::lgUpdateCouplings, LIMELM, t_conv::limPres2Ioniz, t_mole_global::list, MAX2, MIN2, mole, mole_dominant_rates(), mole_drive(), mole_global, mole_save(), mole_update_sources(), t_atmdat::NCX, NISO, t_conv::nPres2Ioniz, t_conv::nTotalIoniz, t_StopCalc::nTotalIonizStop, t_trace::nTrConvg, t_mole_global::num_calc, nzone, opac, OpacityAddTotal(), phycon, PresTotCurrent(), t_ionbal::RateIonizTot(), t_conv::register_(), t_conv::resetConvIoniz(), rfield, RT_line_all_escape(), RT_OTS(), RT_OTS_PrtRate(), RT_OTS_Update(), save, SaveHeat(), SDIV(), t_secondaries::sec2total, SecIoniz(), secondaries, t_conv::setConvIonizFail(), SetDeuteriumIonization(), SMALLFLOAT, t_mole_local::species, t_iso_sp::st, StopCalc, t_phycon::te, t_thermal::te_update, thermal, TorF(), GrainVar::TotalEden, trace, UpdateUTAs(), x0, x1, x2, t_deuterium::xIonDense, t_dense::xIonDense, and t_dense::xNucleiTotal.

Referenced by ConvInitSolution(), ConvIoniz(), and ion_recombAGN().

int ConvEdenIoniz ( void )

ConvEdenIoniz called by ConvTempEdenIoniz and ConvInitIonize, it calls ConvIoniz and converges the electron density

Returns: returns 1 if error condition, 0 if ok

Definition at line 22 of file conv_eden_ioniz.cpp.

References iter_track::add(), iter_track::bracket_width(), t_conv::chConvIoniz(), t_conv::chSolverEden, iter_track::clear(), conv, CoolEvaluate(), t_thermal::ctot, DEBUG_ENTRY, dense, iter_track::deriv(), t_dense::eden, EdenError(), t_dense::EdenTrue, fp_equal(), fprintf(), HeatSum(), iter_track::in_bounds(), iter_track::init_bracket(), ioQQQ, lgConvBaseHeatTest, lgConvEden(), t_conv::lgConvEden, t_conv::lgSearch, t_trace::lgTrace, min(), iter_track::next_val(), t_trace::nTrConvg, nzone, iter_track::print_history(), safe_div(), iter_track::set_tol(), ShowMe(), sign(), SMALLFLOAT, thermal, TorF(), and trace.

Referenced by ConvTempEdenIoniz(), CoolHeatError(), lgCoolNetConverge(), and map_do().

Here is the call graph for this function:

void ConvFail	(	const char	chMode[],
		const char	chDetail[]
	)

ConvFail handle convergence failure

Parameters

chMode[]	chMode is one of "pres", "eden", "ioni", "pops", "grai", "temp"
chDetail	string giving details about the convergence failure

Definition at line 16 of file conv_fail.cpp.

References ASSERT, BIGFLOAT, called, cdEXIT, t_conv::chConvIoniz(), t_dense::chDenseLaw, conv, t_conv::convIonizNewVal(), t_conv::convIonizOldVal(), t_hextra::cryden, t_thermal::ctot, DEBUG_ENTRY, dense, t_dense::eden, t_dense::EdenTrue, EXIT_FAILURE, t_conv::failmx, fnzone, fprintf(), t_dense::gas_phase, hcmap, t_conv::HeatCoolRelErrorAllowed, hextra, t_thermal::htot, t_conv::ifailz, ioQQQ, ipHYDROGEN, iteration, lgAbort, t_conv::lgConvIoniz(), t_conv::lgConvPops, t_conv::lgConvTemp, t_conv::lgMap, t_hcmap::lgMapBeingDone, t_pressure::lgSonicPoint, t_called::lgTalk, t_conv::LimFail, map_do(), MAX2, MIN2, t_conv::nGrainFail, t_conv::nIonFail, t_conv::nNeFail, t_conv::nPopFail, t_conv::nPreFail, t_conv::nTeFail, t_conv::nTotalFailures, nzone, t_pressure::pbeta, phycon, t_pressure::PresGasCurr, t_pressure::PresRamCurr, pressure, t_pressure::PresTotlCurr, t_pressure::PresTotlError, PrtZone(), t_hcmap::RangeMap, safe_div(), ShowMe(), t_phycon::te, and thermal.

Referenced by ConvPresTempEdenIoniz(), and GrainChargeTemp().

Here is the call graph for this function:

bool ConvInitSolution ( )

ConvInitSolution drive search for initial solution at illuminated face, called by cloudy, returns 1 if outside conditions appropriate for cloudy

Definition at line 239 of file conv_init_solution.cpp.

References t_mesh::anu(), ASSERT, t_conv::AverEdenError, t_conv::AverHeatCoolError, t_conv::AverPressError, t_conv::BigEdenError, t_conv::BigHeatCoolError, t_conv::BigPressError, t_dense::chDenseLaw, t_thermal::ConstTemp, conv, ConvBase(), ConvPresTempEdenIoniz(), ConvTempEdenIoniz(), CoolSave(), t_struc::coolstr, t_thermal::ctot, dCoolNetDTOld, DEBUG_ENTRY, t_struc::DenMass, t_struc::DenParticles, dense, t_radius::drad, t_struc::drad, t_radius::drad_mid_zone, t_struc::drad_x_fillfac, t_radius::drad_x_fillfac, t_radius::dVeffAper, dynamics, t_dense::eden, t_struc::ednstr, t_geometry::FillFac, FindTempChangeFactor(), fp_equal(), fprintf(), FracMoleMax, t_dense::gas_phase, geometry, t_struc::hden, t_struc::heatstr, Heavy, t_struc::hiistr, t_conv::hist_pres_nzone, t_conv::hist_temp_nzone, t_struc::histr, t_thermal::htot, ioQQQ, t_Heavy::ipHeavy, ipHYDROGEN, ipOXYGEN, iteration, lgAbort, lgCoolNetConverge(), t_dense::lgDenseInitConstant, t_dense::lgEdenBad, t_conv::lgFirstSweepThisZone, t_conv::lgLastSweepThisZone, t_mole_global::lgNoMole, t_conv::lgOscilOTS, t_pressure::lgPressureInitialSpecified, t_dense::lgPressureVaryTime, t_radius::lgSdrmaxRel, t_conv::lgSearch, t_thermal::lgTeHigh, t_thermal::lgTemperatureConstant, t_dynamics::lgTimeDependentStatic, t_trace::lgTrace, LIMELM, max(), MAX2, MIN2, mole_global, t_dynamics::n_initial_relax, t_rfield::nflux, t_rfield::nPositive, t_conv::nPres2Ioniz, t_conv::nTotalIoniz, t_conv::nTotalIoniz_start, t_trace::nTrConvg, t_dense::nzEdenBad, t_struc::o3str, OxyInGrains, t_dense::pden, phycon, pressure, t_pressure::PressureInitialSpecified, t_dense::PressureVaryTimeIndex, t_dense::PressureVaryTimeTimescale, PresTotCurrent(), t_pressure::PresTotlCurr, t_pressure::PresTotlInit, radius, t_radius::Radius, radius_first(), rfield, rfield_opac_zero(), SDIV(), t_radius::sdrmax, t_radius::sdrmin, set_NaN(), ShowMe(), SMALLDOUBLE, SMALLFLOAT, StopCalc, struc, t_phycon::te, t_StopCalc::TeFloor, t_phycon::TEMP_LIMIT_HIGH, t_phycon::TEMP_LIMIT_LOW, TempChange(), t_phycon::TEnerDen, t_struc::testr, thermal, t_dynamics::time_elapsed, TotalInsanity(), trace, t_struc::volstr, t_dense::xIonDense, and t_dense::xMassDensity.

Referenced by cloudy().

Here is the call graph for this function:

int ConvIoniz ( void )

ConvIoniz called by ConvEdenIonz, it calls ConvBase until converged

Returns: returns 1 if error condition, 0 if ok

Definition at line 11 of file conv_ioniz.cpp.

References t_conv::chConvIoniz(), conv, ConvBase(), t_conv::convIonizNewVal(), t_conv::convIonizOldVal(), t_thermal::ctot, DEBUG_ENTRY, fprintf(), t_thermal::htot, ioQQQ, lgAbort, t_conv::lgConvIoniz(), t_conv::lgOscilOTS, t_conv::lgSearch, t_trace::nTrConvg, thermal, TorF(), and trace.

Referenced by EdenError().

Here is the call graph for this function:

void ConvIterCheck ( void )

ConvIterCheck check whether model has converged or whether more iterations are needed - implements the iter to converg comnd

Definition at line 23 of file conv_itercheck.cpp.

References AllTransitions, ASSERT, t_conv::autocv, cdLine(), t_elementnames::chElementSym, chLineLbl(), t_conv::chNotConverged, colden, t_colden::colden, t_colden::colden_old, conv, t_dynamics::convergence_error, t_dynamics::convergence_tolerance, dBaseSpecies, dBaseTrans, DEBUG_ENTRY, dense, t_dynamics::discretization_error, t_rt::DoubleTau, dynamics, elementnames, TransitionProxy::Emis(), t_dynamics::error_scale2, fprintf(), ipCOL_HTOT, ipH2s, ipH3p, ipH_LIKE, ipHe2p3P2, ipHe2s3S, ipHE_LIKE, t_save::ipPunConv, iso_ctrl, iso_sp, iteration, iterations, t_iterations::itermx, t_dynamics::lgAdvection, t_conv::lgAllTransitions, t_conv::lgAutoIt, t_dense::lgElmtOn, t_iterations::lgOpticalDepthonverged, t_save::lgPunConv, LIMELM, t_mole_global::list, MIN2, mole, mole_global, t_dynamics::n_initial_relax, NCOLD, NISO, t_isoCTRL::nLyaLevel, nSpecies, t_mole_global::num_calc, nzone, phycon, rt, save, t_mole_local::species, StopCalc, EmissionProxy::TauIn(), EmissionProxy::TauTot(), t_phycon::te, t_StopCalc::TempLoStopZone, TotalInsanity(), and t_iso_sp::trans().

Referenced by cloudy().

Here is the call graph for this function:

int ConvPresTempEdenIoniz ( void )

ConvPresTempEdenIoniz solve for current pressure, calls PressureChange, ConvTempEdenIoniz, called by cloudy returns 0 if ok, 1 if disaster

Definition at line 23 of file conv_pres_temp_eden_ioniz.cpp.

References AbundChange(), t_dense::chDenseLaw, conv, ConvFail(), ConvTempEdenIoniz(), DEBUG_ENTRY, dense, t_dense::eden, t_geometry::FillFac, fnzone, fprintf(), t_dense::gas_phase, geometry, GrainDrift(), gv, t_conv::hist_pres_current, t_conv::hist_pres_density, t_conv::hist_pres_error, t_conv::hist_pres_nzone, ioQQQ, ipHYDROGEN, iteration, lgAbort, t_conv::lgConvEden, t_conv::lgConvIoniz(), t_conv::lgConvPops, t_conv::lgConvPres, t_conv::lgConvTemp, GrainVar::lgDustOn(), t_conv::lgFirstSweepThisZone, GrainVar::lgGrainPhysicsOn, t_conv::lgLastSweepThisZone, t_pressure::lgPressureInitialSpecified, t_trace::lgTrace, max(), MAX2, t_conv::MaxFractionalDensityStepPerIteration, min(), MIN2, t_conv::nPres2Ioniz, t_trace::nTrConvg, nzone, phycon, solverState::press, pressure, PressureChange(), pressureZone(), PresTotCurrent(), t_pressure::PresTotlCurr, t_pressure::PresTotlError, t_conv::register_(), RT_OTS_ChkSum(), ScaleAllDensities(), scalingDensity(), PresMode::set(), sign(), SMALLFLOAT, t_phycon::te, TempChange(), thermal, t_thermal::thist, t_thermal::tlowst, TorF(), trace, and zoneDensity().

Referenced by AGN_Hemis(), cloudy(), and ConvInitSolution().

Here is the call graph for this function:

int ConvTempEdenIoniz ( void )

ConvTempEdenIoniz determine temperature, called by ConPresTempEdenIoniz, calls ConvEdenIoniz to get electron density and ionization returns 0 if ok, 1 if disaster

Definition at line 34 of file conv_temp_eden_ioniz.cpp.

References iter_track::add(), iter_track::bracket_width(), t_conv::chSolverTemp, iter_track::clear(), colden, t_colden::colden, conv, ConvEdenIoniz(), CoolHeatError(), t_thermal::ctot, t_conv::dCmHdT, DEBUG_ENTRY, dense, t_radius::depth, fp_equal(), fprintf(), t_dense::gas_phase, t_hmi::H2_total, hmi, t_thermal::htot, iter_track::init_bracket(), ioQQQ, ipCOL_HTOT, ipHYDROGEN, lgAbort, lgConvTemp(), t_conv::lgConvTemp, t_thermal::lgTeBD96, t_thermal::lgTemperatureConstant, t_thermal::lgTeSN99, t_thermal::lgTeTLaw, t_thermal::lgTLaw, t_trace::lgTrace, t_thermal::lgUnstable, max(), min(), iter_track::next_val(), t_trace::nTrConvg, phycon, POW4, PresTotCurrent(), iter_track::print_history(), radius, t_radius::Radius, safe_div(), iter_track::set_tol(), ShowMe(), t_conv::sigma_dCmHdT, t_thermal::SigmaBD96, sign(), t_thermal::T0BD96, t_thermal::T0SN99, DepthTable::tabval(), t_phycon::te, t_phycon::TEMP_LIMIT_LOW, TempChange(), thermal, t_thermal::tlaw, TorF(), TotalInsanity(), and trace.

Referenced by ConvInitSolution(), ConvPresTempEdenIoniz(), and PressureChange().

Here is the call graph for this function:

int eden_sum ( void )

eden_sum sum free electron density over all species, sets variable erredn.EdenTrue called by ConvEdenIoniz which actually controls the electron density updates returns 0 if all is ok, 1 if need to abort calc

Definition at line 17 of file eden_sum.cpp.

References ASSERT, DEBUG_ENTRY, dense, deut, t_dense::eden, t_dense::eden_from_metals, t_dense::EdenExtra, t_dense::EdenFraction, t_dense::EdenSet, t_dense::EdenTrue, t_mole_local::elec, fnzone, fp_equal(), fprintf(), t_dense::gas_phase, gv, ioQQQ, TransitionProxy::ipCont(), ipH1s, ipH2p, ipH_LIKE, ipHYDROGEN, ipLITHIUM, iso_sp, t_trace::lgESOURCE, GrainVar::lgGrainElectrons, t_trace::lgNeBug, t_trace::lgTrace, LIMELM, t_mole_global::list, mole, mole_global, t_mole_global::num_calc, t_rfield::otslin, rfield, safe_div(), t_mole_local::species, GrainVar::TotalEden, trace, t_iso_sp::trans(), t_deuterium::xIonDense, and t_dense::xIonDense.