ionbal.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2022 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 "module.h"
#include "container_classes.h"

class dense;

void ion_recom_calculate( void );

void ion_zero(long int nelem);

void ion_collis(
        long nelem);

void ion_solver(long int nelem, bool lgPrintIt);

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 );

static const int NSHELLS = 7;

class t_ionbal : public module
{
public:
        void alloc();

        const char* chName() const
        {
                return "ionbal";
        }
        void zero();
        void comment(t_warnings&);

        double trimhi, 

          trimlo;

        bool lgTrimhiOn;

        bool lgTrimloOn;

        bool lgNewTrim;
        
        /* ==============================================================
         * all following deals with ionization processes */

        multi_arr<double,4> PhotoRate_Shell;

        bool lgPhotoIoniz_On;

        multi_arr<double,3> CollIonRate_Ground;

        multi_arr<double,2> ExcitationGround;

        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;

        multi_arr<long,2> ipCompRecoil;

        multi_arr<double,2> CompRecoilIonRate;

        multi_arr<double,2> CompRecoilIonRateSave;

        multi_arr<double,2> CompRecoilHeatRate;

        multi_arr<double,2> CompRecoilHeatRateSave;

        multi_arr<double,2> UTA_ionize_rate;
        multi_arr<double,2> UTA_heat_rate;

        multi_arr<double,3> RateIoniz;

        long int nCompRecoilElec[LIMELM];

        double CompHeating_Max;
        /* ==============================================================
         * end Compton recoil ionization of bound electrons */

        /* ==============================================================
         * all following deals with recombination */

        multi_arr<double,2> RateRecomTot;

        multi_arr<double,2> RateRecomIso;

        multi_arr<double,2> RR_Badnell_rate_coef,
                DR_Badnell_rate_coef,
                CX_recomb_rate_used;

        multi_arr<double,2> DR_Badnell_suppress_fact;

        bool lgRecom_Badnell_print;

        multi_arr<double,2> RR_rate_coef_used;

        multi_arr<double,2> RR_Verner_rate_coef;

        double DR_mean_scale[LIMELM];

        int 
          lgGrainIonRecom;

        realnum guess_noise;

        bool lgDRsup;

        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 ) const;

        t_ionbal()
        {
                /* number of electrons in valence shell that can Compton recoil ionize */
                static const long int nCom[LIMELM] = {
                        1 , 2 ,                            /* K 1s shell */
                        1 , 2 ,                            /* L 2s shell */
                        1 , 2 , 3 , 4 , 5 , 6 ,            /* L 2p shell */
                        1 , 2 ,                            /* M 3s shell */
                        1 , 2 , 3 , 4 , 5 , 6 ,            /* M 3p shell */
                        1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 ,    /* M 3d shell */
                        1 , 2 ,                            /* N 4s shell */
                        1 , 2                              /* N 4p shell */
                };

                for( int nelem=ipHYDROGEN; nelem < LIMELM; ++nelem )
                {
                        nCompRecoilElec[nelem] = nCom[nelem];
                }
        }
};

extern t_ionbal ionbal;

#endif /* IONBAL_H_ */