Cloudy
Spectral Synthesis Code for Astrophysics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
molecule Class Reference

#include <mole.h>

Public Types

typedef map< const shared_ptr
< chem_nuclide >, int,
element_pointer_value_less
nNucsMap
 

Public Member Functions

bool isIsotopicTotalSpecies () const
 
int n_nuclei (void) const
 
int nElement (int nelem)
 
bool isMonatomic (void) const
 
bool isMolecule () const
 
class molezonelocal (void) const
 
chem_nuclideheavyAtom (void)
 
int compare (const molecule &mol2) const
 

Public Attributes

string parentLabel
 
int parentIndex
 
bool isEnabled
 
string label
 
nNucsMap nNuclide
 
int charge
 
bool lgExcit
 
bool lgGas_Phase
 
realnum form_enthalpy
 
realnum mole_mass
 
enum mole_state state
 
int index
 
int groupnum
 
int n_react
 

Member Typedef Documentation

typedef map<const shared_ptr<chem_nuclide>, int, element_pointer_value_less> molecule::nNucsMap

Member Function Documentation

int molecule::compare ( const molecule mol2) const
inline

References ASSERT, label, and nNuclide.

chem_nuclide* molecule::heavyAtom ( void  )
inline

References nNuclide, and null_nuclide.

bool molecule::isIsotopicTotalSpecies ( ) const
inline

References parentLabel.

bool molecule::isMolecule ( ) const
inline

isMolecule – Tell if a species is a molecule, that is, if it is composed of more than one nuclei.

Returns
true, if one nucleus in species; false, otherwise

References nNuclide.

Referenced by isMolecule(), and isSpecies().

bool molecule::isMonatomic ( void  ) const
inline

isMonatomic – Tell if a species is composed of only one atom

Returns
true, if one nucleus in species; false, otherwisetotal number of nuclei

References nNuclide.

Referenced by t_mole_local::dissoc_rate(), isSpecies(), and mole_make_list().

molezone * molecule::local ( void  ) const
inline

number of reactions that involve this molecule

References index, null_molezone, and t_mole_local::species.

Referenced by CoolHeatError().

int molecule::n_nuclei ( void  ) const
inline

Solid or gas phase? total number of nuclei

References nNuclide.

int molecule::nElement ( int  nelem)
inline

References nNuclide.

Member Data Documentation

int molecule::charge

number of each nuclide in molecule

Referenced by t_mole_global::make_species(), mole_eval_sources(), and mole_make_list().

realnum molecule::form_enthalpy
int molecule::groupnum
bool molecule::isEnabled

Referenced by parse_reaction().

bool molecule::lgExcit

Charge on species/number of e- liberated by formation

bool molecule::lgGas_Phase

Is species excited (e.g. H2*)

Referenced by mole_make_list().

realnum molecule::mole_mass

formation enthalpy for the molecule (at 0K), in units of KJ/mol

Referenced by diatomics::init(), t_mole_global::make_species(), and mole_partition_function().

int molecule::n_react
int molecule::parentIndex
string molecule::parentLabel
enum mole_state molecule::state

Mass of molecule

Referenced by isactive(), and ispassive().


The documentation for this class was generated from the following file: