ionbal.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2013 by Gary J. Ferland and
 * others.  For conditions of distribution and use see copyright notice in license.txt */
 
#ifndef IONBAL_H_
#define IONBAL_H_
 
#include "dense.h"
 
bool lgOH_ChargeTransferDominant( void );
 
void ion_recom_calculate( void );
 
void ion_trim(
        long int nelem );
 
void ion_zero(long int nelem);
 
void ion_collis(
        long nelem);
 
void ion_solver(long int nelem, bool lgPrintIt);
 
#if 0
 
void ion_solver(long int nelem1, long int nelem2, bool lgPrintIt);
#endif
 
void ion_photo(
        long int nelem , 
        bool lgPrintIt );
 
void ion_CX(long nelem );
 
void ion_recomb(bool,long);
 
void ion_recombAGN( FILE * io );
 
void ion_wrapper( long nelem );
 
void Badnell_rec_init( void );
 
/* routines to do heavy element ionization balance */
void IonNelem(bool lgPrintIt, long int nelem);
void IonHelium( void );
 
#define NSHELLS 7
 
class t_ionbal 
{
public:
        double trimhi, 
 
          trimlo;
 
        bool lgTrimhiOn;
 
        /* ==============================================================
         * all following deals with ionization processes */
 
        double ****PhotoRate_Shell;
 
        bool lgPhotoIoniz_On;
 
        double ***CollIonRate_Ground;
 
        double CosRayIonRate;
 
        double CosRayHeatNeutralParticles;
 
        double CosRayHeatThermalElectrons;
 
        double ExtraHeatRate;
 
        double xNeutronHeatRate;
 
        double PairProducPhotoRate[3];
 
        /* ==============================================================
         * following deal with Compton recoil ionization of bound electrons */
 
        bool lgCompRecoil;
 
        double CompRecoilHeatLocal;
 
        long int **ipCompRecoil;
 
        double **CompRecoilIonRate;
 
        double **CompRecoilIonRateSave;
 
        double **CompRecoilHeatRate;
 
        double **CompRecoilHeatRateSave;
 
        double **UTA_ionize_rate;
        double **UTA_heat_rate;
 
        bool lgInnerShellLine_on;
        bool lgInnerShell_Kisielius;
        bool lgInnerShell_Gu06;
 
        double ***RateIoniz;
 
        long int nCompRecoilElec[LIMELM];
 
        double CompHeating_Max;
        /* ==============================================================
         * end Compton recoil ionization of bound electrons */
 
        /* ==============================================================
         * all following deals with recombination */
 
        double **RateRecomTot;
 
        double **RateRecomIso;
 
        double **RR_Badnell_rate_coef,
                **DR_Badnell_rate_coef,
                **CX_recomb_rate_used;
 
        bool lgRecom_Badnell_print;
 
        double **RR_rate_coef_used;
 
        double **RR_Verner_rate_coef;
 
        double DR_mean_scale[LIMELM];
 
        realnum **GrainCreat,
                **GrainDestr;
 
        int 
          lgGrainIonRecom;
 
        realnum guess_noise;
 
        bool lgSupDie[2];
 
        bool lgNoCota;
 
        realnum CotaRate[LIMELM];
 
        long int ilt, 
          iltln, 
          ilthn, 
          ihthn, 
          ifail;
 
        double elecsrc[LIMELM], elecsnk[LIMELM];
 
        // find the total ionization rate (including multiple-electron processes) 
        double RateIonizTot( long nelem, long ion )
        {
                double sum = 0.;
                
                for( long ion_to=ion+1; ion_to<=dense.IonHigh[nelem]; ion_to++ )
                        sum += RateIoniz[nelem][ion][ion_to];
 
                return sum;
        }
};
 
#if 0
double t_ionbal::RateIonizTot(long nelem, long ion)
{
        double sum = 0.;
        
        for( long ion_to=ion+1; ion_to<=dense.IonHigh[nelem]; ion_to++ )
                sum += t_ionbal::RateIoniz[nelem][ion][ion_to];
 
        return sum;
}
#endif 
 
extern t_ionbal ionbal;
 
#endif /* IONBAL_H_ */