t_conv Struct Reference

#include <conv.h>

Collaboration diagram for t_conv:

Collaboration graph
[legend]

Data Fields

char * chConvEden
char * chConvIoniz
char * chNotConverged
bool lgConvIoniz
bool lgConvPops
double BadConvIoniz [2]
long int nPres2Ioniz
long int limPres2Ioniz
long int nTotalIoniz
long int nTotalIoniz_start
bool lgSearch
realnum AverEdenError
realnum BigHeatCoolError
realnum AverHeatCoolError
realnum BigPressError
realnum AverPressError
bool lgIonStageTrimed
bool lgCmHOsc
bool lgTOscl
bool lgEdenOscl
bool lgOscilOTS
bool lgConvTemp
bool lgConvPres
bool lgConvEden
bool lgLevel2_OTS_Imp
bool lgLevel2_Cool_Imp
long int nTotalFailures
long int nTeFail
realnum failmx
long int nPreFail
long int nNeFail
realnum BigEdenError
long int nIonFail
long int nPopFail
long int nConvIonizFails
long int nGrainFail
long int LimFail
bool lgMap
long int ifailz [12]
char chSolverEden [20]
char chSolverTemp [20]
bool lgBadStop
bool lgAutoIt
realnum autocv
double EdenErrorAllowed
realnum PressureErrorAllowed
realnum HeatCoolRelErrorAllowed
double * hist_pres_density
double * hist_pres_current
double * hist_pres_correct
long int hist_pres_npres
long int hist_pres_nzone
long int hist_pres_limit
double * hist_temp_temp
double * hist_temp_heat
double * hist_temp_cool
long int hist_temp_ntemp
long int hist_temp_nzone
long int hist_temp_limit

Detailed Description

the variables that deal with the convergence of the model

Definition at line 83 of file conv.h.


Field Documentation

realnum t_conv::autocv

a convergence criteria

Definition at line 223 of file conv.h.

Referenced by ConvIterCheck(), and zero().

realnum t_conv::AverEdenError

remember the average electron density error

Definition at line 127 of file conv.h.

Referenced by ConvInitSolution(), and zero().

realnum t_conv::AverHeatCoolError

Definition at line 131 of file conv.h.

Referenced by ConvInitSolution(), and zero().

realnum t_conv::AverPressError

Definition at line 135 of file conv.h.

Referenced by ConvInitSolution(), and zero().

double t_conv::BadConvIoniz[2]

when the lgConvIoniz flag is set false, the old and new numbers, the reason for the lack of convergence, should be set to following

Definition at line 104 of file conv.h.

Referenced by ConvIoniz(), and lgIonizConverg().

realnum t_conv::BigEdenError

remember the biggest electron density error as test of convergence quality

Definition at line 184 of file conv.h.

Referenced by ConvInitSolution(), and zero().

realnum t_conv::BigHeatCoolError

remember the biggest and average heating-cooling error

Definition at line 130 of file conv.h.

Referenced by ConvInitSolution(), and zero().

realnum t_conv::BigPressError

remember the biggest and average pressure error

Definition at line 134 of file conv.h.

Referenced by ConvInitSolution(), and zero().

char* t_conv::chConvEden

this says why the electron density did not converge,

Definition at line 86 of file conv.h.

Referenced by ConvEdenIoniz().

char* t_conv::chConvIoniz

this says why the ionization did not converge, reasons can be a large change in the level of ionization, or in the heating

Definition at line 90 of file conv.h.

Referenced by ConvEdenIoniz(), ConvFail(), ConvIoniz(), and ion_solver().

char* t_conv::chNotConverged

this gives the reason the model was declared not converged when 'iter to convergence' command is given

Definition at line 94 of file conv.h.

Referenced by ConvEdenIoniz(), ConvIterCheck(), and PrtComment().

char t_conv::chSolverEden[20]

which electron density solver to use? set with set eden solver command, simple and new

Definition at line 209 of file conv.h.

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

char t_conv::chSolverTemp[20]

which temperature density solver to use? set with set eden solver command, default and brent

Definition at line 213 of file conv.h.

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

double t_conv::EdenErrorAllowed

this is relative error in the electron density we want set in zero to 0.01 reset with set eden error command

Definition at line 228 of file conv.h.

Referenced by advection_set_detault(), ConvEdenIoniz(), GrainDrive(), hmole(), lgConvEden(), ParseSet(), radius_increment(), and zero().

realnum t_conv::failmx

failmx is largest relative error in heating cooling match

Definition at line 175 of file conv.h.

Referenced by ConvFail().

realnum t_conv::HeatCoolRelErrorAllowed

allowed error in heating - cooling balance, set with TOLERANCE command default set in zerologic

Definition at line 237 of file conv.h.

Referenced by advection_set_detault(), ConvFail(), ConvInitSolution(), ConvTempEdenIoniz(), lgConvTemp(), lgCoolHeatCheckConverge(), ParseSet(), TeBrent(), and zero().

double * t_conv::hist_pres_correct

Definition at line 241 of file conv.h.

Referenced by PressureChange().

double * t_conv::hist_pres_current

Definition at line 241 of file conv.h.

Referenced by PressureChange().

double* t_conv::hist_pres_density

these are used to retain the density pressure history in current zone, can be output with punch pressure history

Definition at line 241 of file conv.h.

Referenced by PressureChange().

long int t_conv::hist_pres_limit

Definition at line 242 of file conv.h.

Referenced by PressureChange().

long int t_conv::hist_pres_npres

Definition at line 242 of file conv.h.

Referenced by PressureChange().

long int t_conv::hist_pres_nzone

Definition at line 242 of file conv.h.

Referenced by PressureChange().

double * t_conv::hist_temp_cool

Definition at line 246 of file conv.h.

Referenced by ConvEdenIoniz().

double * t_conv::hist_temp_heat

Definition at line 246 of file conv.h.

Referenced by ConvEdenIoniz().

long int t_conv::hist_temp_limit

Definition at line 247 of file conv.h.

Referenced by ConvEdenIoniz().

long int t_conv::hist_temp_ntemp

Definition at line 247 of file conv.h.

Referenced by ConvEdenIoniz().

long int t_conv::hist_temp_nzone

Definition at line 247 of file conv.h.

Referenced by ConvEdenIoniz().

double* t_conv::hist_temp_temp

these are used to retain the temp/heat/cooling history in current zone, can be output with punch temperature history

Definition at line 246 of file conv.h.

Referenced by ConvEdenIoniz().

long int t_conv::ifailz[12]

zones where converge problems occurred

Definition at line 205 of file conv.h.

Referenced by ConvFail().

bool t_conv::lgAutoIt

says "interate to convergence" command given

Definition at line 220 of file conv.h.

Referenced by ConvIterCheck(), PrtComment(), and zero().

bool t_conv::lgBadStop

flag saying that calculation stopped for bad reason mostly set in lgEndfun

Definition at line 217 of file conv.h.

Referenced by PrtComment().

bool t_conv::lgCmHOsc

this says whether cooling-heating deriv is changing sign

Definition at line 141 of file conv.h.

Referenced by ConvFail(), and ConvTempEdenIoniz().

bool t_conv::lgConvEden

true when the electron density has converged

Definition at line 160 of file conv.h.

Referenced by ConvEdenIoniz(), ConvPresTempEdenIoniz(), ConvTempEdenIoniz(), lgConvEden(), and zero().

bool t_conv::lgConvIoniz

this flag is used in ConvPresTempEdenIoniz to check that ionization has converged

Definition at line 97 of file conv.h.

Referenced by ConvFail(), ConvIoniz(), ConvPresTempEdenIoniz(), ConvTempEdenIoniz(), ion_solver(), and RT_OTS_PrtRate().

bool t_conv::lgConvPops

this flag is used in ConvPresTempEdenIoniz to check that populations have converged

Definition at line 100 of file conv.h.

Referenced by ConvFail(), ConvPresTempEdenIoniz(), and hmole().

bool t_conv::lgConvPres

true if pressure is converged, false if not

Definition at line 157 of file conv.h.

Referenced by ConvPresTempEdenIoniz(), lgConvPres(), PressureChange(), and zero().

bool t_conv::lgConvTemp

true if temperature is converged, false if not

Definition at line 154 of file conv.h.

Referenced by ConvFail(), ConvPresTempEdenIoniz(), ConvTempEdenIoniz(), lgConvTemp(), and zero().

bool t_conv::lgEdenOscl

this says whether electron density is changing sign

Definition at line 147 of file conv.h.

Referenced by ConvEdenIoniz(), and ConvFail().

bool t_conv::lgIonStageTrimed

flag set in ConvBase, saying whether ionization stage is trimmed down

Definition at line 138 of file conv.h.

Referenced by CoolDima(), ion_trim(), and RT_line_all().

bool t_conv::lgLevel2_Cool_Imp

true if level 2 lines were contributors to the cooling, set in dimacool

Definition at line 166 of file conv.h.

Referenced by CoolDima(), and zero().

bool t_conv::lgLevel2_OTS_Imp

true if level 2 lines were contributors to the ots rates, set in dimacool

Definition at line 163 of file conv.h.

Referenced by zero().

bool t_conv::lgMap

lgMap is option to map failures

Definition at line 202 of file conv.h.

Referenced by ConvFail(), and zero().

bool t_conv::lgOscilOTS

this is true if ots rates are oscillating, and this is why ionization is not converged

Definition at line 151 of file conv.h.

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

bool t_conv::lgSearch

conv.lgSearch is true during initial temp-ion search phase, false after first zone established

Definition at line 124 of file conv.h.

Referenced by atmol_popsolve(), ConvEdenIoniz(), ConvInitSolution(), ConvIoniz(), CoolDima(), CoolEvaluate(), eden_sum(), Fe2_cooling(), GrainCharge(), GrainChargeTemp(), GrainDrive(), H2_LevelPops(), hmole(), ion_solver(), ion_trim(), MyAssert(), PresTotCurrent(), radius_increment(), and RT_line_static().

bool t_conv::lgTOscl

this says whether temp is changing sign

Definition at line 144 of file conv.h.

Referenced by ConvFail(), and ConvTempEdenIoniz().

long int t_conv::LimFail

LimFail is limit to number of te failures, set with "failures" cmnd

Definition at line 199 of file conv.h.

Referenced by ConvFail(), grid_do(), and zero().

long int t_conv::limPres2Ioniz

a limit to the above, in case where one zone takes forever to not converge, usually very large, set with SET PRESIONIZ command

Definition at line 110 of file conv.h.

Referenced by ParseSet().

long int t_conv::nConvIonizFails

number of ConvIoniz ionization failures

Definition at line 193 of file conv.h.

Referenced by ConvEdenIoniz(), and ConvIoniz().

long int t_conv::nGrainFail

number of grain ionization balance failures

Definition at line 196 of file conv.h.

Referenced by ConvFail().

long int t_conv::nIonFail

nIonFail is number of ionization failures

Definition at line 187 of file conv.h.

Referenced by cdNwcns(), and ConvFail().

long int t_conv::nNeFail

nNeFail is number of electron density failures

Definition at line 181 of file conv.h.

Referenced by cdNwcns(), and ConvFail().

long int t_conv::nPopFail

nIonFail is number of level population failures

Definition at line 190 of file conv.h.

Referenced by ConvFail().

long int t_conv::nPreFail

nPreFail is number of pressure failures

Definition at line 178 of file conv.h.

Referenced by cdNwcns(), and ConvFail().

long int t_conv::nPres2Ioniz

this will count the number of ionizations in one call from ConPvPresTempIoniz

Definition at line 107 of file conv.h.

Referenced by ConvBase(), ConvEdenIoniz(), ConvInitSolution(), ConvIoniz(), ConvPresTempEdenIoniz(), CoolEvaluate(), hmole_reactions(), ion_photo(), lgIonizConverg(), PrtZone(), RT_line_all(), and zero().

long int t_conv::nTeFail

nTeFail number of temperature failures

Definition at line 172 of file conv.h.

Referenced by cdNwcns(), ConvFail(), and ShowMe().

long int t_conv::nTotalFailures

total number of all falures, used to trigger abort

Definition at line 169 of file conv.h.

Referenced by ConvFail().

long int t_conv::nTotalIoniz

counts the number of calls to conv base after iteration starts can be used to determine very first pass through an iteration reset to zero at start of each iteration in a simulation

Definition at line 115 of file conv.h.

Referenced by ChargTranEval(), ConvBase(), ConvEdenIoniz(), ConvInitSolution(), hmole(), ion_solver(), ion_trim(), IonHelium(), IonNitro(), iso_collide(), iso_radiative_recomb(), lgCheckAsserts(), PressureChange(), PresTotCurrent(), RT_DestProb(), RT_line_one(), vib_evap(), and zero().

long int t_conv::nTotalIoniz_start

the same counter but set to zero after the initial solution is converged, so this is a measure of the number of calls within true zones

Definition at line 120 of file conv.h.

Referenced by ConvInitSolution(), and lgCheckAsserts().

realnum t_conv::PressureErrorAllowed

this is relative error in the pressure, initialized to 0.02 in reset with set pressure error command

Definition at line 233 of file conv.h.

Referenced by advection_set_detault(), lgConvPres(), ParseSet(), and PresTotCurrent().


The documentation for this struct was generated from the following file:
Generated on Mon Feb 16 12:14:36 2009 for cloudy by  doxygen 1.4.7