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

#include <transition.h>

Collaboration diagram for TransitionProxy:

Public Types

typedef TransitionListImpl list_type
 
typedef ProxyIterator
< TransitionProxy,
TransitionConstProxy > 
iterator
 
typedef ProxyIterator
< TransitionConstProxy,
TransitionConstProxy > 
const_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 TransitionListImpl & system () const
 
void check () const
 
CollisionProxy Coll () const
 
realnum & WLAng () const
 
realnum EnergyK () const
 
realnum EnergyErg () const
 
double EnergyRyd () const
 
realnum EnergyAng () const
 
realnum & EnergyWN () 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_type * list () const
 

Private Attributes

list_type * m_list
 
int m_index
 

Friends

class ProxyIterator< TransitionProxy, TransitionConstProxy >
 

Member Typedef Documentation

Constructor & Destructor Documentation

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

Member Function Documentation

void TransitionProxy::AddHiState ( ) const

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

References qList::addone(), ASSERT, DEBUG_ENTRY, lgStatesAdded, m_list, setHi(), qList::size(), and TransitionListImpl::states.

Referenced by InitTransition().

Here is the call graph for this function:

void TransitionProxy::AddLine2Stack ( ) const
void TransitionProxy::AddLoState ( ) const

References qList::addone(), ASSERT, DEBUG_ENTRY, lgStatesAdded, m_list, setLo(), qList::size(), and TransitionListImpl::states.

Referenced by InitTransition().

Here is the call graph for this function:

bool TransitionProxy::associated ( ) const
inline
void TransitionProxy::check ( ) const
inline

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

Referenced by EmissionProxy::Tran().

Here is the call graph for this function:

string TransitionProxy::chLabel ( ) const
EmissionList::reference TransitionProxy::Emis ( ) const
inline
realnum TransitionProxy::EnergyAng ( ) const
inline

vacuum wavelength in Angstroms

References EnergyWN().

Referenced by print_emline_fine().

Here is the call graph for this function:

realnum TransitionProxy::EnergyErg ( ) const
inline
realnum TransitionProxy::EnergyK ( ) const
inline

transition energy in degrees kelvin

References EnergyWN().

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

Here is the call graph for this function:

double TransitionProxy::EnergyRyd ( ) const
inline

transition energy in ergs

References EnergyWN().

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

Here is the call graph for this function:

string & TransitionProxy::getComment ( ) const
inline
bool TransitionProxy::hasEmis ( ) const
inline

References ipEmis().

Referenced by check().

Here is the call graph for this function:

int & TransitionProxy::ipEmis ( ) const
inline
int & TransitionProxy::ipHi ( ) const
inline
int & TransitionProxy::ipLo ( ) const
inline
bool TransitionProxy::isSameAs ( const TransitionProxy &  other) const
inline

References m_index, and m_list.

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 WLAng().

Here is the call graph for this function:

list_type* TransitionProxy::list ( ) const
inline

References m_list.

Referenced by chIonLbl(), and chLabel().

void TransitionProxy::outline ( double  nonScatteredFraction,
bool  lgDoChecks 
) const
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:

void TransitionProxy::resetEmis ( ) const
inline

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

Referenced by AddLine2Stack().

Here is the call graph for this function:

void TransitionProxy::setComment ( const string &  comment) const
inline
void TransitionProxy::setHi ( int  ipHi) const
inline

References ipHi(), TransitionListImpl::ipHi, m_index, and m_list.

Referenced by AddHiState(), and Junk().

Here is the call graph for this function:

void TransitionProxy::setLo ( int  ipLo) const
inline

References ipLo(), TransitionListImpl::ipLo, m_index, and m_list.

Referenced by AddLoState(), and Junk().

Here is the call graph for this function:

const TransitionListImpl& TransitionProxy::system ( ) const
inline

References m_list.

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:

realnum TransitionProxy::width ( ) const
inline

References m_list, and TransitionListImpl::width().

Here is the call graph for this function:

realnum & TransitionProxy::WLAng ( ) const
inline

wavelength, usually in Angstroms, used for printout, can be any units

References m_index, m_list, and TransitionListImpl::WLAng.

Referenced by atom_level2(), chLabel(), iso_create(), Junk(), lindst(), PrtLinePres(), PutLine(), read_UTA_lines(), ReadBadnellAIData(), Save1Line(), Save1LineData(), and SaveDo().

void TransitionProxy::Zero ( ) const

TransitionZero set all elements of transition struc to zero

Parameters
*t

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

Referenced by RT_tau_init().

Here is the call graph for this function:

Friends And Related Function Documentation

Member Data Documentation


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