cloudy  trunk
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes
CollisionProxy Class Reference

#include <collision.h>

Collaboration diagram for CollisionProxy:
Collaboration graph
[legend]

Public Member Functions

 CollisionProxy (CollisionList *list, int index)
 
realnumcol_str () const
 
int & is_gbar () const
 
double * rate_coef_ul_set () const
 
const double * rate_coef_ul () const
 
realnumrate_lu_nontherm_set () const
 
realnum rate_lu_nontherm () const
 
double & cool () const
 
double & heat () const
 
double ColUL (const ColliderList &colls) const
 
double ColUL (const ColliderDensities &colld) const
 
void copy (CollisionProxy other)
 

Private Attributes

CollisionListm_list
 
int m_index
 

Detailed Description

Definition at line 84 of file collision.h.

Constructor & Destructor Documentation

CollisionProxy::CollisionProxy ( CollisionList list,
int  index 
)
inlineexplicit

Definition at line 89 of file collision.h.

Member Function Documentation

realnum & CollisionProxy::col_str ( ) const
inline

[dimensionless] collision strength of rates for transition

Definition at line 191 of file collision.h.

References CollisionList::m_col_str, m_index, and m_list.

Referenced by atom_level2(), CollisionJunk(), copy(), dBaseUpdateCollCoeffs(), DumpLine(), emit_frac(), iso_collide(), LineConvRate2CS(), MakeCS(), PutCS(), Save1LineData(), SaveHeat(), and StoutCollRate().

double CollisionProxy::ColUL ( const ColliderList colls) const
inline

collisional de-excitation rate, [s-1]

Definition at line 106 of file collision.h.

References ASSERT, ipNCOLLIDER, ColliderList::list, and rate_coef_ul().

Referenced by IonHydro(), iso_collide(), iso_cool(), iso_level(), lines(), PutLine(), Save_Line_RT(), and SaveDo().

Here is the call graph for this function:

double CollisionProxy::ColUL ( const ColliderDensities colld) const
inline

Definition at line 118 of file collision.h.

References ASSERT, ColliderDensities::density(), ipNCOLLIDER, and rate_coef_ul().

Here is the call graph for this function:

double & CollisionProxy::cool ( ) const
inline

cooling and heating due to collisional excitation [erg s-1 cm-3]

Definition at line 220 of file collision.h.

References CollisionList::m_cool, m_index, and m_list.

Referenced by atom_level2(), CollisionJunk(), CollisionZero(), copy(), DumpLine(), iso_cool(), PutLine(), PutLineSum(), and RT_line_one_tau_reset().

void CollisionProxy::copy ( CollisionProxy  other)
inline

Definition at line 130 of file collision.h.

References col_str(), cool(), heat(), ipNCOLLIDER, rate_coef_ul(), rate_coef_ul_set(), rate_lu_nontherm(), and rate_lu_nontherm_set().

Here is the call graph for this function:

double & CollisionProxy::heat ( ) const
inline
int & CollisionProxy::is_gbar ( ) const
inline

is the collision strength created from gbar

is the collision strength created from gbar -1 = undefined, 0 = Not gbar, 1 = gbar

Definition at line 197 of file collision.h.

References m_index, CollisionList::m_is_gbar, and m_list.

Referenced by CollisionJunk().

const double * CollisionProxy::rate_coef_ul ( ) const
inline

Definition at line 206 of file collision.h.

References m_index, m_list, and CollisionList::m_rates.

Referenced by ColUL(), copy(), dBaseUpdateCollCoeffs(), and iso_collide().

double * CollisionProxy::rate_coef_ul_set ( ) const
inline

collisional de-excitation rate coefficients for individual colliders [cm3 s-1]

Definition at line 202 of file collision.h.

References m_index, m_list, and CollisionList::m_rates.

Referenced by CollisionJunk(), copy(), dBaseUpdateCollCoeffs(), and iso_collide().

realnum CollisionProxy::rate_lu_nontherm ( ) const
inline

Definition at line 215 of file collision.h.

References m_index, m_list, and CollisionList::m_rate_lu_nontherm.

Referenced by copy(), and iso_level().

realnum & CollisionProxy::rate_lu_nontherm_set ( ) const
inline

Definition at line 211 of file collision.h.

References m_index, m_list, and CollisionList::m_rate_lu_nontherm.

Referenced by CollisionJunk(), copy(), and iso_suprathermal().

Field Documentation

int CollisionProxy::m_index
private
CollisionList* CollisionProxy::m_list
private

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