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

#include <atmdat.h>

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

Public Types

enum  { NCX =2 }
 
enum  CollIonRC { DIMA, HYBRID }
 

Public Member Functions

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

Data Fields

double CharExcIonOf [NCX][LIMELM][LIMELM+1]
 
double CharExcRecTo [NCX][LIMELM][LIMELM+1]
 
double HCharHeatMax
 
double HCharCoolMax
 
double HCharHeatOn
 
double HCharExcRecTo_N0_2D
 
double CharExcIonTotal [NCX]
 
double CharExcRecTotal [NCX]
 
double HIonFrac
 
double HIonFracMax
 
double HCTAlex
 
bool lgCTOn
 
double Density [2][HS_NZ][NHSDIM]
 
double ElecTemp [2][HS_NZ][NHSDIM]
 
double Emiss [2][HS_NZ][NHSDIM][NHSDIM][NLINEHS]
 
long int nDensity [2][HS_NZ]
 
long int ntemp [2][HS_NZ]
 
long int ncut [2][HS_NZ]
 
bool lgHCaseBOK [2][HS_NZ]
 
long int nsbig
 
bool lgCollIonOn
 
realnum WaveLengthCaseB [8][25][24]
 
vector< realnumCaseBWlHeI
 
const long nDefaultPhotoLevelsFe
 
const long nDefaultPhotoLevels
 
const long nDefaultCollLevelsFe
 
const long nDefaultCollLevels
 
const long nDefaultMolLevels
 
bool lgChiantiOn
 
bool lgChiantiHybrid
 
bool lgChiantiPrint
 
bool lgChiantiExp
 
char chCloudyChiantiFile [FILENAME_PATH_LENGTH]
 
long nChiantiMaxLevelsFe
 
long nChiantiMaxLevels
 
bool lgChiantiLevelsSet
 
bool lgLamdaOn
 
bool lgLamdaPrint
 
char chLamdaFile [FILENAME_PATH_LENGTH]
 
long nLamdaMaxLevels
 
bool lgLamdaLevelsSet
 
bool lgStoutOn
 
bool lgStoutHybrid
 
bool lgStoutPrint
 
char chStoutFile [FILENAME_PATH_LENGTH]
 
long nStoutMaxLevelsFe
 
long nStoutMaxLevels
 
bool lgStoutLevelsSet
 
bool lgCalpgmOn
 
bool lgGbarOn
 
double collstrDefault
 
bool lgInnerShellLine_on
 
bool lgInnerShell_Kisielius
 
bool lgUTAprint
 
CollIonRC CIRCData
 
char chVersion [iVersionLength]
 
char chdBaseSources [LIMELM][LIMELM+1][10]
 
bool lgdBaseSourceExists [LIMELM][LIMELM+1]
 
vector< vector< long > > ipSpecIon
 

Static Public Attributes

static const double aulThreshold = 1e-29
 
static const int iVersionLength = 10
 

Detailed Description

Definition at line 271 of file atmdat.h.

Member Enumeration Documentation

anonymous enum

ion, nelem these arrays save the charge transfer ionization and recombination rates for the heavy elements onto hydrogen. ionization is of the heavy element, and so is a recombination for hydrogen

CharExcIonOf[ipHYDROGEN]( ion , nelem ), CharExcRecTo[ipHYDROGEN]( ion , nelem ) charge transfer ionization of atomic oxygen = CharExcIonOf[ipHYDROGEN][ipOXYGEN][0]*hii charge transfer recombination of ionized oxygen = CharExcRecTo[ipHYDROGEN][ipOXYGEN][0]*hi HCharHeatMax, HCharCoolMax are largest fractions of local heating or cooling due to ct HCharHeatOn usually 1, set to 0 with no CTHeat command

Enumerator
NCX 

Definition at line 292 of file atmdat.h.

Enumerator
DIMA 
HYBRID 

Definition at line 442 of file atmdat.h.

Constructor & Destructor Documentation

t_atmdat::t_atmdat ( )
inline

Definition at line 370 of file atmdat.h.

Member Function Documentation

const char* t_atmdat::chName ( ) const
inlinevirtual

Implements module.

Definition at line 272 of file atmdat.h.

void t_atmdat::comment ( t_warnings )
inlinevirtual

Implements module.

Definition at line 277 of file atmdat.h.

void t_atmdat::zero ( void  )
virtual

Field Documentation

const double t_atmdat::aulThreshold = 1e-29
static

The threshold for Aul. For species where the highest level has no transitions with Aul > aulThreshold, the highest levels will be trimmed until a real Aul is found.

Definition at line 437 of file atmdat.h.

Referenced by atmdat_STOUT_readin(), and trim_levels().

vector<realnum> t_atmdat::CaseBWlHeI

wavelengths for HeI case b

Definition at line 358 of file atmdat.h.

Referenced by GetStandardHeLines(), lgCheckMonitors(), and lines_helium().

double t_atmdat::CharExcIonOf[NCX][LIMELM][LIMELM+1]

CharExcIon is ionization, [0] is Atom^0 + H+ => Atom+1 + H0 [n] is Atom^+n + H+ => Atom^+n-1 + H0 CharExcRec is recombination [0] is Atom^+1 + H0 => Atom^0 + H^+ [n] is Atom^+n+1 + H0 => Atom^+n + H^+

Definition at line 300 of file atmdat.h.

Referenced by ChargTranEval(), ChargTranPun(), ChargTranSumHeat(), ConvBase(), fill_array(), ion_photo(), iso_charge_transfer_update(), iso_level(), PrintRates(), and zero().

double t_atmdat::CharExcIonTotal[NCX]

this is total rate (s-1) for ct ionization and recombination of nelem

Definition at line 310 of file atmdat.h.

Referenced by fill_array(), IonHydro(), iso_charge_transfer_update(), iso_level(), PrintRates(), and zero().

double t_atmdat::CharExcRecTo[NCX][LIMELM][LIMELM+1]
double t_atmdat::CharExcRecTotal[NCX]

Definition at line 310 of file atmdat.h.

Referenced by fill_array(), iso_charge_transfer_update(), iso_level(), PrintRates(), and zero().

char t_atmdat::chCloudyChiantiFile[FILENAME_PATH_LENGTH]

CloudyChianti filename variable

Definition at line 382 of file atmdat.h.

Referenced by database_readin(), InitDefaultsPreparse(), and ParseDatabase().

char t_atmdat::chdBaseSources[LIMELM][LIMELM+1][10]

Array of Data Sources

Definition at line 451 of file atmdat.h.

Referenced by database_readin(), and InitCoreload().

char t_atmdat::chLamdaFile[FILENAME_PATH_LENGTH]

LAMDA filename variable

Definition at line 395 of file atmdat.h.

Referenced by database_readin(), InitDefaultsPreparse(), and ParseDatabase().

char t_atmdat::chStoutFile[FILENAME_PATH_LENGTH]

Stout filename variable

Definition at line 408 of file atmdat.h.

Referenced by database_readin(), InitDefaultsPreparse(), and ParseDatabase().

char t_atmdat::chVersion[iVersionLength]

Chianti version read from /data/chianti/VERSION

Definition at line 448 of file atmdat.h.

Referenced by database_readin(), and DatabasePrintReference().

CollIonRC t_atmdat::CIRCData

Definition at line 443 of file atmdat.h.

Referenced by t_ADfA::coll_ion_wrapper(), InitDefaultsPreparse(), and ParseSet().

double t_atmdat::collstrDefault

The default collision strength used for dBaseTrans no collision or radiative data are available so conventional g-bar is unavailable

Definition at line 426 of file atmdat.h.

Referenced by dBaseUpdateCollCoeffs(), InitDefaultsPreparse(), and ParseSet().

double t_atmdat::Density[2][HS_NZ][NHSDIM]

these are the density and temperature mesh points on the original Hummer & Storey data, for H[0] and He[1],

Definition at line 329 of file atmdat.h.

Referenced by atmdat_HS_caseB(), and read_Hummer_Storey().

double t_atmdat::ElecTemp[2][HS_NZ][NHSDIM]

Definition at line 329 of file atmdat.h.

Referenced by atmdat_HS_caseB(), and read_Hummer_Storey().

double t_atmdat::Emiss[2][HS_NZ][NHSDIM][NHSDIM][NLINEHS]

emiss[ipTemp][ipDens][ipLevel]

Definition at line 329 of file atmdat.h.

Referenced by atmdat_HS_caseB(), and read_Hummer_Storey().

double t_atmdat::HCharCoolMax

Definition at line 300 of file atmdat.h.

Referenced by ChargTranSumHeat(), IterStart(), PrtComment(), and zero().

double t_atmdat::HCharExcRecTo_N0_2D

Definition at line 307 of file atmdat.h.

Referenced by ChargTranEval(), and lines().

double t_atmdat::HCharHeatMax

Definition at line 300 of file atmdat.h.

Referenced by ChargTranSumHeat(), IterStart(), PrtComment(), and zero().

double t_atmdat::HCharHeatOn

Definition at line 300 of file atmdat.h.

Referenced by ChargTranSumHeat(), ParseDont(), and zero().

double t_atmdat::HCTAlex

Dalgarno H charge transfer rate coefficient for high stages of ionization default is 1.92e-9 in zero, reset with 'set charge transfer' command

Definition at line 321 of file atmdat.h.

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

double t_atmdat::HIonFrac

this is the current ratio of ct ionization of H, relative to total dest rate

Definition at line 314 of file atmdat.h.

Referenced by IonHydro(), lines_hydro(), and zero().

double t_atmdat::HIonFracMax

this is the largest ratio of ct ionization of H, relative to total dest rate

Definition at line 317 of file atmdat.h.

Referenced by IterStart(), lines_hydro(), PrtComment(), and zero().

vector<vector<long> > t_atmdat::ipSpecIon

Array to store species labels and ipSpecies values

Definition at line 455 of file atmdat.h.

Referenced by chkCaHeps(), database_prep(), dBase_solve(), InitCoreload(), ion_photo(), RT_line_driving(), and states_nelemfill().

const int t_atmdat::iVersionLength = 10
static

Length +1 of the version read from /data/chianti/VERSION

Definition at line 446 of file atmdat.h.

Referenced by database_readin().

bool t_atmdat::lgCalpgmOn

Default number of iron levels when not using the coronal command true if CDMS/JPL database is enabled

Definition at line 419 of file atmdat.h.

Referenced by database_readin(), and InitDefaultsPreparse().

bool t_atmdat::lgChiantiExp

true if Cloudy will use no theoretical energy levels from Chianti, only experimental. False means that only theoretical energy levels are used

Definition at line 380 of file atmdat.h.

Referenced by atmdat_CHIANTI_readin(), InitDefaultsPreparse(), and ParseDatabase().

bool t_atmdat::lgChiantiHybrid

true if CHIANTI database supplements opacity project lines

Definition at line 376 of file atmdat.h.

Referenced by atmdat_readin(), CoolDima(), InitDefaultsPreparse(), ParseDatabase(), RT_line_all(), and states_nelemfill().

bool t_atmdat::lgChiantiLevelsSet

Flag to determine whether nChiantiMaxLevelsFe has been set by the user

Definition at line 388 of file atmdat.h.

Referenced by InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

bool t_atmdat::lgChiantiOn

true if CHIANTI database is enabled

Definition at line 374 of file atmdat.h.

Referenced by atmdat_readin(), CoolEvaluate(), database_readin(), InitDefaultsPreparse(), and ParseDatabase().

bool t_atmdat::lgChiantiPrint

true if Cloudy will print which Chianti species are being used as well as number of levels

Definition at line 378 of file atmdat.h.

Referenced by atmdat_CHIANTI_readin(), InitDefaultsPreparse(), ParseDatabase(), and trim_levels().

bool t_atmdat::lgCollIonOn

by default, include collisional ionization, option to not include it, with "no collisional ionization" command

Definition at line 349 of file atmdat.h.

Referenced by InitDefaultsPreparse(), and ParseDont().

bool t_atmdat::lgCTOn

variable to turn on or off ct ionization-recombination of all elements - set off with no charge transfer command

Definition at line 325 of file atmdat.h.

Referenced by ChargTranEval(), fill_array(), GrainChrgTransferRates(), iso_level(), mole_eval_sources(), ParseDont(), and zero().

bool t_atmdat::lgdBaseSourceExists[LIMELM][LIMELM+1]

Definition at line 452 of file atmdat.h.

Referenced by chkCaHeps(), database_readin(), InitCoreload(), lines(), PrtComment(), and PrtFinal().

bool t_atmdat::lgGbarOn

true if dBase transitions have collision strengths supplemented by gbar

Definition at line 421 of file atmdat.h.

Referenced by dBaseUpdateCollCoeffs(), InitDefaultsPreparse(), and ParseSet().

bool t_atmdat::lgHCaseBOK[2][HS_NZ]

following will be set false if we ever stop over bounds of HS table for any element. first index is case A [0] or case B [1] - second is element number

Definition at line 342 of file atmdat.h.

Referenced by IterStart(), lines_hydro(), PrtComment(), and PrtFinal().

bool t_atmdat::lgInnerShell_Kisielius

says whether to include the new Romas data set

Definition at line 431 of file atmdat.h.

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

bool t_atmdat::lgInnerShellLine_on

this says whether to include inner shell absorption lines

Definition at line 429 of file atmdat.h.

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

bool t_atmdat::lgLamdaLevelsSet

Flag to determine whether nLamdaMaxLevels has been set by the user

Definition at line 399 of file atmdat.h.

Referenced by InitDefaultsPreparse(), and ParseDatabase().

bool t_atmdat::lgLamdaOn

true if LAMDA database is enabled

Definition at line 391 of file atmdat.h.

Referenced by atmdat_readin(), database_readin(), InitDefaultsPreparse(), and ParseDatabase().

bool t_atmdat::lgLamdaPrint

true if Cloudy will print which Lamda species are being used as well as number of levels

Definition at line 393 of file atmdat.h.

Referenced by atmdat_LAMDA_readin(), InitDefaultsPreparse(), ParseDatabase(), and trim_levels().

bool t_atmdat::lgStoutHybrid

true if Stout database supplements opacity project lines

Definition at line 404 of file atmdat.h.

Referenced by atmdat_readin(), CoolDima(), InitDefaultsPreparse(), ParseDatabase(), RT_line_all(), and states_nelemfill().

bool t_atmdat::lgStoutLevelsSet

Flag to determine whether nStoutMaxLevelsFe has been set by the user

Definition at line 415 of file atmdat.h.

Referenced by InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

bool t_atmdat::lgStoutOn

true if Stout database is enabled

Definition at line 402 of file atmdat.h.

Referenced by atmdat_readin(), CoolEvaluate(), database_readin(), InitDefaultsPreparse(), and ParseDatabase().

bool t_atmdat::lgStoutPrint

true if Cloudy will print which Stout species are being used as well as number of levels

Definition at line 406 of file atmdat.h.

Referenced by atmdat_STOUT_readin(), InitDefaultsPreparse(), ParseDatabase(), and trim_levels().

bool t_atmdat::lgUTAprint

flag to print out the UTA data

Definition at line 433 of file atmdat.h.

Referenced by read_UTA_lines(), and zero().

long t_atmdat::nChiantiMaxLevels

The maximum number of chianti energy levels used for all other species

Definition at line 386 of file atmdat.h.

Referenced by atmdat_CHIANTI_readin(), InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

long t_atmdat::nChiantiMaxLevelsFe

The maximum number of chianti energy levels used for Fe

Definition at line 384 of file atmdat.h.

Referenced by atmdat_CHIANTI_readin(), InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

long int t_atmdat::ncut[2][HS_NZ]

highest principal quantum number they report, usually 25, their paper says 50

Definition at line 337 of file atmdat.h.

Referenced by atmdat_HS_caseB(), lines_hydro(), and read_Hummer_Storey().

const long t_atmdat::nDefaultCollLevels

Default number of non-iron levels for collisional ionization cases using the coronal command

Definition at line 366 of file atmdat.h.

Referenced by ParseCoronal().

const long t_atmdat::nDefaultCollLevelsFe

Default number of iron levels for collisional ionization cases using the coronal command

Definition at line 364 of file atmdat.h.

Referenced by ParseCoronal().

const long t_atmdat::nDefaultMolLevels

Default number of molecular levels

Definition at line 368 of file atmdat.h.

Referenced by InitDefaultsPreparse().

const long t_atmdat::nDefaultPhotoLevels

Default number of non-iron levels when not using the coronal command

Definition at line 362 of file atmdat.h.

Referenced by InitDefaultsPreparse().

const long t_atmdat::nDefaultPhotoLevelsFe

Definition at line 360 of file atmdat.h.

Referenced by atmdat_STOUT_readin(), and InitDefaultsPreparse().

long int t_atmdat::nDensity[2][HS_NZ]

the number of density temperature mesh points for H&S Case A, B

Definition at line 335 of file atmdat.h.

Referenced by atmdat_HS_caseB(), and read_Hummer_Storey().

long t_atmdat::nLamdaMaxLevels

maximum number of lamda energy levels

Definition at line 397 of file atmdat.h.

Referenced by atmdat_LAMDA_readin(), InitDefaultsPreparse(), and ParseDatabase().

long int t_atmdat::nsbig

related to highest stage of ionization needed for Cota recom

Definition at line 345 of file atmdat.h.

Referenced by atmdat_3body(), ion_recomb(), and zero().

long t_atmdat::nStoutMaxLevels

default maximum number of stout energy levels used for other species

Definition at line 413 of file atmdat.h.

Referenced by atmdat_STOUT_readin(), InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

long t_atmdat::nStoutMaxLevelsFe

The default maximum number of stout energy levels for Fe

Definition at line 410 of file atmdat.h.

Referenced by atmdat_STOUT_readin(), InitDefaultsPreparse(), ParseCoronal(), and ParseDatabase().

long int t_atmdat::ntemp[2][HS_NZ]

Definition at line 335 of file atmdat.h.

Referenced by atmdat_HS_caseB(), and read_Hummer_Storey().

realnum t_atmdat::WaveLengthCaseB[8][25][24]

wavelengths of Hummer & Storey case B lines for H - O first dimension is atomic number of C scale, H is 0 next two are upper and lower configurations on physics scale - Lya is 2-1, Lyb is 3-1, Ha is 3-2, etc

Definition at line 355 of file atmdat.h.

Referenced by lgCheckMonitors(), and lines_hydro().


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