rt.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2025 by Gary J. Ferland and
 * others.  For conditions of distribution and use see copyright notice in license.txt */
 
#ifndef RT_H_
#define RT_H_
 
#include "module.h"
 
class TransitionProxy;
 
/* in following two the logical variable says whether to do the
 * escape probabilities too (true) or just the destruction probabilities (false) */

void RT_line_one_escape(const TransitionProxy& t, 
                 bool lgShield_this_zone,
                 realnum pestrk,
                 realnum DopplerWidth,
                 bool = true);
void RT_line_one_fine(const TransitionProxy& t, 
                 bool lgShield_this_zone,
                 realnum pestrk,
                 realnum DopplerWidth,
                 bool lgKeepLyman);
 
// Reset the fine opacity array and velocity shift
void RT_fine_clear();
 
typedef void (*linefunc)(const TransitionProxy& t, 
                                                                 bool lgShield_this_zone,
                                                                 realnum pestrk,
                                                                 realnum DopplerWidth,
                                                                 bool lgKeepLyman);

void RT_line_all( linefunc line_one, bool lgExcludeLyman = false );
 
void RT_line_all_escape( realnum* error ); 

double RT_line_driving(void);
 

double RT_continuum_shield_fcn( const TransitionProxy &t, 
                                                                                  bool lgShieldThisZone, double dTau );

void RT_diffuse(void);

void RT_continuum(void);

void RT_OTS(void);

void RT_OTS_AddLine(double ots, 
  long int ip );

void RT_OTS_Update(double* SumOTS);

void RT_OTS_Zero( void );

void RT_OTS_ChkSum(
        long int ipPnt);

void RT_line_one_tauinc(
        const TransitionProxy & t ,
        long int mas_species,
        long int mas_ion,
        long int mas_hi,
        long int mas_lo,
        realnum DopplerWidth);

void RT_tau_init(void);

class TransitionProxy;
void RT_line_one_tau_reset(
        const TransitionProxy & t );

void RT_tau_reset(void);

void RT_tau_inc(void);

void RT_OTS_PrtRate(
          double weak ,
          int chFlag );
 
 
#if 0
double RT_LyaWidth(
                         double tauin, 
                         double tauout, 
                         double a, 
                         double vth);
#endif

double RT_recom_effic(
        long int ip);

void RT_stark(void);

/* #define DEST0 1e-8 */
#define DEST0 SMALLFLOAT
 
struct t_rt : public module {
 
        const char *chName() const
        {
                return "rt";
        }
 
        void zero();
        void comment(t_warnings&) {}

        realnum wayin, 

          wayout; 

        realnum fracin;

        realnum DoubleTau;

        long int ipxry;

        realnum tauxry;

        bool lgFstOn;

        int nLineContShield;

        bool lgElecScatEscape;

        bool lgAbsorLineEscape;

        bool lgElecScatInten;

        realnum dTauMase;

        bool lgMaserSetDR;

        bool lgMaserCapHit;

        long int mas_species , mas_ion , mas_hi , mas_lo;

        bool lgStarkON;
 
};
 
extern t_rt rt;
 
double RT_EscLVG( double tau, double sigma );

enum
{
        LINE_CONT_SHIELD_PESC = 1,
        LINE_CONT_SHIELD_FEDERMAN,
        LINE_CONT_SHIELD_FEDERMAN_BUG,
        LINE_CONT_SHIELD_FERLAND,
        LINE_CONT_SHIELD_RODGERS,
        LINE_CONT_SHIELD_INTEGRAL
};
 
void prt_trans_opc_debug( const char *LineGroup, const TransitionProxy &t );
 
#endif /* RT_H_ */