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

#include <emission.h>

Collaboration diagram for EmissionConstProxy:
Collaboration graph
[legend]

Public Types

typedef const EmissionList list_type
 
typedef ProxyIterator
< EmissionConstProxy,
EmissionConstProxy
iterator
 
typedef ProxyIterator
< EmissionConstProxy,
EmissionConstProxy
const_iterator
 

Public Member Functions

 EmissionConstProxy ()
 
 EmissionConstProxy (const EmissionList *list, int index)
 
void copy (const EmissionConstProxy &other)
 
void check () const
 
int iRedisFun () const
 
long int ipFine () const
 
realnum TauIn () const
 
realnum TauInSpecific () const
 
realnum TauTot () const
 
const trackerTauTrack () const
 
realnum TauCon () const
 
realnum FracInwd () const
 
double pump () const
 
double xIntensity () const
 
double xObsIntensity () const
 
realnum gf () const
 
realnum Pesc () const
 
realnum Pelec_esc () const
 
realnum Pdest () const
 
realnum Pesc_total () const
 
realnum Ploss () const
 
realnum dampXvel () const
 
realnum damp () const
 
double ColOvTot () const
 
realnum AutoIonizFrac () const
 
realnum opacity () const
 
double mult_opac () const
 
double PopOpc () const
 
double VoigtLineCen () const
 
realnum Aul () const
 
double ots () const
 
int ipTran () const
 
TransitionConstProxy Tran () const
 

Private Attributes

const EmissionListm_list
 
int m_index
 

Friends

class ProxyIterator< EmissionConstProxy, EmissionConstProxy >
 

Detailed Description

Definition at line 173 of file emission.h.

Member Typedef Documentation

Definition at line 178 of file emission.h.

Definition at line 177 of file emission.h.

Definition at line 176 of file emission.h.

Constructor & Destructor Documentation

EmissionConstProxy::EmissionConstProxy ( )
inlineexplicit

Definition at line 184 of file emission.h.

EmissionConstProxy::EmissionConstProxy ( const EmissionList list,
int  index 
)
inlineexplicit

Definition at line 185 of file emission.h.

Member Function Documentation

realnum EmissionConstProxy::Aul ( ) const
inline

transition prob, Einstein A upper to lower [s-1]

Definition at line 695 of file emission.h.

References EmissionList::m_Aul, m_index, and m_list.

realnum EmissionConstProxy::AutoIonizFrac ( ) const
inline

[dimensionless] branching ratio to auto-ionization, Sum(Aai) / ( Sum(Aul) + Sum(Aai) )

Definition at line 645 of file emission.h.

References EmissionList::m_AutoIonizFrac, m_index, and m_list.

void EmissionConstProxy::check ( ) const
inline

all of these are set to dangerous values by EmLineJunk

Definition at line 189 of file emission.h.

References ASSERT, and ipTran().

Here is the call graph for this function:

double EmissionConstProxy::ColOvTot ( ) const
inline

[dimensionless] ratio of collisional to radiative excitation, C_lu / ( C_lu + pump )

Definition at line 635 of file emission.h.

References EmissionList::m_ColOvTot, m_index, and m_list.

void EmissionConstProxy::copy ( const EmissionConstProxy other)
realnum EmissionConstProxy::damp ( ) const
inline

[dimensionless] damping constant

Definition at line 625 of file emission.h.

References EmissionList::m_damp, m_index, and m_list.

realnum EmissionConstProxy::dampXvel ( ) const
inline

damping constant is dampXvel divided by line width units are velocity, since becomes dimensionless when div by line width in cm/2 [cm s-1]

Definition at line 615 of file emission.h.

References EmissionList::m_dampXvel, m_index, and m_list.

realnum EmissionConstProxy::FracInwd ( ) const
inline

inward fraction [dimensionless] of total line emission

Definition at line 525 of file emission.h.

References EmissionList::m_FracInwd, m_index, and m_list.

realnum EmissionConstProxy::gf ( ) const
inline

gf value [dimensionless]

Definition at line 575 of file emission.h.

References EmissionList::m_gf, m_index, and m_list.

long int EmissionConstProxy::ipFine ( ) const
inline

index for line within fine continuum array, for line overlap

Definition at line 465 of file emission.h.

References m_index, EmissionList::m_ipFine, and m_list.

int EmissionConstProxy::ipTran ( ) const
inline

Definition at line 565 of file emission.h.

References m_index, EmissionList::m_ipTran, and m_list.

Referenced by check(), and Tran().

int EmissionConstProxy::iRedisFun ( ) const
inline
type of redistribution function, 

-1 complete redis Doppler core only, 0 insanity 1 incomplete redistribution with damping wings, 2 complete redistribution with damping wings,

Definition at line 455 of file emission.h.

References m_index, EmissionList::m_iRedisFun, and m_list.

double EmissionConstProxy::mult_opac ( ) const
inline

Definition at line 665 of file emission.h.

References m_index, m_list, and EmissionList::m_mult_opac.

realnum EmissionConstProxy::opacity ( ) const
inline

atomic constant part of line opacity per atom, divide by line width in cm/s, to get line center opacity per atom, or absorption cross section, with units cm^2 multiply by PopOpc to get PopOpc/dopper width, the true opacity (cm-1), then by length to get optical depth

Definition at line 655 of file emission.h.

References m_index, m_list, and EmissionList::m_opacity.

double EmissionConstProxy::ots ( ) const
inline

ots rate [cm-3 s-1]

Definition at line 705 of file emission.h.

References m_index, m_list, and EmissionList::m_ots.

realnum EmissionConstProxy::Pdest ( ) const
inline

destruction probs [dimensionless]

Definition at line 605 of file emission.h.

References m_index, m_list, and EmissionList::m_Pdest.

Referenced by Ploss().

realnum EmissionConstProxy::Pelec_esc ( ) const
inline

electron scattering escape prob [dimensionless]

Definition at line 595 of file emission.h.

References m_index, m_list, and EmissionList::m_Pelec_esc.

Referenced by Pesc_total().

realnum EmissionConstProxy::Pesc ( ) const
inline

escape prob [dimensionless]

Definition at line 585 of file emission.h.

References m_index, m_list, and EmissionList::m_Pesc.

Referenced by Pesc_total().

realnum EmissionConstProxy::Pesc_total ( ) const
inline

total escape prob, from line and continuum scattering [dimensionless]

Definition at line 281 of file emission.h.

References Pelec_esc(), and Pesc().

Referenced by Ploss().

Here is the call graph for this function:

realnum EmissionConstProxy::Ploss ( ) const
inline

total loss from trapped line – escape & destruction [dimensionless]

Definition at line 284 of file emission.h.

References Pdest(), and Pesc_total().

Here is the call graph for this function:

double EmissionConstProxy::PopOpc ( ) const
inline

Population that enters net opacity after correction for stimulated emission [cm-3]

Definition at line 675 of file emission.h.

References m_index, m_list, and EmissionList::m_PopOpc.

double EmissionConstProxy::pump ( ) const
inline

continuum pumping rate [s-1] from lower to upper level, A*occ num * g_up/g_lo, this is evaluated in RTMakeStat and RTMakeWind, which are called by HydroPEsc, RT_line_all

Definition at line 535 of file emission.h.

References m_index, m_list, and EmissionList::m_pump.

realnum EmissionConstProxy::TauCon ( ) const
inline

TauCon - line optical depth [Napier] to the continuum source from the illuminated face to the current position. For an open or expanding closed geometry TauCon is equal to TauIn. For a static closed geometry TauCon is optical depth from the illuminated face to the current depth

Definition at line 515 of file emission.h.

References m_index, m_list, and EmissionList::m_TauCon.

realnum EmissionConstProxy::TauIn ( ) const
inline

optical depths - the escape probability is derived only from TauIn on first iteration. on later iterations it is the average ofesc prob in inward (TauIn) and outward (TauTot - TauIn) directions TauIn - the total inward line optical depth [Napier], in the direction of the continuum source. This is measured from the illuminated face of the cloud to the current position on the first iteration, and on second and later iterations in an open geometry or in an expanding closed geometry. For a static spherical geometry TauIn is the sum of the optical depth from the current position to the illuminated face plus the optical depth on the "other side". At the illuminated face in a static spherical geometry TauIn is TauTot / 2. It includes the effects of line overlap.

Definition at line 475 of file emission.h.

References m_index, m_list, and EmissionList::m_TauIn.

realnum EmissionConstProxy::TauInSpecific ( ) const
inline

TauInSpecific - the inward optical line depth [Napier], in the direction of the continuum source. This is much like TauIn(), except that it does not contain contributions from line overlap.

Definition at line 485 of file emission.h.

References m_index, m_list, and EmissionList::m_TauInSpecific.

realnum EmissionConstProxy::TauTot ( ) const
inline

TauTot - total line optical depth [Napier] through the cloud. TauTot is not used on the first iteration since it is not known. On second and later iterations in an open or expanding closed geometry this is the total optical depth through the computed structure. For a static closed geometry this is twice the computed structure since the geometry is assumed to be symmetric.

when the double command is entered TauTot is set to twice the normal value to simulate the presence of material beyond the computed structure.

Definition at line 495 of file emission.h.

References m_index, m_list, and EmissionList::m_TauTot.

const tracker & EmissionConstProxy::TauTrack ( ) const
inline

TauTrack - track convergence of TauIn / TauTot This class will detect oscillations and adjust the next estimate for TauIn / TauTot if this occurs

Definition at line 505 of file emission.h.

References m_index, m_list, and EmissionList::m_TauTrack.

TransitionConstProxy EmissionConstProxy::Tran ( ) const
inline

Definition at line 520 of file transition.h.

References TransitionConstProxy::check(), ipTran(), m_list, and EmissionList::m_tlist.

Here is the call graph for this function:

double EmissionConstProxy::VoigtLineCen ( ) const
inline

This variable is the Voigt profile value at line center. For lines with damp < 1, the normalized line center profile value is ~(1-damp) >>refer RT Rutten 2003 (online book)

Definition at line 685 of file emission.h.

References m_index, m_list, and EmissionList::m_VoigtLineCen.

double EmissionConstProxy::xIntensity ( ) const
inline

line intensity per unit time and vol [erg s-1 cm-3]

Definition at line 550 of file emission.h.

References m_index, m_list, and EmissionList::m_xIntensity.

double EmissionConstProxy::xObsIntensity ( ) const
inline

observed line intensity per unit time and vol [erg s-1 cm-3]; relative to xIntensity(), it includes correction for isotropic background radiation

Definition at line 555 of file emission.h.

References m_index, m_list, and EmissionList::m_xObsIntensity.

Friends And Related Function Documentation

Definition at line 180 of file emission.h.

Field Documentation

int EmissionConstProxy::m_index
private
const EmissionList* EmissionConstProxy::m_list
private

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