transition.h File Reference

#include "emission.h"
#include "collision.h"
#include "quantumstate.h"

Include dependency graph for transition.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	TransitionProxy
class	TransitionConstProxy
class	TransitionListImpl
class	TransitionList
class	ExtraInten

Typedefs
typedef map< std::string, std::vector< TransitionProxy > >::iterator	blend_iterator

Functions
void	PutLine (const TransitionProxy &t, const char *chComment)
void	PutLine (const TransitionProxy &t, const char *chComment, const char *chLabel)
void	PutLine (const TransitionProxy &t, const char *chComment, const char *chLabel, const ExtraInten &extra)
double	TexcLine (const TransitionProxy &t)
void	DumpLine (const TransitionProxy &t)
double	emit_frac (const TransitionProxy &t)
double	GetLineRec (long int ip, long int lWl)
string	chIonLbl (const TransitionProxy &t)
string	chIonLbl (const long &nelem, const long &IonStg)
string	chLineLbl (const TransitionProxy &t)
void	PutCS (double cs, const TransitionProxy &t)
string	GenerateTransitionConfiguration (const TransitionProxy &t)
double	OccupationNumberLine (const TransitionProxy &t)
void	LineConvRate2CS (const TransitionProxy &t, realnum rate)
bool	lgTauGood (const TransitionProxy &t)
void	MakeCS (const TransitionProxy &t)
double	phots (const TransitionProxy &t)

Variables
EmissionProxy	DummyEmis
map< std::string, std::vector < TransitionProxy > >	blends

Typedef Documentation

typedef map<std::string,std::vector<TransitionProxy> >::iterator blend_iterator

Function Documentation

string chIonLbl

(

const TransitionProxy &

t

)

generate null terminated line label from contents of line trans array 

Parameters

*t

References chIonLbl(), qList::chLabel(), DEBUG_ENTRY, TransitionProxy::Hi(), TransitionProxy::list(), and TransitionListImpl::states.

Referenced by atom_level2(), chIonLbl(), TransitionProxy::chLabel(), ContCreatePointers(), ipShells(), lgCheckMonitors(), lines(), lines_continuum(), lines_general(), lines_helium(), lines_hydro(), PrtLinePres(), PutLine(), read_UTA_lines(), Save1Line(), Save1LineData(), and SaveLineData().

Here is the call graph for this function:

string chIonLbl	(	const long &	nelem,
		const long &	IonStg
	)

References ASSERT, t_elementnames::chElementSym, t_elementnames::chIonStage, DEBUG_ENTRY, elementnames, and LIMELM.

string chLineLbl ( const TransitionProxy &  t )

inline

chLineLbl use information in line transfer arrays to generate a line label
this label is null terminated

Parameters

*t

References TransitionProxy::chLabel().

Referenced by ContCreatePointers(), ConvIterCheck(), DumpLine(), PresTotCurrent(), PrtComment(), radius_next(), RT_continuum_shield_fcn(), RT_line_one_tau_reset(), Save1Line(), Save_Line_RT(), and SaveHeat().

Here is the call graph for this function:

void DumpLine

(

const TransitionProxy &

t

)

DumpLine print various information about an emission line vector, used in debugging

Parameters

*t

References t_opac::albedo, ASSERT, EmissionProxy::Aul(), chLineLbl(), CollisionProxy::col_str(), TransitionProxy::Coll(), CollisionProxy::cool(), DEBUG_ENTRY, dense, t_dense::eden, TransitionProxy::Emis(), fprintf(), CollisionProxy::heat(), TransitionProxy::Hi(), ioQQQ, TransitionProxy::ipCont(), TransitionProxy::Lo(), opac, t_opac::opacity_abs, EmissionProxy::ots(), EmissionProxy::Pdest(), EmissionProxy::Pelec_esc(), EmissionProxy::Pesc(), phycon, EmissionProxy::PopOpc(), EmissionProxy::pump(), EmissionProxy::TauIn(), EmissionProxy::TauTot(), t_phycon::te, and TexcLine().

Referenced by ConvBase(), CoolSum(), dBase_solve(), FindNeg(), RT_diffuse(), RT_line_all_escape(), and RT_line_escape().

Here is the call graph for this function:

double emit_frac

(

const TransitionProxy &

t

)

returns fraction of populations that produce emission

Parameters

*t

References ASSERT, TransitionProxy::associated(), EmissionProxy::Aul(), t_dense::cdsqte, CollisionProxy::col_str(), TransitionProxy::Coll(), DEBUG_ENTRY, dense, TransitionProxy::Emis(), TransitionProxy::ipCont(), EmissionProxy::Pdest(), and EmissionProxy::Pesc_total().

Referenced by lines().

Here is the call graph for this function:

string GenerateTransitionConfiguration

(

const TransitionProxy &

t

)

GenerateTransitionConfiguration - given const TransitionList::iterator &t, writes a label t->Lo->chConfig() - t->Hi->chConfig() (i.e., 2^3S - 2^3P)

Parameters

t	transition

Returns

comment string

References TransitionProxy::Hi(), and TransitionProxy::Lo().

Referenced by iso_comment_tran_levels().

Here is the call graph for this function:

double GetLineRec	(	long int	ip,
		long int	lWl
	)

References cdEXIT, DEBUG_ENTRY, dense, t_dense::eden, EXIT_FAILURE, fprintf(), ioQQQ, LineSave, t_LineSave::RecCoefCNO, and t_dense::xIonDense.

Referenced by lines().

Here is the call graph for this function:

bool lgTauGood ( const TransitionProxy &  t )

inline

lgTauGood returns true is we have good (positive) outward optical depths not true if we have overrun optical depth scale from previous iteration

Parameters

*t

References TransitionProxy::Emis(), iteration, EmissionProxy::TauIn(), and EmissionProxy::TauTot().

Referenced by RT_line_all_escape(), and RT_line_one_escape().

Here is the call graph for this function:

void LineConvRate2CS	(	const TransitionProxy &	t,
		realnum	rate
	)

convert down coll rate back into electron cs in case other parts of code need this for reference 

Parameters

*t	- line struct collision strength is stored in t->cs
rate	- deexcitation rate, units s-1

References ASSERT, t_dense::cdsqte, CollisionProxy::col_str(), TransitionProxy::Coll(), DEBUG_ENTRY, dense, and TransitionProxy::Hi().

Here is the call graph for this function:

void MakeCS

(

const TransitionProxy &

t

)

MakeCS compute collision strength by g-bar approximations

Parameters

*t

References CollisionProxy::col_str(), TransitionProxy::Coll(), DEBUG_ENTRY, dense, TransitionProxy::Emis(), TransitionProxy::EnergyK(), TransitionProxy::EnergyWN(), gbar0(), gbar1(), EmissionProxy::gf(), TransitionProxy::Hi(), and t_dense::xIonDense.

Referenced by dBaseUpdateCollCoeffs(), and HyperfineCreate().

Here is the call graph for this function:

double OccupationNumberLine

(

const TransitionProxy &

t

)

OccupationNumberLine - derive the photon occupation number at line center for any line

Parameters

*t

References ASSERT, DEBUG_ENTRY, TransitionProxy::Emis(), TransitionProxy::Hi(), TransitionProxy::ipCont(), TransitionProxy::Lo(), EmissionProxy::Pesc(), EmissionProxy::PopOpc(), and SMALLFLOAT.

Referenced by H21_cm_pops(), and SaveDo().

Here is the call graph for this function:

double phots ( const TransitionProxy &  t )

inline

References TransitionProxy::Emis(), TransitionProxy::EnergyErg(), and EmissionProxy::xIntensity().

Referenced by lindst(), lindst1(), lines_helium(), and RT_diffuse().

Here is the call graph for this function:

void PutCS	(	double	cs,
		const TransitionProxy &	t
	)

PutCS enter a collision strength into an individual line struc

Parameters

cs
*t	the line struc

References ASSERT, CollisionProxy::col_str(), TransitionProxy::Coll(), and DEBUG_ENTRY.

Referenced by CoolDima(), and CoolHyperfine().

Here is the call graph for this function:

void PutLine	(	const TransitionProxy &	t,
		const char *	chComment
	)

enter lines into the line storage array, called once per zone for each line

Parameters

xInten	xInten - local emissivity per unit vol, no fill fac
wavelength	lam integer wavelength
*chLab	string label for ion
chInfo	character type of entry for line - 'c' cooling, 'h' heating, 'i' info only, 'r' recom line
*chComment	string explaining line PutLine enter local line intensity into the intensity stack for eventual printout
*t	transition structure for line
*chComment	a description of the line

References DEBUG_ENTRY, NULL, and PutLine().

Here is the call graph for this function:

void PutLine	(	const TransitionProxy &	t,
		const char *	chComment,
		const char *	chLabel
	)

PutLine enter local line intensity into the intensity stack for eventual printout

Parameters

*t	transition structure for line
*chComment	a description of the line
*chLabel	the line label

References DEBUG_ENTRY, and PutLine().

Here is the call graph for this function:

void PutLine	(	const TransitionProxy &	t,
		const char *	chComment,
		const char *	chLabel,
		const ExtraInten &	extra
	)

References ASSERT, EmissionProxy::Aul(), chIonLbl(), TransitionProxy::Coll(), colliders, EmissionProxy::ColOvTot(), CollisionProxy::ColUL(), CollisionProxy::cool(), DEBUG_ENTRY, TransitionProxy::Emis(), TransitionProxy::EnergyErg(), t_rt::fracin, EmissionProxy::FracInwd(), CollisionProxy::heat(), t_LineSave::ipass, TransitionProxy::ipCont(), linadd(), lindst(), LineSave, TransitionProxy::Lo(), NCHLAB, EmissionProxy::Pesc_total(), EmissionProxy::Ploss(), EmissionProxy::pump(), rt, ExtraInten::v, TransitionProxy::WLAng(), and EmissionProxy::xIntensity().

Referenced by DoSatelliteLines(), diatomics::H2_LinesAdd(), lines(), lines_helium(), lines_hydro(), and PutLine().

Here is the call graph for this function:

double TexcLine

(

const TransitionProxy &

t

)

TexcLine derive excitation temperature of line from contents of line array

Parameters

*t

References DEBUG_ENTRY, TransitionProxy::EnergyK(), TransitionProxy::Hi(), TransitionProxy::Lo(), and SMALLFLOAT.

Referenced by DumpLine(), H21_cm_pops(), HyperfineTspin(), radius_increment(), and SaveDo().

Here is the call graph for this function:

Variable Documentation

map<std::string,std::vector<TransitionProxy> > blends

Referenced by ParseMonitorResults().

EmissionProxy DummyEmis

Todo:

2 bring these two together.

AddLine2Stack add generic emission line to GenericLines and return pointer to that state.

Referenced by TransitionProxy::Emis(), and InitDefaultsPreparse().