Cloudy
Spectral Synthesis Code for Astrophysics
Loading...
Searching...
No Matches
TransitionProxy Class Reference

#include <transition.h>

Collaboration diagram for TransitionProxy:

Public Types

typedef TransitionListImpl list_type
 
typedef ProxyIterator< TransitionProxy, TransitionConstProxyiterator
 
typedef ProxyIterator< TransitionConstProxy, TransitionConstProxyconst_iterator
 

Public Member Functions

 TransitionProxy ()
 
 TransitionProxy (TransitionListImpl *list, int index)
 
void copy (const TransitionProxy &other) const
 
qList::iterator Lo () const
 
qList::iterator Hi () const
 
void setLo (int ipLo) const
 
void setHi (int ipHi) const
 
void AddLine2Stack () const
 
EmissionList::reference Emis () const
 
int & ipEmis () const
 
string chLabel () const
 
void setComment (const string &comment) const
 
string & getComment () const
 
bool associated () const
 
bool isSameAs (const TransitionProxy &other) const
 
bool hasEmis () const
 
void resetEmis () const
 
bool systemIs (const TransitionList *query) const
 
const TransitionListImplsystem () const
 
void check () const
 
CollisionProxy Coll () const
 
realnumWLangVac () const
 
t_wavl twav () const
 
realnum EnergyK () const
 
realnum EnergyErg () const
 
double EnergyRyd () const
 
realnumEnergyWN () const
 
long & ipCont () const
 
void Junk () const
 
void Zero () const
 
void outline (double nonScatteredFraction, bool lgDoChecks) const
 
void outline_resonance () const
 
int & ipLo () const
 
int & ipHi () const
 
void AddHiState () const
 
void AddLoState () const
 
realnum width () const
 
list_typelist () const
 

Private Attributes

list_typem_list
 
int m_index
 

Friends

class ProxyIterator< TransitionProxy, TransitionConstProxy >
 

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ list_type

Constructor & Destructor Documentation

◆ TransitionProxy() [1/2]

TransitionProxy::TransitionProxy ( )
inlineexplicit

References m_index, and m_list.

Referenced by copy(), and isSameAs().

◆ TransitionProxy() [2/2]

TransitionProxy::TransitionProxy ( TransitionListImpl * list,
int index )
inlineexplicit

References list(), m_index, and m_list.

Here is the call graph for this function:

Member Function Documentation

◆ AddHiState()

void TransitionProxy::AddHiState ( ) const

AddState2Stack add generic quantum state to GenericStates and return pointer to that state.

References ASSERT, DEBUG_ENTRY, lgStatesAdded, m_list, and setHi().

Referenced by InitTransition().

Here is the call graph for this function:

◆ AddLine2Stack()

void TransitionProxy::AddLine2Stack ( ) const

References ASSERT, DEBUG_ENTRY, ipEmis(), lgLinesAdded, m_list, and resetEmis().

Referenced by atmdat_CHIANTI_readin(), atmdat_STOUT_readin(), copy(), and InitTransition().

Here is the call graph for this function:

◆ AddLoState()

void TransitionProxy::AddLoState ( ) const

References ASSERT, DEBUG_ENTRY, lgStatesAdded, m_list, and setLo().

Referenced by InitTransition().

Here is the call graph for this function:

◆ associated()

bool TransitionProxy::associated ( ) const
inline

◆ check()

void TransitionProxy::check ( ) const
inline

References ASSERT, Emis(), hasEmis(), and m_index.

Referenced by EmissionProxy::Tran().

Here is the call graph for this function:

◆ chLabel()

◆ Coll()

◆ copy()

◆ Emis()

◆ EnergyErg()

realnum TransitionProxy::EnergyErg ( ) const
inline

transition energy in ergs

References EnergyWN().

Referenced by atom_level2(), iso_cool(), iso_get_collision_strength(), outline(), phots(), PressureRadiationLine(), PutLine(), RT_diffuse(), RT_line_one_escape(), RT_line_one_fine(), and set_xIntensity().

Here is the call graph for this function:

◆ EnergyK()

realnum TransitionProxy::EnergyK ( ) const
inline

transition energy in degrees kelvin

References EnergyWN().

Referenced by atom_level2(), MakeCS(), and TexcLine().

Here is the call graph for this function:

◆ EnergyRyd()

double TransitionProxy::EnergyRyd ( ) const
inline

transition energy in ergs

References EnergyWN().

Referenced by iso_level(), Save1Line(), Save1LineData(), and TwoPhotonSetup().

Here is the call graph for this function:

◆ EnergyWN()

◆ getComment()

string & TransitionProxy::getComment ( ) const
inline

References m_index, and m_list.

◆ hasEmis()

bool TransitionProxy::hasEmis ( ) const
inline

References ipEmis().

Referenced by atmdat_CHIANTI_readin(), atmdat_STOUT_readin(), and check().

Here is the call graph for this function:

◆ Hi()

◆ ipCont()

long & TransitionProxy::ipCont ( ) const
inline

index for line within continuum array, this is on the f, not c, scale, negative ipCont means this is not a radiative transition, and is used as a sentnecl

References m_index, and m_list.

Referenced by atom_level2(), ContCreatePointers(), DumpLine(), emit_frac(), iso_suprathermal(), Junk(), lindst(), lines_helium(), OccupationNumberLine(), outline(), prme(), PutLine(), RT_continuum_shield_fcn(), RT_DestProb(), RT_diffuse(), RT_line_electron_scatter(), RT_line_one_tau_reset(), RT_line_one_tauinc(), RT_line_pumping(), RT_stark(), RTesc_lya(), Save1LineData(), Save_Line_RT(), and set_xIntensity().

◆ ipEmis()

int & TransitionProxy::ipEmis ( ) const
inline

References m_index, and m_list.

Referenced by AddLine2Stack(), Emis(), hasEmis(), and Junk().

◆ ipHi()

int & TransitionProxy::ipHi ( ) const
inline

◆ ipLo()

int & TransitionProxy::ipLo ( ) const
inline

◆ isSameAs()

bool TransitionProxy::isSameAs ( const TransitionProxy & other) const
inline

References m_index, m_list, and TransitionProxy().

Here is the call graph for this function:

◆ Junk()

void TransitionProxy::Junk ( ) const

set all elements of transition struc to dangerous values

Parameters
*t

References Coll(), CollisionJunk(), DEBUG_ENTRY, EnergyWN(), ipCont(), ipEmis(), setHi(), setLo(), and WLangVac().

Here is the call graph for this function:

◆ list()

list_type * TransitionProxy::list ( ) const
inline

References m_list.

Referenced by chIonLbl(), chLabel(), and TransitionProxy().

◆ Lo()

◆ outline()

void TransitionProxy::outline ( double nonScatteredFraction,
bool lgDoChecks ) const

outline - adds line photons to reflin and outlin

References ASSERT, EmissionProxy::Aul(), conv, DEBUG_ENTRY, Emis(), EnergyErg(), fp_equal_tol(), Hi(), Singleton< t_version >::Inst(), ipCont(), MAX2, outline_base(), EmissionProxy::Pesc_total(), radius, rfield, and SMALLFLOAT.

Referenced by outline_resonance(), and RT_diffuse().

Here is the call graph for this function:

◆ outline_resonance()

void TransitionProxy::outline_resonance ( ) const

outline_resonance - adds line photons to reflin and outlin, setting nonScatteredFraction as default for resonance lines

References Emis(), and outline().

Here is the call graph for this function:

◆ resetEmis()

void TransitionProxy::resetEmis ( ) const
inline

References Emis(), EmissionProxy::ipTran(), and m_index.

Referenced by AddLine2Stack().

Here is the call graph for this function:

◆ setComment()

void TransitionProxy::setComment ( const string & comment) const
inline

References m_index, and m_list.

Referenced by atmdat_CHIANTI_readin(), and atmdat_STOUT_readin().

◆ setHi()

void TransitionProxy::setHi ( int ipHi) const
inline

References ipHi(), m_index, and m_list.

Referenced by AddHiState(), and Junk().

Here is the call graph for this function:

◆ setLo()

void TransitionProxy::setLo ( int ipLo) const
inline

References ipLo(), m_index, and m_list.

Referenced by AddLoState(), and Junk().

Here is the call graph for this function:

◆ system()

const TransitionListImpl & TransitionProxy::system ( ) const
inline

References m_list.

◆ systemIs()

bool TransitionProxy::systemIs ( const TransitionList * query) const
inline

References TransitionList::isSame(), and m_list.

Referenced by RT_line_pumping().

Here is the call graph for this function:

◆ twav()

t_wavl TransitionProxy::twav ( ) const
inline

References t_vac(), and WLangVac().

Referenced by chLabel(), lindst(), PutLine(), Save1Line(), and Save1LineData().

Here is the call graph for this function:

◆ width()

realnum TransitionProxy::width ( ) const
inline

References m_list.

◆ WLangVac()

realnum & TransitionProxy::WLangVac ( ) const
inline

vacuum wavelength, in angstrom

References m_index, and m_list.

Referenced by atmdat_CHIANTI_readin(), atmdat_STOUT_readin(), atom_level2(), Junk(), ReadBadnellAIData(), and twav().

◆ Zero()

void TransitionProxy::Zero ( ) const

TransitionZero set all elements of transition struc to zero

Parameters
*t

References Coll(), CollisionZero(), DEBUG_ENTRY, Emis(), EmLineZero(), Hi(), Lo(), TauZero(), and Zero().

Referenced by Zero().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ ProxyIterator< TransitionProxy, TransitionConstProxy >

Member Data Documentation

◆ m_index

◆ m_list


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