cloudy trunk
Loading...
Searching...
No Matches
EmissionConstProxy Class Reference

#include <emission.h>

Collaboration diagram for EmissionConstProxy:

Public Types

typedef const EmissionList list_type
typedef ProxyIterator< EmissionConstProxy, EmissionConstProxyiterator
typedef ProxyIterator< EmissionConstProxy, EmissionConstProxyconst_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 TauTot () const
const iter_track_basic< realnum > & TauTrack () const
realnum TauCon () const
realnum FracInwd () const
double pump () const
double xIntensity () const
double phots () const
realnum gf () const
realnum Pesc () const
realnum Pelec_esc () const
realnum Pdest () const
realnum Pesc_total () const
realnum dampXvel () const
realnum damp () const
double ColOvTot () const
realnum AutoIonizFrac () const
realnum opacity () const
double PopOpc () 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 150 of file emission.h.

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ list_type

Definition at line 153 of file emission.h.

Constructor & Destructor Documentation

◆ EmissionConstProxy() [1/2]

EmissionConstProxy::EmissionConstProxy ( )
inlineexplicit

Definition at line 161 of file emission.h.

References m_index, and m_list.

Referenced by copy().

◆ EmissionConstProxy() [2/2]

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

Definition at line 162 of file emission.h.

References m_index, and m_list.

Member Function Documentation

◆ Aul()

realnum EmissionConstProxy::Aul ( ) const
inline

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

Definition at line 618 of file emission.h.

References m_index, and m_list.

◆ AutoIonizFrac()

realnum EmissionConstProxy::AutoIonizFrac ( ) const
inline

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

Definition at line 588 of file emission.h.

References m_index, and m_list.

◆ check()

void EmissionConstProxy::check ( ) const
inline

all of these are set to dangerous values by EmLineJunk

Definition at line 166 of file emission.h.

References ASSERT, and ipTran().

Here is the call graph for this function:

◆ ColOvTot()

double EmissionConstProxy::ColOvTot ( ) const
inline

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

Definition at line 578 of file emission.h.

References m_index, and m_list.

◆ copy()

void EmissionConstProxy::copy ( const EmissionConstProxy & other)

References EmissionConstProxy().

Here is the call graph for this function:

◆ damp()

realnum EmissionConstProxy::damp ( ) const
inline

[dimensionless] damping constant

Definition at line 568 of file emission.h.

References m_index, and m_list.

◆ dampXvel()

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 558 of file emission.h.

References m_index, and m_list.

◆ FracInwd()

realnum EmissionConstProxy::FracInwd ( ) const
inline

inward fraction [dimensionless] of total line emission

Definition at line 468 of file emission.h.

References m_index, and m_list.

◆ gf()

realnum EmissionConstProxy::gf ( ) const
inline

gf value [dimensionless]

Definition at line 518 of file emission.h.

References m_index, and m_list.

◆ ipFine()

long int EmissionConstProxy::ipFine ( ) const
inline

index for line within fine continuum array, for line overlap

Definition at line 418 of file emission.h.

References m_index, and m_list.

◆ ipTran()

int EmissionConstProxy::ipTran ( ) const
inline

Definition at line 498 of file emission.h.

References m_index, and m_list.

Referenced by check(), and Tran().

◆ iRedisFun()

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 408 of file emission.h.

References m_index, and m_list.

◆ opacity()

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 598 of file emission.h.

References m_index, and m_list.

◆ ots()

double EmissionConstProxy::ots ( ) const
inline

ots rate [cm-3 s-1]

Definition at line 628 of file emission.h.

References m_index, and m_list.

◆ Pdest()

realnum EmissionConstProxy::Pdest ( ) const
inline

destruction probs [dimensionless]

Definition at line 548 of file emission.h.

References m_index, and m_list.

◆ Pelec_esc()

realnum EmissionConstProxy::Pelec_esc ( ) const
inline

electron scattering escape prob [dimensionless]

Definition at line 538 of file emission.h.

References m_index, and m_list.

Referenced by Pesc_total().

◆ Pesc()

realnum EmissionConstProxy::Pesc ( ) const
inline

escape prob [dimensionless]

Definition at line 528 of file emission.h.

References m_index, and m_list.

Referenced by Pesc_total().

◆ Pesc_total()

realnum EmissionConstProxy::Pesc_total ( ) const
inline

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

Definition at line 250 of file emission.h.

References Pelec_esc(), and Pesc().

Here is the call graph for this function:

◆ phots()

double EmissionConstProxy::phots ( ) const
inline

number of photons emitted in the line per unit time and vol [photons s-1 cm-3]

Definition at line 508 of file emission.h.

References m_index, and m_list.

◆ PopOpc()

double EmissionConstProxy::PopOpc ( ) const
inline

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

Definition at line 608 of file emission.h.

References m_index, and m_list.

◆ pump()

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 478 of file emission.h.

References m_index, and m_list.

◆ TauCon()

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 458 of file emission.h.

References m_index, and m_list.

◆ TauIn()

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

Definition at line 428 of file emission.h.

References m_index, and m_list.

◆ TauTot()

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 438 of file emission.h.

References m_index, and m_list.

◆ TauTrack()

const iter_track_basic< realnum > & 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 448 of file emission.h.

References m_index, and m_list.

◆ Tran()

TransitionConstProxy EmissionConstProxy::Tran ( ) const
inline

Definition at line 481 of file transition.h.

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

Here is the call graph for this function:

◆ xIntensity()

double EmissionConstProxy::xIntensity ( ) const
inline

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

Definition at line 488 of file emission.h.

References m_index, and m_list.

◆ ProxyIterator< EmissionConstProxy, EmissionConstProxy >

Definition at line 155 of file emission.h.

Field Documentation

◆ m_index

◆ m_list


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