Cloudy
Spectral Synthesis Code for Astrophysics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
t_iterations Struct Reference

#include <iterations.h>

Inheritance diagram for t_iterations:
Collaboration diagram for t_iterations:

Public Member Functions

const char * chName () const
 
void zero ()
 
void comment (t_warnings &)
 
void alloc ()
 
- Public Member Functions inherited from module
 module ()
 
virtual ~module ()
 

Public Attributes

long int itermx
 
long int iter_alloc
 
vector< long int > IterPrnt
 
bool lgLastIt
 
bool lgIterAgain
 
bool lgOpticalDepthonverged
 
bool lgConverge_set
 
long int lim_zone
 
long int lim_iter
 
bool lgEndDflt
 
long int nEndDflt
 
vector< long int > nend
 
vector< double > StopThickness
 
vector< double > StopRadius
 

Member Function Documentation

void t_iterations::alloc ( )

References iter_alloc, IterPrnt, nend, StopRadius, and StopThickness.

Referenced by zero().

const char* t_iterations::chName ( ) const
inlinevirtual

Implements module.

void t_iterations::comment ( t_warnings )
inlinevirtual

Implements module.

void t_iterations::zero ( void  )
virtual

Member Data Documentation

long int t_iterations::iter_alloc

amount of space that has been allocated for max iterations

Referenced by alloc(), atmdat_readin(), ContCreateMesh(), DynaIterEnd(), init_struc(), InitSimPostparse(), ParseCommands(), ParseIterations(), ParseRadius(), ParseSet(), ParseStop(), and zero().

long int t_iterations::itermx

these are the variables that control how many iterations are to be done, and number of the current iteration itermx is number of iterations to perform, set with iterate command upper limit is parameter variable ItrDim

Referenced by cloudy(), ConvIterCheck(), iter_end_check(), IterStart(), ParseCommands(), ParseIterations(), PrtComment(), PrtFinal(), and zero().

vector<long int> t_iterations::IterPrnt

number of zones to print on each iteration [ITR DIM]

Referenced by alloc(), IterStart(), ParseIterations(), ParseTrace(), and zero().

bool t_iterations::lgConverge_set

next three implement set coverage command to limit iterations and zones

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

bool t_iterations::lgEndDflt

lgEndDflt true if still at default

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

bool t_iterations::lgIterAgain

flag indicating that another iteration is needed, includes various criteria, done in prt_comment.cpp for ALL models. This does check some line optical depths. comment included in final printout

Referenced by PrtComment(), and PrtFinal().

bool t_iterations::lgLastIt

this is false on any but the last iteration set true in startr if iter > itermx

Referenced by CoolH2_GA08(), InitSimPostparse(), iso_level(), iter_end_check(), IterStart(), diatomics::LTE_Cooling_per_H2(), PrtComment(), PrtFinal(), qheat(), radius_next(), save_DT(), SaveDo(), and SaveSpeciesOptDep().

bool t_iterations::lgOpticalDepthonverged

Referenced by ConvIterCheck(), and PrtComment().

long int t_iterations::lim_iter

Referenced by ParseCommands(), and ParseSet().

long int t_iterations::lim_zone

Referenced by ParseCommands(), and ParseSet().

vector<long int> t_iterations::nend

nend[iteration] is limiting number of zones for that iteration <[ITR DIM]

Referenced by alloc(), atmdat_readin(), ContCreateMesh(), init_struc(), iter_end_check(), ParseCommands(), ParseIterations(), ParseSet(), ParseStop(), and zero().

long int t_iterations::nEndDflt

default limit to number of zones

Referenced by ParseSet(), and zero().

vector<double> t_iterations::StopRadius

stopping radius for the model, set with STOP RADIUS command [ITR DIM]

Referenced by alloc(), InitSimPostparse(), ParseIterations(), ParseStop(), and zero().

vector<double> t_iterations::StopThickness

total physical thickness of modeled region, (NOT OUTER RADIUS) this can set set as a stopping criteria, but if not set is 1e30 before first iteration. At end of each iteration, thickness is set to total depth from illuminated face to outer edge [ITR DIM]

Referenced by alloc(), DynaIterEnd(), InitSimPostparse(), iter_end_check(), IterEnd(), ParseCommands(), ParseIterations(), ParseRadius(), ParseStop(), radius_first(), radius_increment(), radius_next(), zero(), and ZoneStart().


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