/* 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 HEXTRA_H_
#define HEXTRA_H_

/* hextra.h */
/** galactic background energy density of 1.8 eV cm-3 is from
 *>>refer	cr	background	Webber, W.R. 1998, ApJ, 506, 329 */ 
#define	CR_EDEN_GAL_BACK_EV_CMM3	1.8

struct t_hextra {
	/** heat due to cosmic rays*/
	realnum cryden, 
	  crpowr, 
	  crtemp;

	/** true for cosmic rays in equipartition with magnetic field */
	bool lg_CR_B_equipartition;

	/** cosmic ray energy density erg cm-3 */
	double cr_energydensity;

	/** current cosmic ray density divided by default galactic background */
	realnum cryden_ov_background;

	/** default cosmic ray background density and rate */
	realnum background_density;
	realnum background_rate;

	/** extra heating set with hextra command, first the heating rate */
	realnum TurbHeat, 

	  /** save the initial value in case TurbHeat varies with time */
	  TurbHeatSave;

	/** options for heating to depth on depth, true is depth occurs on
	 * hextra command */
	bool lgHextraDepth;
	/** the scale radius for the heating */
	realnum turrad,
	  /** the scale radius from the back of the cloud */
	  turback;

	/** options for extra heating the depends on density, as set with 
	 * hextra command */
	bool lgHextraDensity;

	/** the scale density */
	realnum HextraScaleDensity;

  	/** options for extra heating is from SS model, as set with 
	 * hextra command */
	bool lgHextraSS;

	/** the parameter alpha of alpha model, dimensionless */
	realnum HextraSSalpha;

	/** mass of the black hole in grams */
	double HextraSS_M;

	/** radius from center in cm */
	realnum HextraSSradius;
  
	/** set true if extra heat varies with time in time dependent sims */
	bool lgTurbHeatVaryTime;

	/** totneu is neutron energy flux, erg cm-2 s-1	*/
	realnum totneu;
	/** flag lgNeutrnHeatOn says heating due to neutrons is enabled */
	bool lgNeutrnHeatOn;
	/** frcneu is fraction of total luminosity in neutrons, dimensionless */
	realnum frcneu;
	/** effneu is efficiency */
	realnum effneu;
	/** cross section for stopping relativistic neutrons */
	double CrsSecNeutron;

};
extern t_hextra hextra;

#endif /* HEXTRA_H_ */