atoms.h

Go to the documentation of this file.

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

#ifndef ATOMS_H_
#define ATOMS_H_

#include "container_classes.h"
#include "module.h"

class TransitionProxy;

void atom_level2( const TransitionProxy &t );
void atom_level2( const TransitionProxy &t, const bool lgHFS );

class setCollRate
{
        long nLevelAlloc;
        vector<double*> excit;
        vector<double> excit_b;
public:
   setCollRate() : nLevelAlloc(0) {}
   void resize(long int nlev)
        {
                if (nlev > nLevelAlloc)
                {
                        excit.resize(nlev);
                        excit_b.resize(0.5*nlev*(nlev-1));
                        size_t ibase = 0;
                        for (long ihi=1; ihi<nlev; ++ihi)
                        {
                                excit[ihi] = &excit_b[ibase];
                                ibase += ihi;
                        }
                        ASSERT(ibase == excit_b.size());
                        nLevelAlloc = nlev;
                }
        }
        void operator()(
                long nlev,
                double TeInverse,
                double **col_str,
                const double ex[],      
                const double g[], 
                double **CollRate
                );
};

class Atom_LevelN
{
        // these are all automatically deallocated when they go out of scope
        valarray<double> bvec;
        multi_arr<double,2,C_TYPE> amat;
public:
        Atom_LevelN() {}
        void operator()(
                long nLevelCalled,
                realnum abund, 
                const vector<double>& g, 
                const vector<double>& ex, 
                char chExUnits,
                vector<double>& pops, 
                vector<double>& depart,
                multi_arr<double,2>& AulEscp, 
                multi_arr<double,2>& AulDest, 
                multi_arr<double,2>& AulPump, 
                const multi_arr<double,2>& CollRate,
                const vector<double>& create,
                const vector<double>& destroy,
                double *cooltl, 
                double *coolder, 
                const char *chLabel, 
                bool lgPrtMatrix,
                bool lgImgMatrix,
                int *nNegPop,
                bool *lgZeroPop,
                bool lgDeBug,
                bool lgLTE=false,
                multi_arr<double,2> *Cool=NULL,
                multi_arr<double,2> *dCooldT=NULL,
                double *grnd_excit = NULL);
};


const long LIMLEVELN = 20L;

struct t_atoms : public module {

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

        realnum p2nit, d5200r;

        realnum xMg2Max,
                popMg2,
                rateMg2;

        double PopLevels[LIMLEVELN+1], 
          DepLTELevels[LIMLEVELN+1];

        };
extern t_atoms atoms;

#endif /* ATOMS_H_ */