eos_chemistry_simple

Module

Description

$Id$

Equation of state for an ideal gas without ionization.

** AUTOMATIC CPARAM.INC GENERATION ************************ Declare (for generation of cparam.inc) the number of f array variables and auxiliary variables added by this module

CPARAM logical, parameter :: leos = .true., leos_ionization=.false., leos_temperature_ionization=.false. CPARAM logical, parameter :: leos_idealgas = .false., leos_chemistry = .true.

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

PENCILS PROVIDED lnTT; glnTT(3); TT; TT1; gTT(3) PENCILS PROVIDED mu1; pp; del2pp; glnmu(3) PENCILS PROVIDED rho1gpp(3); glnpp(3); del2lnTT PENCILS PROVIDED glnRR(3), RRmix

PENCILS PROVIDED hss(3,3); hlnTT(3,3); del2ss; del6ss; del6lnTT PENCILS PROVIDED yH; ee; ss; delta; glnmumol(3); ppvap; csvap2; cs2 PENCILS PROVIDED cp1tilde; cp; gamma; gamma_m1 PENCILS PROVIDED rho_anel; gradcp(3)

Quick access

Variables:

b_ext_eos, bc_lnrho_hdss_z_liso, calc_pencils_eos, calc_pencils_eos_pencpar, calc_pencils_eos_std, chih_ev, chihminus_ev, cp_const, cpdry, cpdry1, cs0, cs20, cs20_tdep_rate, cs2_tdep_ascale_power, cs2bot, cs2top, cvdry, cvdry1, dlnrho0dz, ee_ion, enum_tdep_cs2_type, eos_before_boundary, eos_update_aux, eoscalc, eoscalc_elem, eoscalc_farray, eoscalc_farray_range, eoscalc_pencil, eoscalc_point, eoscalc_point_f, eosperturb, error_cp, fac_cs, find_mass, get_average_pressure, get_cp, get_cv, get_soundspeed, get_ss, get_ss_pencil, get_stratz, getmu, gz_coeff, gztype, ics, icv, idelta, ieosvar1, ieosvar2, ieosvar_count, ieosvars, ifvap, iglobal_cs2, iglobal_glntt, imumol1, inabad, init_eos, input_file, ioncalc, ioninit, isothermal_lnrho_ss, isothmid, ivars_mod, kappa0, kappa_cst, l_cp, l_gamma, l_gamma_m1, lcalc_cp, lcalc_cp_full, lcheminp_eos, lconst_yh, lcp_as_aux, lcs2_tdep, lcs_as_aux, lcs_as_comaux, lcv_as_aux, ldelta_as_aux, leos_isentropic, leos_isobaric, leos_isochoric, leos_isothermal, leos_localisothermal, lgamma_as_aux, lhminus_opacity_correction, lhubble_eos, linterp_pressure, ll1, ll2, lnabad_as_aux, lnpp_bot, lnrho0, lnrho_e, lnrho_e_, lnrho_h, lnrho_he, lnrho_p, lntt_ion, lntt_ion_, lnttlnrho, lnttss, lpp_as_aux, lpres_grad, lrevise_chih_ev, lrevise_chihminus_ev, lss_as_aux, lstratset, mm1, mm2, mu1_0, mu1_full, mu1yhxhe, mudry, mudry1, muvap, muvap1, nabla_ad, nn1, nn2, one_yh_term, opacity_type, pp0, pp_ion, pr_number, pres_corr, pressure_gradient, pressure_gradient_farray, pressure_gradient_point, read_species, read_thermodyn, rgas_cgs, rho0, rho02, rho_e, rho_e_, rho_h, rho_he, rtsafe, rtsafe_pencil, saha, scale_rgas, set_stratz, sigmasbt, srad0, ss_ion, ss_ion1, tau_relax, tdep_cs2_type, temperature_gradient, temperature_hessian, temperature_laplacian, tt_ion, tt_ion_, va2max_eos, va2power_eos, write_thermodyn, xh2, xhe, xhe_term, xtop, yh0, yh_const, yh_term, yhacc, yhmax, yhmin, ymetals

Routines:

bc_ism(), bc_lnrho_hds_z_iso(), bc_lnrho_pressure_z(), bc_lnrho_temp_z(), bc_ss_a2stemp_x(), bc_ss_a2stemp_y(), bc_ss_a2stemp_z(), bc_ss_energy(), bc_ss_flux(), bc_ss_flux_condturb_mean_x(), bc_ss_flux_condturb_x(), bc_ss_flux_condturb_z(), bc_ss_flux_turb(), bc_ss_flux_turb_x(), bc_ss_stemp_x(), bc_ss_stemp_y(), bc_ss_stemp_z(), bc_ss_temp2_z(), bc_ss_temp3_z(), bc_ss_temp_old(), bc_ss_temp_x(), bc_ss_temp_y(), bc_ss_temp_z(), bc_stellar_surface(), eos_before_boundary(), get_average_pressure(), get_gamma_etc(), get_slices_eos(), get_soundspeed(), get_stratz(), getdensity(), getmu(), getpressure(), gettemperature(), init_eos(), initialize_eos(), ioncalc(), isothermal_entropy(), isothermal_lnrho_ss(), pencil_criteria_eos(), pencil_interdep_eos(), read_eos_init_pars(), read_eos_run_pars(), register_eos(), rprint_eos(), select_eos_variable(), temperature_gradient(), temperature_hessian(), temperature_laplacian(), units_eos(), write_eos_init_pars(), write_eos_run_pars()

Needed modules

Variables

  • equationofstate/calc_pencils_eos [public]
  • equationofstate/calc_pencils_eos_pencpar [private]
  • equationofstate/calc_pencils_eos_std [private]
  • equationofstate/cp [real,private/optional/default=impossible]
  • equationofstate/cp_const [real,public/optional/default=impossible]
  • equationofstate/cs0 [real,public/optional/default=1.0]
  • equationofstate/cs20 [real,public/optional/default=1.0]
  • equationofstate/cs2bot [real,public/optional/default=1.0]
  • equationofstate/cs2top [real,public/optional/default=1.0]
  • equationofstate/eos_before_boundary [public]
  • equationofstate/eoscalc [public]
  • equationofstate/error_cp [real,private/optional/default=1e-06]
  • equationofstate/gamma [real,private/optional/default=impossible]
  • equationofstate/get_average_pressure [public]
  • equationofstate/get_soundspeed [public]
  • equationofstate/get_stratz [public]
  • equationofstate/ieosvar1 [integer,private/optional/default=-1]
  • equationofstate/ieosvar2 [integer,private/optional/default=-1]
  • equationofstate/ieosvar_count [integer,private/optional/default=0]
  • equationofstate/ieosvars [integer,private/optional/default=-1]
  • equationofstate/iglobal_cs2 [integer,private]
  • equationofstate/iglobal_glntt [integer,private]
  • equationofstate/ilnrho_cs2 [integer,parameter=5]
  • equationofstate/ilnrho_ee [integer,parameter=2]
  • equationofstate/ilnrho_eth [integer,parameter=14]
  • equationofstate/ilnrho_lntt [integer,parameter=4]
  • equationofstate/ilnrho_pp [integer,parameter=3]
  • equationofstate/ilnrho_ss [integer,parameter=1]
  • equationofstate/ilnrho_tt [integer,parameter=9]
  • equationofstate/imass [integer,public/optional/default=1]
  • equationofstate/init_eos [public]
  • equationofstate/input_file [character,private]
  • equationofstate/ioncalc [public]
  • equationofstate/ipp_cs2 [integer,parameter=12]
  • equationofstate/ipp_ss [integer,parameter=11]
  • equationofstate/irho_cs2 [integer,parameter=6]
  • equationofstate/irho_ee [integer,parameter=15]
  • equationofstate/irho_eth [integer,parameter=13]
  • equationofstate/irho_lntt [integer,parameter=8]
  • equationofstate/irho_pp [integer,parameter=16]
  • equationofstate/irho_ss [integer,parameter=7]
  • equationofstate/irho_tt [integer,parameter=10]
  • equationofstate/isothermal_lnrho_ss [public]
  • equationofstate/lcheminp_eos [logical,private/optional/default=.false.]
  • equationofstate/leos_isentropic [logical,private/optional/default=.false.]
  • equationofstate/leos_isobaric [logical,private/optional/default=.false.]
  • equationofstate/leos_isochoric [logical,private/optional/default=.false.]
  • equationofstate/leos_isothermal [logical,private/optional/default=.false.]
  • equationofstate/leos_localisothermal [logical,private/optional/default=.false.]
  • equationofstate/linterp_pressure [logical,private/optional/default=.false.]
  • equationofstate/ll1 [integer,private]
  • equationofstate/ll2 [integer,private]
  • equationofstate/lnrho0 [real,public/optional/default=0.0]
  • equationofstate/lntt0 [real,public/optional/default=impossible]
  • equationofstate/lpres_grad [logical,public/optional/default=.false.]
  • equationofstate/mm1 [integer,private]
  • equationofstate/mm2 [integer,private]
  • equationofstate/mu [real,private/optional/default=1.0]
  • equationofstate/nn1 [integer,private]
  • equationofstate/nn2 [integer,private]
  • equationofstate/pr_number [real,public/optional/default=0.7]
  • equationofstate/pressure_gradient [public]
  • equationofstate/rgas [real,private]
  • equationofstate/rgas_cgs [real,private/optional/default=0.0]
  • equationofstate/rgas_unit_sys [real,private/optional/default=1.0]
  • equationofstate/rho0 [real,public/optional/default=1.0]
  • equationofstate/scale_rgas [real,private/optional/default=1.0]
  • equationofstate/species_constants (*,*) [real,private/pointer]
  • equationofstate/temperature_gradient [public]
  • equationofstate/temperature_hessian [public]
  • equationofstate/temperature_laplacian [public]
  • equationofstate/tt0 [real,private/optional/default=impossible]

Subroutines and functions

subroutine  equationofstate/register_eos()

14-jun-03/axel: adapted from register_eos

Use :

farraymanager, sharedvariables (put_shared_variable())

Call to:

svn_id(), fatal_error(), warning(), not_implemented()

subroutine  equationofstate/units_eos()

This routine calculates things related to units and must be called before the rest of the units are being calculated.

22-jun-06/axel: adapted from initialize_eos 16-mar-10/Natalia

Call to:

fatal_error(), warning(), not_implemented()

subroutine  equationofstate/initialize_eos(f)

Initialize variable selection code (needed for RELOADing)

Parameters:

f (mx,my,mz,mfarray) [real]

Use :

sharedvariables (get_shared_variable())

Call to:

warning(), fatal_error(), not_implemented()

subroutine  equationofstate/select_eos_variable(variable, findex)

Select eos variable

02-apr-06/tony: implemented

Parameters:

  • variable [character,in]

  • findex [integer,in]

Use :

farraymanager, general (itoa())

Call to:

fatal_error(), not_implemented(), warning()

subroutine  equationofstate/getmu([f[, mu_tmp]])

Calculate average particle mass in the gas relative to

12-aug-03/tony: implemented 23 may-10/nils: fleshed it up

Parameters:
Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/rprint_eos(lreset[, lwrite])
Parameters:

  • lreset [logical]

  • lwrite [logical]

Call to:

fatal_error(), not_implemented(), warning()

subroutine  equationofstate/get_slices_eos(f, slices)

Write slices for animation of Eos variables.

26-jul-06/tony: coded

Parameters:
Use :

slices_methods (assign_slices_scal())

Call to:

fatal_error(), not_implemented(), warning()

subroutine  equationofstate/pencil_criteria_eos()

All pencils that the EquationOfState module depends on are specified here.

02-04-06/tony: coded

EOS is a pencil provider but evolves nothing so it is unlokely that it will require any pencils for it’s own use.

Call to:

fatal_error(), not_implemented(), warning()

subroutine  equationofstate/pencil_interdep_eos(lpencil_in)

Interdependency among pencils from the Entropy module is specified here.

Parameters:

lpencil_in (npencils) [logical]

Call to:

fatal_error(), not_implemented(), warning()

subroutine  equationofstate/read_eos_init_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/write_eos_init_pars(unit)
Parameters:

unit [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/read_eos_run_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/write_eos_run_pars(unit)
Parameters:

unit [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/isothermal_entropy(lnrho, t0, ss)
Parameters:

  • lnrho (mx,my,mz) [real,in]

  • t0 [real,in]

  • ss (mx,my,mz) [real,out]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux(f, topbot[, lone_sided])

constant flux boundary condition for entropy (called when bcz=’c1’)

23-jan-2002/wolf: coded 11-jun-2002/axel: moved into the entropy module

8-jul-2002/axel: split old bc_ss into two

26-aug-2003/tony: distributed across ionization modules

3-oct-16/MR: added new optional switch lone_sided

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

  • lone_sided [logical]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux_turb(f, topbot)

dummy routine

4-may-2009/axel: dummy routine

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux_turb_x(f, topbot)

dummy routine

31-may-2010/pete: dummy routine

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux_condturb_x(f, topbot)

23-apr-2014/pete: dummy

Parameters:
Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux_condturb_mean_x(f, topbot)

07-jan-2015/pete: dummy

Parameters:
Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_flux_condturb_z(f, topbot)

15-jul-2014/pete: dummy

Parameters:
Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp_old(f, topbot)

boundary condition for entropy: constant temperature

23-jan-2002/wolf: coded 11-jun-2002/axel: moved into the entropy module

8-jul-2002/axel: split old bc_ss into two

23-jun-2003/tony: implemented for leos_fixed_ionization 26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp_x(f, topbot)

boundary condition for entropy: constant temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp_y(f, topbot)

boundary condition for entropy: constant temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp_z(f, topbot[, lone_sided])

boundary condition for entropy: constant temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

  • lone_sided [logical]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_lnrho_temp_z(f, topbot)

boundary condition for lnrho and ss: constant temperature

27-sep-2002/axel: coded 19-aug-2005/tobi: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_lnrho_pressure_z(f, topbot)

boundary condition for lnrho: constant pressure

4-apr-2003/axel: coded 1-may-2003/axel: added the same for top boundary

19-aug-2005/tobi: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp2_z(f, topbot)

boundary condition for entropy: constant temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_temp3_z(f, topbot)

31-jan-2013/axel: coded to impose cs2bot and dcs2bot at bottom

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

not_implemented(), fatal_error(), warning()

subroutine  equationofstate/bc_ss_stemp_x(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_stemp_y(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_stemp_z(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_a2stemp_x(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_a2stemp_y(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_a2stemp_z(f, topbot)

boundary condition for entropy: symmetric temperature

3-aug-2002/wolf: coded

26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ss_energy(f, topbot)

boundary condition for entropy

may-2002/nils: coded 11-jul-2002/nils: moved into the entropy module 26-aug-2003/tony: distributed across ionization modules

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_stellar_surface(f, topbot)
Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_lnrho_cfb_r_iso(f, topbot)

Boundary condition for radial centrifugal balance

21-aug-2006/wlad: coded

Parameters:

  • f (,,*,*) [real,inout]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_lnrho_hds_z_iso(f, topbot)

Boundary condition for density and entropy.

12-Juil-2006/dintrans: coded

Parameters:

  • f (,,*,*) [real,inout]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_lnrho_hdss_z_iso(f, topbot)

Smooth out density perturbations with respect to hydrostatic stratification in Fourier space. 05-jul-07/tobi: Adapted from bc_aa_pot3

Parameters:

  • f (,,*,*) [real,inout]

  • topbot [integer,in]

Call to:

fatal_error(), warning()

subroutine  equationofstate/bc_ism(f, topbot, j)

30-nov-15/fred: Replaced bc_ctz and bc_cdz. Apply observed scale height locally from Reynolds 1991, Manchester & Taylor 1981 for warm ionized gas - dominant scale height above 500 parsecs. Apply constant local temperature across boundary for entropy. Motivation to prevent numerical spikes in shock fronts, which cannot be absorbed in only three ghost cells, but boundary thermodynamics still responsive to interior dynamics. 06-jun-22/fred update to allow setting scale height in start.in or run.in default is density_scale_factor=impossible so that scale_factor is 0.9, assuming unit_length = 1 kpc and scale is 400 pc. To change scale height add to start_pars or run_pars density_scale_factor=… in dimensionless units Copied from eos_ionization written for entropy - may need revision Currently not correct for energy variable

Parameters:

  • f (,,*,*) [real]

  • topbot [integer,in]

  • j [integer]

Call to:

fatal_error(), warning()

subroutine  equationofstate/get_gamma_etc([gamma[, cp[, cv[, f]]]])
Parameters:

  • gamma [real,out,]

  • cp [real,out,]

  • cv [real,out,]

  • f (mfarray) [real,in,]

Call to:

warning()

subroutine  equationofstate/pushpars2c(p_par)
Parameters:

p_par (100) [integer]

Use :

syscalls (copy_addr()), general (string_to_enum())