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

#include <cddefines.h>

Public Member Functions

 t_wavl ()
 
 t_wavl (realnum w, wl_type t)
 
t_wavl operator- () const
 
realnum wavlVac () const
 
string sprt_wl (const char *format=NULL) const
 
void prt_wl (FILE *io, const char *format=NULL) const
 

Private Member Functions

realnum p_convertWvl () const
 
realnum p_wlAirVac () const
 
double p_RefIndex (double EnergyWN) const
 

Private Attributes

realnum p_wavl
 
wl_type p_type
 

Detailed Description

type for declaring a wavelength with the type (air or vacuum) attached the wavelength is stored as it was supplied, but can be converted to vacuum by wavlVac()

Constructor & Destructor Documentation

◆ t_wavl() [1/2]

t_wavl::t_wavl ( )
inline

References p_type, p_wavl, and WL_NATIVE.

Referenced by operator-().

◆ t_wavl() [2/2]

t_wavl::t_wavl ( realnum w,
wl_type t )
inline

References p_type, and p_wavl.

Member Function Documentation

◆ operator-()

t_wavl t_wavl::operator- ( ) const
inline

unary minus

References p_type, p_wavl, and t_wavl().

Here is the call graph for this function:

◆ p_convertWvl()

realnum t_wavl::p_convertWvl ( ) const
private

convert wavelength to vacuum, if needed

References p_type, p_wavl, p_wlAirVac(), prt, WL_AIR, and WL_NATIVE.

Referenced by wavlVac().

Here is the call graph for this function:

◆ p_RefIndex()

double t_wavl::p_RefIndex ( double EnergyWN) const
private

calculate the index of refraction for STP air using the line energy

Parameters
EnergyWN- line energy in wavenumbers (cm^-1)

References ASSERT, DEBUG_ENTRY, and pow2.

Referenced by p_wlAirVac(), and sprt_wl().

◆ p_wlAirVac()

realnum t_wavl::p_wlAirVac ( ) const
private

convert air wavelength to vacuum

References DEBUG_ENTRY, p_RefIndex(), p_wavl, and sign().

Referenced by p_convertWvl().

Here is the call graph for this function:

◆ prt_wl()

void t_wavl::prt_wl ( FILE * io,
const char * format = NULL ) const

write wavelength to output stream

References DEBUG_ENTRY, fprintf(), LineSave, NULL, and sprt_wl().

Referenced by ContBandsCreate(), iso_radiative_recomb_effective(), lgCheckMonitors(), prt_line_err(), prt_line_inlist(), PrtLinePres(), PrtOneMonitor(), Save1Line(), and Save1LineData().

Here is the call graph for this function:

◆ sprt_wl()

string t_wavl::sprt_wl ( const char * format = NULL) const

convert wavelength to string for user output, can be either air or vacuum this depends on whether the PRINT LINE VACUUM command is in effect

References DEBUG_ENTRY, LineSave, NULL, p_RefIndex(), prt, and wavlVac().

Referenced by TransitionProxy::chLabel(), t_LineSave::findline(), getTransition(), LinSv::label(), ParseTest(), and prt_wl().

Here is the call graph for this function:

◆ wavlVac()

realnum t_wavl::wavlVac ( ) const
inline

gives the vacuum wavelength of the line in angstrom

References p_convertWvl().

Referenced by findTrans_byWLAng(), iso_radiative_recomb_effective(), lgCheckMonitors(), LinSv::makeBlend(), ParseMonitorResults(), ParseSet(), and sprt_wl().

Here is the call graph for this function:

Member Data Documentation

◆ p_type

wl_type t_wavl::p_type
private

wavelength type: air, vacuum, or native

Referenced by operator-(), p_convertWvl(), t_wavl(), and t_wavl().

◆ p_wavl

realnum t_wavl::p_wavl
private

wavelength, in angstrom

Referenced by operator-(), p_convertWvl(), p_wlAirVac(), t_wavl(), and t_wavl().


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