/home66/gary/public_html/cloudy/c08_branch/source/iso.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2008 by Gary J. Ferland and
 * others.  For conditions of distribution and use see copyright notice in license.txt */

#ifndef _ISO_H_
#define _ISO_H_

EXTERN multi_arr<quantumState,3> StatesElem;

EXTERN long int max_num_levels;

#define HE1CSARRAY 10

#define KILL_BELOW_PLASMA(E_)           ( (rfield.lgPlasNu && ((E_)<rfield.plsfrq) ) ? 0.:1. )

#define NUM_DR_TEMPS    19

#define N_(A_)  (StatesElem[ipISO][nelem][A_].n)
#define L_(A_)  (StatesElem[ipISO][nelem][A_].l)
#define S_(A_)  (StatesElem[ipISO][nelem][A_].S)
#define J_(A_)  (StatesElem[ipISO][nelem][A_].j)

#define IPRAD   0
#define IPCOLLIS        1
/*define IPENERGY       2*/

/* following two macros used to define recombination coef arrays */
/* Max n desired in RRCoef file.        */
/* Hydrogen and helium atoms will have precompiled recombination coefficients up to these maximum n.    */
#define RREC_MAXN       40

#define LIKE_RREC_MAXN( A_ )            ( A_ == ipHELIUM ? 40 : 20 )

#define N_ISO_TE_RECOMB         41

#define SumUpToThisN    1000

#define RECOMBMAGIC             (80405)

void iso_cascade( long ipISO, long nelem );

void iso_collapsed_bnl_print( long ipISO, long nelem );

void iso_collapsed_bnl_set( long ipISO, long nelem );

void iso_collapsed_Aul_update( long ipISO, long nelem );

void iso_collapsed_lifetimes_update( long ipISO, long nelem );

void iso_collide( long ipISO, long nelem );

void iso_collisional_ionization( long ipISO, long nelem );

void iso_continuum_lower( long ipISO , long nelem );

void iso_cool( long ipISO , long nelem );

void iso_create( void );

double iso_dielec_recomb_rate( long ipISO, long nelem, long ipLo );

void iso_error_generation( long ipISO, long nelem );

long iso_get_total_num_levels( long ipISO, long nmaxResolved, long numCollapsed );

void iso_ionize_recombine( long ipISO , long nelem );

void iso_level( const long ipISO, const long nelem);

void iso_photo( long ipISO , long nelem );

void iso_prt_pops( long ipISO, long nelem, bool lgPrtDeparCoef );

void iso_put_error( long ipISO, long nelem, long ipHi, long ipLo, long whichData, realnum errorToPut );

void iso_radiative_recomb( long ipISO, long nelem );


void iso_radiative_recomb_effective( long ipISO, long nelem );

double iso_recomb_check( long ipISO, long nelem, long level, double temperature );

void iso_recomb_auxiliary_free( void );

void iso_recomb_malloc( void );

void iso_recomb_setup( long ipISO );

double iso_RRCoef_Te( long ipISO, long nelem , long n );

void iso_satellite_update( void );

void iso_solve( long ipISO );

void iso_suprathermal( long ipISO, long nelem );

void iso_update_num_levels( long ipISO, long nelem );

EXTERN struct t_iso 
{
        bool lgPrintNumberOfLevels;

        const char *chISO[NISO];

        multi_arr<realnum,4> strkar;
        multi_arr<double,4> pestrk;

        multi_arr<long,5> QuantumNumbers2Index;

        long int nLyman[NISO],
                nLyman_malloc[NISO];

        multi_arr<long int,3> ipIsoLevNIonCon;

        multi_arr<double,3> xIsoLevNIonRyd;

        double xIonSimple[NISO][LIMELM];

        bool lgColl_l_mixing[NISO];

        bool lgColl_excite[NISO];

        bool lgColl_ionize[NISO];

        bool lgPrtDepartCoef[NISO][LIMELM];

        bool lgPrtLevelPops[NISO][LIMELM];

        bool lgCollStrenThermAver;

        bool lgInd2nu_On;

        bool lgLevelsLowered[NISO][LIMELM];

        bool lgLevelsEverLowered[NISO][LIMELM];

        long int nCollapsed_max[NISO][LIMELM];
        long int nCollapsed_local[NISO][LIMELM];

        long int numLevels_max[NISO][LIMELM];

        long int numLevels_local[NISO][LIMELM];

        long int numLevels_malloc[NISO][LIMELM];

        long int n_HighestResolved_max[NISO][LIMELM];
        long int n_HighestResolved_local[NISO][LIMELM];

        long int numPrintLevels[NISO][LIMELM];

        realnum stat_ion[NISO];

        double TwoNu_induc_up[NISO][LIMELM];

        double TwoNu_induc_dn[NISO][LIMELM];

        double TwoNu_induc_dn_max[NISO][LIMELM];

        multi_arr<double,4> RadRecomb;

        bool lgDielRecom[NISO];

        multi_arr<double,3> DielecRecomb;

        multi_arr<double,4> DielecRecombVsTemp;

        realnum CaseBCheck[NISO][LIMELM];

        double RadRec_caseB[NISO][LIMELM];

        double RadRec_effec[NISO][LIMELM];

        multi_arr<double,3> RateLevel2Cont; 

        multi_arr<double,3> RateCont2Level; 

        double RecomCollisFrac[NISO][LIMELM];

        multi_arr<long int,3> ipOpac;

        multi_arr<realnum,3> ConOpacRatio;

        multi_arr<double,3> DepartCoef;

        bool lgPopLTE_OK[NISO][LIMELM];

        multi_arr<double,3> PopLTE;

        multi_arr<double,3> ColIoniz;

        double pop_ion_ov_neut[NISO][LIMELM];

        double FreeBnd_net_Cool_Rate[NISO][LIMELM];

        double coll_ion[NISO][LIMELM];

        double cRest_cool[NISO][LIMELM];

        double xLineTotCool[NISO][LIMELM];

        double dLTot[NISO][LIMELM];

        double RadRecCool[NISO][LIMELM];

        double cBal_cool[NISO][LIMELM];

        double cLyrest_cool[NISO][LIMELM];

        double cLya_cool[NISO][LIMELM];

        multi_arr<double,3> gamnc;

        multi_arr<double,3> RecomInducRate;

        multi_arr<double,3> RecomInducCool_Coef;

        double RecomInducCool_Rate[NISO][LIMELM];

        multi_arr<double,4> Boltzmann;

        multi_arr<double,3> PhotoHeat;

        realnum SmallA;

        multi_arr<long int,3> ipSym2nu;

        multi_arr<realnum,3> As2nu;

        long ipTwoPhoE[NISO][LIMELM];
        long ipHalfTwoPhoE[NISO][LIMELM];

        int ipLyaRedist[NISO] , ipResoRedist[NISO] , ipSubRedist[NISO];

        int nLyaLevel[NISO];

        char chTypeAtomSet[NISO][10];
        char chTypeAtomUsed[NISO][LIMELM][10];

        /***********************************************/
        /***********************************************/

        /*   everything below here was originally part */
        /*   of the former helike structure, now       */
        /*   generalized for iso                                           */
        /***********************************************/
        /***********************************************/

        long int nCS[NISO];

        bool lgCompileRecomb[NISO];

        bool lgNoRecombInterp[NISO];

        bool lgCS_Vriens[NISO] ,
                lgCS_None[NISO] ,
                lgCS_Vrinceanu[NISO],
                lgCS_therm_ave[NISO];
        int nCS_new[NISO];//vals are 0, 1, and 2

        bool lgCritDensLMix[NISO];

        bool lgFSM[NISO];

        multi_arr<double,3> SigmaAtot;
        
        multi_arr<realnum,5> HeCS;
        
        double CSTemp[NISO][HE1CSARRAY];

        bool lgRandErrGen[NISO];

        bool lgErrGenDone[NISO][LIMELM];

        bool lgTopoff[NISO];

        int modelRank[NISO];

        /* first dimension is iso,
         * second is nelem,
         * third is upper level,
         * fourth is lower level,
         * fifth is for radiative, collisional, or energy errors.
         * MACROS are used for the last dimension: IPRAD, IPCOLLIS, and IPENERGY. */
        multi_arr<realnum,5> Error;

        multi_arr<realnum,5> ErrorFactor;

        double qTot2S[NISO][LIMELM];

        multi_arr<double,4> BranchRatio, CascadeProb, SigmaCascadeProb;

        multi_arr<double,3> RadEffec, SigmaRadEffec;

        multi_arr<realnum,5> CachedAs;
        /* the departure coefficients of collapsed levels */
        multi_arr<double,5> bnl_effective;

} iso;

#endif /* _ISO_H_ */

---