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

#include <transition.h>

Collaboration diagram for TransitionProxy:
Collaboration graph
[legend]

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 TransitionListImplsystem () const
 
void check () const
 
CollisionProxy Coll () const
 
realnumWLAng () const
 
realnum EnergyK () const
 
realnum EnergyErg () const
 
double EnergyRyd () const
 
realnum EnergyAng () const
 
realnumEnergyWN () const
 
long & ipCont () const
 
void Junk (void) const
 
void Zero (void) 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 >
 

Detailed Description

Definition at line 24 of file transition.h.

Member Typedef Documentation

Definition at line 29 of file transition.h.

Definition at line 28 of file transition.h.

Definition at line 27 of file transition.h.

Constructor & Destructor Documentation

TransitionProxy::TransitionProxy ( )
inlineexplicit

Definition at line 40 of file transition.h.

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

Definition at line 41 of file transition.h.

Member Function Documentation

void TransitionProxy::AddHiState ( ) const

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

Definition at line 651 of file transition.cpp.

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

Definition at line 628 of file transition.cpp.

References ASSERT, DEBUG_ENTRY, TransitionListImpl::Emis, ipEmis(), lgLinesAdded, m_list, resetEmis(), EmissionList::resize(), and EmissionList::size().

Referenced by copy(), DoFSMixing(), InitTransition(), and iso_create().

Here is the call graph for this function:

void TransitionProxy::AddLoState ( ) const

Definition at line 640 of file transition.cpp.

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

Definition at line 54 of file transition.h.

References m_index, and m_list.

Referenced by LinSv::biglabel(), emit_frac(), FndLineHt(), LinSv::init(), lines(), radius_next(), save_line(), and SaveHeat().

void TransitionProxy::check ( ) const
inline

Definition at line 75 of file transition.h.

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

Referenced by EmissionProxy::Tran().

Here is the call graph for this function:

string TransitionProxy::chLabel ( ) const

Definition at line 271 of file transition.cpp.

References chIonLbl(), chSpecies, DEBUG_ENTRY, Hi(), list(), NCHLAB, sprt_wl(), and WLAng().

Referenced by chLineLbl(), print_emline_fine(), prme(), prt_trans_opc_debug(), RT_DestProb(), RT_line_one_tauinc(), RT_line_pumping(), and set_xIntensity().

Here is the call graph for this function:

CollisionProxy TransitionProxy::Coll ( ) const
inline
void TransitionProxy::copy ( const TransitionProxy other) const
inline
EmissionList::reference TransitionProxy::Emis ( ) const
inline

Definition at line 447 of file transition.h.

References DummyEmis, TransitionListImpl::Emis, ipEmis(), TransitionListImpl::ipEmis, m_index, and m_list.

Referenced by atom_level2(), cdTemp(), check(), ContCreatePointers(), ConvIterCheck(), dBase_solve(), DoFSMixing(), DoSatelliteLines(), DumpLine(), emit_frac(), HeCSInterp(), HydroCSInterp(), iso_cascade(), iso_collapsed_Aul_update(), iso_collapsed_lifetimes_update(), iso_create(), iso_get_collision_strength(), iso_level(), iso_multiplet_opacities_one(), iso_renorm(), iso_setOpacity(), iso_setRedisFun(), iso_solve(), iso_suprathermal(), IterStart(), lgTauGood(), lindst(), lines(), lines_helium(), lines_hydro(), lines_iron_Ka(), MakeCS(), OccupationNumberLine(), outline(), outline_resonance(), phots(), PressureRadiationLine(), print_emline_fine(), prme(), prt_trans_opc_debug(), PrtComment(), PrtHydroTrace1(), PutLine(), PutLineSum(), radius_next(), randomize_inten(), read_UTA_lines(), ReadBadnellAIData(), resetEmis(), RT_continuum_shield_fcn(), RT_continuum_shield_fcn_point(), RT_DestProb(), RT_diffuse(), RT_line_all_escape(), RT_line_driving(), RT_line_electron_scatter(), RT_line_escape(), RT_line_fine_opacity(), RT_line_one_escape(), RT_line_one_fine(), RT_line_one_tau_reset(), RT_line_one_tauinc(), RT_line_pumping(), RT_LineWidth(), RT_OTS(), RT_stark(), RT_tau_init(), RT_tau_reset(), RTesc_lya(), SanityCheckBegin(), Save1Line(), Save1LineData(), save_line(), Save_Line_RT(), SaveDo(), SaveHeat(), set_xIntensity(), setXtraRatesFe2(), setXtraRatesO1(), and Zero().

Here is the call graph for this function:

realnum TransitionProxy::EnergyAng ( ) const
inline

vacuum wavelength in Angstroms

Definition at line 100 of file transition.h.

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

Definition at line 85 of file transition.h.

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

Definition at line 95 of file transition.h.

References EnergyWN().

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

Here is the call graph for this function:

realnum & TransitionProxy::EnergyWN ( ) const
inline
string & TransitionProxy::getComment ( ) const
inline

Definition at line 531 of file transition.h.

References TransitionListImpl::chComment, m_index, and m_list.

bool TransitionProxy::hasEmis ( ) const
inline

Definition at line 62 of file transition.h.

References ipEmis().

Referenced by check().

Here is the call graph for this function:

qList::iterator TransitionProxy::Hi ( ) const
inline
long & TransitionProxy::ipCont ( ) const
inline
int & TransitionProxy::ipEmis ( ) const
inline

Definition at line 455 of file transition.h.

References TransitionListImpl::ipEmis, m_index, and m_list.

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

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

Definition at line 58 of file transition.h.

References m_index, and m_list.

void TransitionProxy::Junk ( void  ) const

set all elements of transition struc to dangerous values

Parameters
*t

Definition at line 440 of file transition.cpp.

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

Definition at line 139 of file transition.h.

References m_list.

Referenced by chIonLbl(), and chLabel().

qList::iterator TransitionProxy::Lo ( ) const
inline
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

Definition at line 39 of file transition.cpp.

References Emis(), and outline().

Here is the call graph for this function:

void TransitionProxy::resetEmis ( ) const
inline

Definition at line 66 of file transition.h.

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

Definition at line 527 of file transition.h.

References TransitionListImpl::chComment, m_index, and m_list.

void TransitionProxy::setHi ( int  ipHi) const
inline

Definition at line 443 of file transition.h.

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

Definition at line 439 of file transition.h.

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

Definition at line 71 of file transition.h.

References m_list.

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

Definition at line 381 of file transition.h.

References TransitionList::isSame(), and m_list.

Referenced by RT_line_pumping().

Here is the call graph for this function:

realnum TransitionProxy::width ( ) const
inline

Definition at line 540 of file transition.h.

References m_list, and TransitionListImpl::width().

Here is the call graph for this function:

realnum & TransitionProxy::WLAng ( ) const
inline
void TransitionProxy::Zero ( void  ) const

TransitionZero set all elements of transition struc to zero

Parameters
*t

Definition at line 468 of file transition.cpp.

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

Definition at line 31 of file transition.h.

Field Documentation

int TransitionProxy::m_index
private
list_type* TransitionProxy::m_list
private

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