cloudy  trunk
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Data Fields
t_iterations Struct Reference

#include <iterations.h>

Inheritance diagram for t_iterations:
Inheritance graph
[legend]
Collaboration diagram for t_iterations:
Collaboration graph
[legend]

Public Member Functions

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

Data Fields

long int itermx
 
long int iter_malloc
 
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
 

Detailed Description

Definition at line 22 of file iterations.h.

Member Function Documentation

void t_iterations::alloc ( )

Definition at line 35 of file iterations.cpp.

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

Referenced by allocate().

const char* t_iterations::chName ( ) const
inlinevirtual

Implements module.

Definition at line 24 of file iterations.h.

void t_iterations::comment ( t_warnings )
inlinevirtual

Implements module.

Definition at line 29 of file iterations.h.

void t_iterations::zero ( void  )
virtual

Implements module.

Definition at line 8 of file iterations.cpp.

References iter_malloc, iteration, itermx, IterPrnt, lgConverge_set, lgEndDflt, nend, nEndDflt, StopRadius, and StopThickness.

Field Documentation

long int t_iterations::iter_malloc

amount of space that has been allocated for max iterations

Definition at line 40 of file iterations.h.

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

Definition at line 37 of file iterations.h.

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

vector<long int> t_iterations::IterPrnt

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

Definition at line 43 of file iterations.h.

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

bool t_iterations::lgConverge_set

next three implement set coverage command to limit iterations and zones

Definition at line 60 of file iterations.h.

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

bool t_iterations::lgEndDflt

lgEndDflt true if still at default

Definition at line 65 of file iterations.h.

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

Definition at line 53 of file iterations.h.

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

Definition at line 47 of file iterations.h.

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

bool t_iterations::lgOpticalDepthonverged

Definition at line 57 of file iterations.h.

Referenced by ConvIterCheck(), and PrtComment().

long int t_iterations::lim_iter

Definition at line 62 of file iterations.h.

Referenced by ParseCommands(), and ParseSet().

long int t_iterations::lim_zone

Definition at line 61 of file iterations.h.

Referenced by ParseCommands(), and ParseSet().

vector<long int> t_iterations::nend

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

Definition at line 71 of file iterations.h.

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

long int t_iterations::nEndDflt

default limit to number of zones

Definition at line 68 of file iterations.h.

Referenced by ParseSet(), and zero().

vector<double> t_iterations::StopRadius

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

Definition at line 80 of file iterations.h.

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]

Definition at line 77 of file iterations.h.

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: