hextra.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 HEXTRA_H_
#define HEXTRA_H_
 
/* hextra.h */
 
#include "module.h"
 
#define CR_EDEN_GAL_BACK_EV_CMM3        1.8
 
struct t_hextra : public module {
        const char *chName() const
        {
                return "hextra";
        }
        void zero();
        void comment(t_warnings&) {}

        realnum cryden, 
          crpowr, 
          crtemp;

        bool lg_CR_B_equipartition;

        double cr_energydensity;

        realnum cryden_ov_background;

        realnum background_density;
        realnum background_rate;

        realnum TurbHeat, 

          TurbHeatSave;

        bool lgHextraDepth;
        realnum turrad,
          turback;

        bool lgHextraDensity;

        realnum HextraScaleDensity;

        bool lgHextraSS;

        realnum HextraSSalpha;

        double HextraSS_M;

        realnum HextraSSradius;
  
        bool lgTurbHeatVaryTime;

        realnum totneu;
        bool lgNeutrnHeatOn;
        realnum frcneu;
        realnum effneu;
        double CrsSecNeutron;
 
        t_hextra()
        {
                /* default cosmic ray background */
                /* >>chng 99 jun 24, slight change to value
                 * quoted by 
                 * >>refer      cosmic ray      ionization rate McKee, C.M., 1999, astro-ph 9901370
                 * this will produce a total
                 * secondary ionization rate of 2.5e-17 s^-1, as tested in 
                 * test suite cosmicray.in.  If each ionization produces 2.4 eV of heat,
                 * the background heating rate should be 9.6e-29 * n*/
                /* >>chng 04 jan 26, update cosmic ray ionization rate for H0 to
                 * >>refer      cosmic ray      ionization      Williams, J.P., Bergin, E.A., Caselli, P., 
                 * >>refercon   Myers, P.C., & Plume, R. 1998, ApJ, 503, 689,
                 * H0 ionization rate of 2.5e-17 s-1 and a H2 ionization rate twice this
                 * >>chng 04 mar 15, comment said 2.5e-17 which is correct, but code produce 8e-17,
                 * fix back to correct value 
                 */
                /* NB - the rate is derived from the density.  these two are related by the secondary
                 * ionization efficiency problem.  background_rate is only here to provide the relationship
                 * for predominantly neutral gas.  the background_density is the real rate. 
                 hextra.background_density = 1.99e-9f;*/
                /* >>chng 05 apr 16, to get proper ionization rate in ism_set_cr_rate, where
                 * H is forced to be fully atomic, no molecules, density from 1.99 to 2.15 */
                /* >>chng 12 apr 05, update to
                 * >>refer      cosmic ray      ionization      Indriolo, N., Geballe, T., Oka, T., & McCall, B.J. 2007, ApJ, 671, 1736
                 */
                background_density = 2.15e-9f*7.9f;
                background_rate = 2.5e-17f*7.9f;
        }
};
extern t_hextra hextra;
 
#endif /* HEXTRA_H_ */