cloudy: t_hyperfine Struct Reference

#include <hyperfine.h>

Inheritance diagram for t_hyperfine:

Inheritance graph

Collaboration diagram for t_hyperfine:

Collaboration graph

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 ()

Data Fields
realnum *	HFLabundance

double	Tspin21cm

bool	lgLya_pump_21cm

double	cooling_total

realnum	cooling_max

LyaSourceFunctionShape	LyaSourceFunctionShape_assumed

Detailed Description

Definition at line 42 of file hyperfine.h.

Member Enumeration Documentation

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

Definition at line 71 of file hyperfine.h.

Member Function Documentation

const char* t_hyperfine::chName ( ) const

inlinevirtual

Implements module.

Definition at line 44 of file hyperfine.h.

void t_hyperfine::comment ( t_warnings & )

inlinevirtual

Implements module.

Definition at line 50 of file hyperfine.h.

void t_hyperfine::zero ( void )

virtual

Implements module.

Definition at line 7 of file hyperfine.cpp.

References DEBUG_ENTRY, EXCITATION, lgLya_pump_21cm, and LyaSourceFunctionShape_assumed.

Field Documentation

realnum t_hyperfine::cooling_max

largest relative cooling due to hyperfine structure lines

Definition at line 65 of file hyperfine.h.

Referenced by IterStart(), lines(), and PrtComment().

double t_hyperfine::cooling_total

total cooling due to all hyperfine lines

Definition at line 62 of file hyperfine.h.

Referenced by CoolHyperfine(), and lines().

realnum* t_hyperfine::HFLabundance

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

Definition at line 53 of file hyperfine.h.

Referenced by CoolHyperfine(), and HyperfineCreate().

bool t_hyperfine::lgLya_pump_21cm

option to turn off Lya pumping of 21 cm

Definition at line 59 of file hyperfine.h.

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

LyaSourceFunctionShape t_hyperfine::LyaSourceFunctionShape_assumed

Definition at line 72 of file hyperfine.h.

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

double t_hyperfine::Tspin21cm

this is the computed 21cm spin temperature

Definition at line 56 of file hyperfine.h.

Referenced by H21_cm_pops(), diatomics::H2_PunchDo(), t_mean::MeanInc(), radius_increment(), radius_next(), and SaveDo().

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