t_hyperfine Struct Reference

#include <hyperfine.h>

Inheritance diagram for t_hyperfine:

Collaboration diagram for t_hyperfine:

Public Types
enum	LyaSourceFunctionShape { EXCITATION , KINETIC , CONSTANT }

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

Public Attributes
vector< realnum >	HFLabundance
double	Tspin21cm
bool	lgLya_pump_21cm
double	cooling_total
realnum	cooling_max
LyaSourceFunctionShape	LyaSourceFunctionShape_assumed

Member Enumeration Documentation

LyaSourceFunctionShape

enum t_hyperfine::LyaSourceFunctionShape

type and enum for determining shape of Lya source function at line center, for 21 cm pumping. EXCITATION: 2p / 1s excitation temperature KINETIC: gas kinetic temperature CONSTANT: S_nu = constant

Enumerator
EXCITATION
KINETIC
CONSTANT

Member Function Documentation

chName()

const char * t_hyperfine::chName ( ) const

inlinevirtual

Implements module.

comment()

void t_hyperfine::comment ( t_warnings & )

inlinevirtual

Implements module.

zero()

void t_hyperfine::zero ( void )

virtual

Implements module.

References DEBUG_ENTRY, EXCITATION, lgLya_pump_21cm, and LyaSourceFunctionShape_assumed.

Member Data Documentation

cooling_max

realnum t_hyperfine::cooling_max

largest relative cooling due to hyperfine structure lines

cooling_total

double t_hyperfine::cooling_total

total cooling due to all hyperfine lines

HFLabundance

vector<realnum> t_hyperfine::HFLabundance

the isotope abundances relative to main species abundances, as read in from the hyperfine.dat file

lgLya_pump_21cm

bool t_hyperfine::lgLya_pump_21cm

option to turn off Lya pumping of 21 cm

Referenced by zero().

LyaSourceFunctionShape_assumed

LyaSourceFunctionShape t_hyperfine::LyaSourceFunctionShape_assumed

Referenced by zero().

Tspin21cm

double t_hyperfine::Tspin21cm

this is the computed 21cm spin temperature

---

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

• hyperfine.h
• hyperfine.cpp