#include <grainvar.h>
Public Member Functions | |
| GrainVar () | |
| void | clear () |
| bool | lgDustOn () const |
Private Member Functions | |
| void | p_clear0 () |
| void | p_clear1 () |
Detailed Description
NB NB NB NB NB NB
this is the master data structure for grain physics, it is statically allocated
all entries that depend on grain type should go in the GrainBin structure above
NB NB NB NB NB NB
Constructor & Destructor Documentation
◆ GrainVar()
|
inline |
Member Function Documentation
◆ clear()
|
inline |
References p_clear0(), and p_clear1().
Referenced by p_clear0().
◆ lgDustOn()
|
inline |
grain logic < have any grains been switched on ?
References bin.
◆ p_clear0()
|
private |
References AugerData, bin, clear(), dstab, dstsc, GrainEmission, GraphiteEmission, LIMELM, ReadRecord, and SilicateEmission.
Referenced by clear().
◆ p_clear1()
|
private |
References chPAH_abundance, dHeatdT, dstAbundThresholdFar, dstAbundThresholdNear, ENTH_CAR, ENTH_CAR2, ENTH_PAH, ENTH_PAH2, ENTH_SIC, ENTH_SIL, ENTH_SIL2, GrainChTrRate, GrainHeatScaleFactor, GrainMetal, H2_CAR, H2_SIL, IAL_CAR, IAL_SIL, lgAnyDustVary, lgBakesPAH_heat, lgDColOn, lgDHetOn, lgGrainElectrons, lgGrainPhysicsOn, lgNegGrnDrg, lgQHeatAll, lgQHeatOn, lgReevaluate, lgWD01, LIMELM, MAT_CAR, MAT_CAR2, MAT_PAH, MAT_PAH2, MAT_SIC, MAT_SIL, MAT_SIL2, nCalledGrainDrive, NCHRG_DEFAULT, nChrgRequested, PE_CAR, PE_SIL, POT_CAR, POT_SIL, STRG_CAR, STRG_SIL, TotalEden, which_enth, which_H2distr, which_ial, which_pe, which_pot, which_strg, which_zmin, ZMIN_CAR, and ZMIN_SIL.
Referenced by clear(), and GrainVar().
Member Data Documentation
◆ AugerData
store data about energy spectrum of Auger electrons
Referenced by p_clear0().
◆ bin
| vector<GrainBin> GrainVar::bin |
per bin grain data data for individual grain size bins
Referenced by lgDustOn(), and p_clear0().
◆ chPAH_abundance
| string GrainVar::chPAH_abundance |
which functions describes the PAH abundances, changed with SET PAH
Referenced by p_clear1().
◆ dclmax
| realnum GrainVar::dclmax |
largest local cooling of gas by collisions with grains
◆ dHeatdT
| double GrainVar::dHeatdT |
gas heating derivative for all grains, in erg/cm^3/s/K
Referenced by p_clear1().
◆ dphmax
| realnum GrainVar::dphmax |
largest fraction of local heating due to grain PE heating
◆ dstab
| vector<double> GrainVar::dstab |
total absorption cross section, current depl is factored in
Referenced by p_clear0().
◆ dstAbundThresholdFar
| realnum GrainVar::dstAbundThresholdFar |
min grain abundance for enabling quantum heating in molecular regions
Referenced by p_clear1().
◆ dstAbundThresholdNear
| realnum GrainVar::dstAbundThresholdNear |
quantum heating physics min grain abundance for enabling quantum heating near I-front
Referenced by p_clear1().
◆ dstsc
| vector<double> GrainVar::dstsc |
total scattering cross section, current depl and asymmetry factored in
Referenced by p_clear0().
◆ dsttmp
| double GrainVar::dsttmp[NDEMS] |
equilibrium temperature grain temperature grid for dstems (in GrainBin)
◆ elmSumAbund
number density of elements summed over all grain bins, at actual depl
◆ GasCoolColl
| double GrainVar::GasCoolColl |
heating/cooling balance, all entries are valid for current zone, actual depl, and are in erg/cm^3/s cooling of the gas by collisions with all grains, summed in GrGC 0
◆ GasHeatNet
| double GrainVar::GasHeatNet |
net heating of the gas: PhotoEl + Therm - CoolColl
◆ GasHeatPhotoEl
| double GrainVar::GasHeatPhotoEl |
heating of the gas by photoelectric effect of all grains
◆ GasHeatTherm
| double GrainVar::GasHeatTherm |
heating of the gas by thermionic emissions of all grains
◆ GrainChTrRate
grain surface recombination rate for element nelem, ionization stage "ion-from" to "ion-to" already multiplied by grain area, actual depletion, GrainChTrRate[nelem][ion-from][ion-to], units s^-1, this can be both ionization and neutralization process, so ion-to can be > or < ion-from
Referenced by p_clear1().
◆ GrainEmission
| vector<realnum> GrainVar::GrainEmission |
grain emission total emission from this zone, per unit vol, for add outward in metfic
Referenced by p_clear0().
◆ GrainHeatChem
| double GrainVar::GrainHeatChem |
net amount of energy donated by recombining ions to all grains
◆ GrainHeatCollSum
| double GrainVar::GrainHeatCollSum |
collisional heating of all grains, added in GraC 0
◆ GrainHeatDif
| double GrainVar::GrainHeatDif |
heating of all grains by all diffuse fields (incl Lya), added in GraD 0
◆ GrainHeatInc
| double GrainVar::GrainHeatInc |
heating of all grains by incident continuum, added in GraI 0
◆ GrainHeatLya
| double GrainVar::GrainHeatLya |
heating of all grains by Lya, added in GraL 1216
◆ GrainHeatScaleFactor
| realnum GrainVar::GrainHeatScaleFactor |
scale factor for PE heating as per Allers et al. 2005 (SET GRAINS HEAT)
Referenced by p_clear1().
◆ GrainHeatSum
| double GrainVar::GrainHeatSum |
total heating of all grain types, added in GraT 0
◆ GrainMetal
| realnum GrainVar::GrainMetal |
grain depletion chemical abundances of grains are normalized such that in any given zone the total number density of an element nelem locked up in grains is given by elmSumAbund(nelem) = Sum_over_nd ( elmAbund[nd][nelem]*dstAbund[nd]*dense.hden ) grain depletion factor, from METALS xxx GRAINS command, usually 1
Referenced by p_clear1().
◆ GraphiteEmission
| vector<realnum> GrainVar::GraphiteEmission |
graphite emission from this zone only
Referenced by p_clear0().
◆ GrnElecDonateMax
| realnum GrainVar::GrnElecDonateMax |
largest local fraction of electrons donated by grains
◆ GrnElecHoldMax
| realnum GrainVar::GrnElecHoldMax |
largest local fraction of electrons contained by grains
◆ GrnRecomTe
| double GrainVar::GrnRecomTe |
the electron temperature that was used to calculate the recom rates
◆ lgAnyDustVary
| bool GrainVar::lgAnyDustVary |
do any of the grain abundances vary with depth
Referenced by p_clear1().
◆ lgBakesPAH_heat
| bool GrainVar::lgBakesPAH_heat |
turn on simple formula for PAH heating of gas
Referenced by p_clear1().
◆ lgDColOn
| bool GrainVar::lgDColOn |
turn off grain gas collisional energy exchange, set false with NO GRAIN COLLISIONAL ENERGY EXCHANGE default true, turned off with GRAIN NO COOLING
Referenced by p_clear1().
◆ lgDHetOn
| bool GrainVar::lgDHetOn |
test logic default true, turned off with GRAIN NO HEATING
Referenced by p_clear1().
◆ lgGrainElectrons
| bool GrainVar::lgGrainElectrons |
should electrons from/to grains be included in the total electron sum? del true, set false with no grain electrons command
Referenced by p_clear1().
◆ lgGrainPhysicsOn
| bool GrainVar::lgGrainPhysicsOn |
this is option to turn off all grain physics while leaving the opacity in, set false with no grain physics command
Referenced by p_clear1().
◆ lgNegGrnDrg
| bool GrainVar::lgNegGrnDrg |
flag set if negative grin drag force encountered
Referenced by p_clear1().
◆ lgQHeatAll
| bool GrainVar::lgQHeatAll |
use quantum heating for all grains, WILL BECOME DEFAULT
Referenced by p_clear1().
◆ lgQHeatOn
| bool GrainVar::lgQHeatOn |
default true, turned off with GRAIN NO QHEAT
Referenced by p_clear1().
◆ lgQHPunLast
| bool GrainVar::lgQHPunLast |
only save quantum heating information on last iteration
◆ lgReevaluate
| bool GrainVar::lgReevaluate |
reevaluate keyword on grains cmd => always reevalutae grain conditions during calculation
Referenced by p_clear1().
◆ lgWD01
| bool GrainVar::lgWD01 |
use physics as described in Weingartner & Draine (2001)
Referenced by p_clear1().
◆ nCalledGrainDrive
| long GrainVar::nCalledGrainDrive |
count how many times GrainDrive has been called
Referenced by p_clear1().
◆ nChrgRequested
| long GrainVar::nChrgRequested |
number of charge states requested by user, default value is 2
Referenced by p_clear1().
◆ nzone
| long GrainVar::nzone |
grain opacities remember in what zone grain quantities were last updated
◆ QHSaveFile
| FILE* GrainVar::QHSaveFile |
file pointer for PUNCH QHEAT command
◆ rate_h2_form_grains_used_total
| double GrainVar::rate_h2_form_grains_used_total |
H2 physics rate H2 forms on grains, summed over bins, units s^-1, actual depl when multiplied with hden, this is formation rate in H2-molecules/cm^3/s
◆ ReadRecord
| vector<string> GrainVar::ReadRecord |
record of all the files read by mie_read_opc
Referenced by p_clear0().
◆ SilicateEmission
| vector<realnum> GrainVar::SilicateEmission |
silicate emission from this zone only
Referenced by p_clear0().
◆ TotalDustHeat
| realnum GrainVar::TotalDustHeat |
total PE heating integrated over model, erg/s or erg/cm^2/s, actual depl
◆ TotalEden
| double GrainVar::TotalEden |
grain charging contribution to eden from all grain species, a positive number means that the grains contribute to the free electron pool, in cm^-3
Referenced by p_clear1().
◆ which_enth
these arrays define the physical properties of material MAT_PAH, MAT_CAR, MAT_SIL, etc... they are initialized in the constructor defines expression for the enthalpy function
Referenced by p_clear1().
◆ which_H2distr
defines expression for H2 ro-vib distribution at formation
Referenced by p_clear1().
◆ which_ial
defines expression for the inverse attenuation length
Referenced by p_clear1().
◆ which_pe
defines expression for the photo-electric effect
Referenced by p_clear1().
◆ which_pot
defines expression for the ionization potential
Referenced by p_clear1().
◆ which_strg
defines where the emitted spectrum is stored
Referenced by p_clear1().
◆ which_zmin
defines expression for Z_min
Referenced by p_clear1().
The documentation for this class was generated from the following files:
