MPI-AMRVAC  3.1
The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)
Data Types | Functions/Subroutines | Variables
mod_ffhd_phys Module Reference

Frozen-field hydrodynamics module. More...

Functions/Subroutines

subroutine ffhd_write_info (fh)
 Write this module's parameters to a snapsoht. More...
 
subroutine, public ffhd_phys_init ()
 
subroutine ffhd_te_images
 
subroutine ffhd_sts_set_source_tc_ffhd (ixIL, ixOL, w, x, wres, fix_conserve_at_step, my_dt, igrid, nflux)
 
double precision function ffhd_get_tc_dt_ffhd (w, ixIL, ixOL, dxD, x)
 
subroutine ffhd_tc_handle_small_e (w, x, ixIL, ixOL, step)
 
subroutine tc_params_read_ffhd (fl)
 
subroutine rc_params_read (fl)
 
subroutine ffhd_check_params
 
subroutine ffhd_physical_units ()
 
subroutine ffhd_check_w_origin (primitive, ixIL, ixOL, w, flag)
 
subroutine ffhd_to_conserved_origin (ixIL, ixOL, w, x)
 
subroutine ffhd_to_primitive_origin (ixIL, ixOL, w, x)
 
subroutine, public ffhd_ei_to_e (ixIL, ixOL, w, x)
 
subroutine, public ffhd_e_to_ei (ixIL, ixOL, w, x)
 
subroutine ffhd_handle_small_values_origin (primitive, w, x, ixIL, ixOL, subname)
 
subroutine ffhd_get_v_origin (w, x, ixIL, ixOL, v)
 
subroutine, public ffhd_get_v_idim (w, x, ixIL, ixOL, idim, v)
 
subroutine ffhd_get_cmax_origin (w, x, ixIL, ixOL, idim, cmax)
 
subroutine ffhd_get_cs2max (w, x, ixIL, ixOL, cs2max)
 
subroutine ffhd_get_a2max (w, x, ixIL, ixOL, a2max)
 
subroutine ffhd_get_tcutoff (ixIL, ixOL, w, x, Tco_local, Tmax_local)
 
subroutine ffhd_get_cbounds (wLC, wRC, wLp, wRp, x, ixIL, ixOL, idim, Hspeed, cmax, cmin)
 
subroutine ffhd_get_csound (w, x, ixIL, ixOL, idim, csound)
 
subroutine ffhd_get_csound_prim (w, x, ixIL, ixOL, idim, csound)
 Calculate fast magnetosonic wave speed. More...
 
subroutine ffhd_get_pthermal_iso (w, x, ixIL, ixOL, pth)
 
subroutine ffhd_get_pthermal_origin (w, x, ixIL, ixOL, pth)
 
subroutine ffhd_get_temperature_from_te (w, x, ixIL, ixOL, res)
 
subroutine ffhd_get_temperature_from_eint (w, x, ixIL, ixOL, res)
 
subroutine ffhd_get_temperature_from_etot (w, x, ixIL, ixOL, res)
 
subroutine, public ffhd_get_csound2 (w, x, ixIL, ixOL, csound2)
 
subroutine ffhd_get_flux (wC, w, x, ixIL, ixOL, idim, f)
 
subroutine ffhd_add_source (qdt, dtfactor, ixIL, ixOL, wCT, wCTprim, w, x, qsourcesplit, active)
 
subroutine add_punitb (qdt, ixIL, ixOL, wCT, w, x, wCTprim)
 
subroutine, public ffhd_get_rho (w, x, ixIL, ixOL, rho)
 
subroutine ffhd_handle_small_ei (w, x, ixIL, ixOL, ie, subname)
 
subroutine ffhd_update_temperature (ixIL, ixOL, wCT, w, x)
 
subroutine ffhd_get_dt (w, ixIL, ixOL, dtnew, dxD, x)
 
double precision function, dimension(ixo^s) ffhd_kin_en_origin (w, ixIL, ixOL, inv_rho)
 
subroutine rfactor_from_temperature_ionization (w, x, ixIL, ixOL, Rfactor)
 
subroutine rfactor_from_constant_ionization (w, x, ixIL, ixOL, Rfactor)
 
subroutine get_tau (ixIL, ixOL, w, Te, tau, sigT5)
 
subroutine add_hypertc_source (qdt, ixIL, ixOL, wCT, w, x, wCTprim)
 

Variables

logical, public, protected ffhd_energy = .true.
 Whether an energy equation is used. More...
 
logical, public, protected ffhd_thermal_conduction = .false.
 Whether thermal conduction is used. More...
 
logical, public, protected ffhd_hyperbolic_thermal_conduction = .false.
 Whether hyperbolic type thermal conduction is used. More...
 
type(tc_fluid), allocatable, public tc_fl
 type of fluid for thermal conduction More...
 
type(te_fluid), allocatable, public te_fl_ffhd
 type of fluid for thermal emission synthesis More...
 
logical, public, protected ffhd_radiative_cooling = .false.
 Whether radiative cooling is added. More...
 
type(rc_fluid), allocatable, public rc_fl
 type of fluid for radiative cooling More...
 
logical, public, protected ffhd_viscosity = .false.
 Whether viscosity is added. More...
 
logical, public, protected ffhd_gravity = .false.
 Whether gravity is added. More...
 
logical, public, protected ffhd_trac = .false.
 Whether TRAC method is used. More...
 
integer, public, protected ffhd_trac_type =1
 Which TRAC method is used. More...
 
double precision, public, protected ffhd_trac_mask = 0.d0
 Height of the mask used in the TRAC method. More...
 
integer, public, protected ffhd_trac_finegrid =4
 Distance between two adjacent traced magnetic field lines (in finest cell size) More...
 
logical, public, protected ffhd_partial_ionization = .false.
 Whether plasma is partially ionized. More...
 
integer, public, protected rho_
 Index of the density (in the w array) More...
 
integer, dimension(:), allocatable, public, protected mom
 Indices of the momentum density. More...
 
integer, public, protected e_
 Index of the energy density (-1 if not present) More...
 
integer, public, protected p_
 Index of the gas pressure (-1 if not present) should equal e_. More...
 
integer, public, protected te_
 Indices of temperature. More...
 
integer, public, protected tcoff_
 Index of the cutoff temperature for the TRAC method. More...
 
integer, public, protected tweight_
 
integer, public, protected q_
 
double precision, public ffhd_gamma = 5.d0/3.0d0
 The adiabatic index. More...
 
double precision, public ffhd_adiab = 1.0d0
 The adiabatic constant. More...
 
double precision, public hypertc_kappa
 The thermal conductivity kappa in hyperbolic thermal conduction. More...
 
double precision, public, protected he_abundance =0.1d0
 Helium abundance over Hydrogen. More...
 
double precision, public, protected h_ion_fr =1d0
 Ionization fraction of H H_ion_fr = H+/(H+ + H) More...
 
double precision, public, protected he_ion_fr =1d0
 Ionization fraction of He He_ion_fr = (He2+ + He+)/(He2+ + He+ + He) More...
 
double precision, public, protected he_ion_fr2 =1d0
 Ratio of number He2+ / number He+ + He2+ He_ion_fr2 = He2+/(He2+ + He+) More...
 
double precision, public, protected rr =1d0
 
logical, public, protected eq_state_units = .true.
 
procedure(sub_convert), pointer, public ffhd_to_primitive => null()
 
procedure(sub_convert), pointer, public ffhd_to_conserved => null()
 
procedure(sub_get_pthermal), pointer, public ffhd_get_pthermal => null()
 
procedure(sub_get_pthermal), pointer, public ffhd_get_temperature => null()
 
procedure(sub_get_v), pointer, public ffhd_get_v => null()
 
procedure(fun_kin_en), pointer, public ffhd_kin_en => null()
 

Detailed Description

Frozen-field hydrodynamics module.

Function/Subroutine Documentation

◆ add_hypertc_source()

subroutine mod_ffhd_phys::add_hypertc_source ( double precision, intent(in)  qdt,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(in)  wCT,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
double precision, dimension(ixi^s,1:nw), intent(in)  wCTprim 
)

Definition at line 1547 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ add_punitb()

subroutine mod_ffhd_phys::add_punitb ( double precision, intent(in)  qdt,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(in)  wCT,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
double precision, dimension(ixi^s,1:nw), intent(in)  wCTprim 
)

Definition at line 1265 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_add_source()

subroutine mod_ffhd_phys::ffhd_add_source ( double precision, intent(in)  qdt,
double precision, intent(in)  dtfactor,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(in)  wCT,
double precision, dimension(ixi^s,1:nw), intent(in)  wCTprim,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
logical, intent(in)  qsourcesplit,
logical, intent(inout)  active 
)

Definition at line 1221 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_check_params()

subroutine mod_ffhd_phys::ffhd_check_params

Definition at line 573 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_check_w_origin()

subroutine mod_ffhd_phys::ffhd_check_w_origin ( logical, intent(in)  primitive,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,nw), intent(in)  w,
logical, dimension(ixi^s,1:nw), intent(inout)  flag 
)

Definition at line 643 of file mod_ffhd_phys.t.

◆ ffhd_e_to_ei()

subroutine, public mod_ffhd_phys::ffhd_e_to_ei ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s, nw), intent(inout)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x 
)

Definition at line 705 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_ei_to_e()

subroutine, public mod_ffhd_phys::ffhd_ei_to_e ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s, nw), intent(inout)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x 
)

Definition at line 696 of file mod_ffhd_phys.t.

◆ ffhd_get_a2max()

subroutine mod_ffhd_phys::ffhd_get_a2max ( double precision, dimension(ixi^s, nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ndim), intent(inout)  a2max 
)

4th order

Definition at line 820 of file mod_ffhd_phys.t.

◆ ffhd_get_cbounds()

subroutine mod_ffhd_phys::ffhd_get_cbounds ( double precision, dimension(ixi^s, nw), intent(in)  wLC,
double precision, dimension(ixi^s, nw), intent(in)  wRC,
double precision, dimension(ixi^s, nw), intent(in)  wLp,
double precision, dimension(ixi^s, nw), intent(in)  wRp,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s,1:number_species), intent(in)  Hspeed,
double precision, dimension(ixi^s,1:number_species), intent(inout)  cmax,
double precision, dimension(ixi^s,1:number_species), intent(inout), optional  cmin 
)

Definition at line 997 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_cmax_origin()

subroutine mod_ffhd_phys::ffhd_get_cmax_origin ( double precision, dimension(ixi^s, nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s), intent(inout)  cmax 
)

Definition at line 796 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_cs2max()

subroutine mod_ffhd_phys::ffhd_get_cs2max ( double precision, dimension(ixi^s, nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, intent(inout)  cs2max 
)

Definition at line 809 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_csound()

subroutine mod_ffhd_phys::ffhd_get_csound ( double precision, dimension(ixi^s, nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s), intent(out)  csound 
)

Definition at line 1058 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_csound2()

subroutine, public mod_ffhd_phys::ffhd_get_csound2 ( double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  csound2 
)

Definition at line 1168 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_csound_prim()

subroutine mod_ffhd_phys::ffhd_get_csound_prim ( double precision, dimension(ixi^s, nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s), intent(out)  csound 
)

Calculate fast magnetosonic wave speed.

Definition at line 1069 of file mod_ffhd_phys.t.

◆ ffhd_get_dt()

subroutine mod_ffhd_phys::ffhd_get_dt ( double precision, dimension(ixi^s,1:nw), intent(in)  w,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, intent(inout)  dtnew,
double precision, intent(in)  dx,
double precision, intent(in)  D,
double precision, dimension(ixi^s,1:ndim), intent(in)  x 
)

Definition at line 1340 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_flux()

subroutine mod_ffhd_phys::ffhd_get_flux ( double precision, dimension(ixi^s,nw), intent(in)  wC,
double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s,nwflux), intent(out)  f 
)

Definition at line 1185 of file mod_ffhd_phys.t.

◆ ffhd_get_pthermal_iso()

subroutine mod_ffhd_phys::ffhd_get_pthermal_iso ( double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  pth 
)

Definition at line 1084 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_pthermal_origin()

subroutine mod_ffhd_phys::ffhd_get_pthermal_origin ( double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  pth 
)

Definition at line 1096 of file mod_ffhd_phys.t.

◆ ffhd_get_rho()

subroutine, public mod_ffhd_phys::ffhd_get_rho ( double precision, dimension(ixi^s,1:nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  rho 
)

Definition at line 1289 of file mod_ffhd_phys.t.

◆ ffhd_get_tc_dt_ffhd()

double precision function mod_ffhd_phys::ffhd_get_tc_dt_ffhd ( double precision, dimension(ixi^s,1:nw), intent(in)  w,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, intent(in)  dx,
double precision, intent(in)  D,
double precision, dimension(ixi^s,1:ndim), intent(in)  x 
)

Definition at line 460 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_tcutoff()

subroutine mod_ffhd_phys::ffhd_get_tcutoff ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
double precision, intent(out)  Tco_local,
double precision, intent(out)  Tmax_local 
)

test case, fixed cutoff temperature

iijima et al. 2021, LTRAC method

test case, fixed cutoff temperature

assume cgs units

iijima et al. 2021, LTRAC method

do nothing here

Definition at line 841 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_temperature_from_eint()

subroutine mod_ffhd_phys::ffhd_get_temperature_from_eint ( double precision, dimension(ixi^s, 1:nw), intent(in)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  res 
)

Definition at line 1142 of file mod_ffhd_phys.t.

◆ ffhd_get_temperature_from_etot()

subroutine mod_ffhd_phys::ffhd_get_temperature_from_etot ( double precision, dimension(ixi^s, 1:nw), intent(in)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  res 
)

Definition at line 1154 of file mod_ffhd_phys.t.

◆ ffhd_get_temperature_from_te()

subroutine mod_ffhd_phys::ffhd_get_temperature_from_te ( double precision, dimension(ixi^s, 1:nw), intent(in)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  res 
)

Definition at line 1132 of file mod_ffhd_phys.t.

◆ ffhd_get_v_idim()

subroutine, public mod_ffhd_phys::ffhd_get_v_idim ( double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim,
double precision, dimension(ixi^s), intent(out)  v 
)

Definition at line 785 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_get_v_origin()

subroutine mod_ffhd_phys::ffhd_get_v_origin ( double precision, dimension(ixi^s,nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,ndir), intent(out)  v 
)

Definition at line 770 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_handle_small_ei()

subroutine mod_ffhd_phys::ffhd_handle_small_ei ( double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  ie,
character(len=*), intent(in)  subname 
)

Definition at line 1298 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_handle_small_values_origin()

subroutine mod_ffhd_phys::ffhd_handle_small_values_origin ( logical, intent(in)  primitive,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
character(len=*), intent(in)  subname 
)

Definition at line 717 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_kin_en_origin()

double precision function, dimension(ixo^s) mod_ffhd_phys::ffhd_kin_en_origin ( double precision, dimension(ixi^s, nw), intent(in)  w,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixo^s), intent(in), optional  inv_rho 
)

Definition at line 1482 of file mod_ffhd_phys.t.

◆ ffhd_phys_init()

subroutine, public mod_ffhd_phys::ffhd_phys_init

need to check source geom here

Definition at line 182 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_physical_units()

subroutine mod_ffhd_phys::ffhd_physical_units

Definition at line 595 of file mod_ffhd_phys.t.

◆ ffhd_sts_set_source_tc_ffhd()

subroutine mod_ffhd_phys::ffhd_sts_set_source_tc_ffhd ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
double precision, dimension(ixi^s,1:nw), intent(inout)  wres,
logical, intent(in)  fix_conserve_at_step,
double precision, intent(in)  my_dt,
integer, intent(in)  igrid,
integer, intent(in)  nflux 
)

Definition at line 448 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_tc_handle_small_e()

subroutine mod_ffhd_phys::ffhd_tc_handle_small_e ( double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  step 
)

Definition at line 475 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_te_images()

subroutine mod_ffhd_phys::ffhd_te_images

Definition at line 429 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_to_conserved_origin()

subroutine mod_ffhd_phys::ffhd_to_conserved_origin ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s, nw), intent(inout)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x 
)

Definition at line 664 of file mod_ffhd_phys.t.

◆ ffhd_to_primitive_origin()

subroutine mod_ffhd_phys::ffhd_to_primitive_origin ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s, nw), intent(inout)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x 
)

fix small values preventing NaN numbers in the following converting

Definition at line 678 of file mod_ffhd_phys.t.

◆ ffhd_update_temperature()

subroutine mod_ffhd_phys::ffhd_update_temperature ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(in)  wCT,
double precision, dimension(ixi^s,1:nw), intent(inout)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x 
)

Definition at line 1326 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ ffhd_write_info()

subroutine mod_ffhd_phys::ffhd_write_info ( integer, intent(in)  fh)

Write this module's parameters to a snapsoht.

Definition at line 165 of file mod_ffhd_phys.t.

◆ get_tau()

subroutine mod_ffhd_phys::get_tau ( integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s,1:nw), intent(in)  w,
double precision, dimension(ixi^s), intent(in)  Te,
double precision, dimension(ixi^s), intent(out)  tau,
double precision, dimension(ixi^s), intent(out)  sigT5 
)

w supposed to be wCTprim here

Definition at line 1519 of file mod_ffhd_phys.t.

◆ rc_params_read()

subroutine mod_ffhd_phys::rc_params_read ( type(rc_fluid), intent(inout)  fl)

Name of cooling curve

Name of cooling method

Fixed temperature not lower than tlow

Lower limit of temperature

Add cooling source in a split way (.true.) or un-split way (.false.)

Definition at line 527 of file mod_ffhd_phys.t.

◆ rfactor_from_constant_ionization()

subroutine mod_ffhd_phys::rfactor_from_constant_ionization ( double precision, dimension(ixi^s,1:nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  Rfactor 
)

Definition at line 1509 of file mod_ffhd_phys.t.

◆ rfactor_from_temperature_ionization()

subroutine mod_ffhd_phys::rfactor_from_temperature_ionization ( double precision, dimension(ixi^s,1:nw), intent(in)  w,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
double precision, dimension(ixi^s), intent(out)  Rfactor 
)

Definition at line 1496 of file mod_ffhd_phys.t.

Here is the call graph for this function:

◆ tc_params_read_ffhd()

subroutine mod_ffhd_phys::tc_params_read_ffhd ( type(tc_fluid), intent(inout)  fl)

Definition at line 488 of file mod_ffhd_phys.t.

Variable Documentation

◆ e_

integer, public, protected mod_ffhd_phys::e_

Index of the energy density (-1 if not present)

Definition at line 61 of file mod_ffhd_phys.t.

◆ eq_state_units

logical, public, protected mod_ffhd_phys::eq_state_units = .true.

Definition at line 104 of file mod_ffhd_phys.t.

◆ ffhd_adiab

double precision, public mod_ffhd_phys::ffhd_adiab = 1.0d0

The adiabatic constant.

Definition at line 78 of file mod_ffhd_phys.t.

◆ ffhd_energy

logical, public, protected mod_ffhd_phys::ffhd_energy = .true.

Whether an energy equation is used.

Definition at line 17 of file mod_ffhd_phys.t.

◆ ffhd_gamma

double precision, public mod_ffhd_phys::ffhd_gamma = 5.d0/3.0d0

The adiabatic index.

Definition at line 75 of file mod_ffhd_phys.t.

◆ ffhd_get_pthermal

procedure(sub_get_pthermal), pointer, public mod_ffhd_phys::ffhd_get_pthermal => null()

Definition at line 125 of file mod_ffhd_phys.t.

◆ ffhd_get_temperature

procedure(sub_get_pthermal), pointer, public mod_ffhd_phys::ffhd_get_temperature => null()

Definition at line 127 of file mod_ffhd_phys.t.

◆ ffhd_get_v

procedure(sub_get_v), pointer, public mod_ffhd_phys::ffhd_get_v => null()

Definition at line 128 of file mod_ffhd_phys.t.

◆ ffhd_gravity

logical, public, protected mod_ffhd_phys::ffhd_gravity = .false.

Whether gravity is added.

Definition at line 37 of file mod_ffhd_phys.t.

◆ ffhd_hyperbolic_thermal_conduction

logical, public, protected mod_ffhd_phys::ffhd_hyperbolic_thermal_conduction = .false.

Whether hyperbolic type thermal conduction is used.

Definition at line 22 of file mod_ffhd_phys.t.

◆ ffhd_kin_en

procedure(fun_kin_en), pointer, public mod_ffhd_phys::ffhd_kin_en => null()

Definition at line 129 of file mod_ffhd_phys.t.

◆ ffhd_partial_ionization

logical, public, protected mod_ffhd_phys::ffhd_partial_ionization = .false.

Whether plasma is partially ionized.

Definition at line 52 of file mod_ffhd_phys.t.

◆ ffhd_radiative_cooling

logical, public, protected mod_ffhd_phys::ffhd_radiative_cooling = .false.

Whether radiative cooling is added.

Definition at line 29 of file mod_ffhd_phys.t.

◆ ffhd_thermal_conduction

logical, public, protected mod_ffhd_phys::ffhd_thermal_conduction = .false.

Whether thermal conduction is used.

Definition at line 20 of file mod_ffhd_phys.t.

◆ ffhd_to_conserved

procedure(sub_convert), pointer, public mod_ffhd_phys::ffhd_to_conserved => null()

Definition at line 123 of file mod_ffhd_phys.t.

◆ ffhd_to_primitive

procedure(sub_convert), pointer, public mod_ffhd_phys::ffhd_to_primitive => null()

Definition at line 122 of file mod_ffhd_phys.t.

◆ ffhd_trac

logical, public, protected mod_ffhd_phys::ffhd_trac = .false.

Whether TRAC method is used.

Definition at line 40 of file mod_ffhd_phys.t.

◆ ffhd_trac_finegrid

integer, public, protected mod_ffhd_phys::ffhd_trac_finegrid =4

Distance between two adjacent traced magnetic field lines (in finest cell size)

Definition at line 49 of file mod_ffhd_phys.t.

◆ ffhd_trac_mask

double precision, public, protected mod_ffhd_phys::ffhd_trac_mask = 0.d0

Height of the mask used in the TRAC method.

Definition at line 46 of file mod_ffhd_phys.t.

◆ ffhd_trac_type

integer, public, protected mod_ffhd_phys::ffhd_trac_type =1

Which TRAC method is used.

Definition at line 43 of file mod_ffhd_phys.t.

◆ ffhd_viscosity

logical, public, protected mod_ffhd_phys::ffhd_viscosity = .false.

Whether viscosity is added.

Definition at line 34 of file mod_ffhd_phys.t.

◆ h_ion_fr

double precision, public, protected mod_ffhd_phys::h_ion_fr =1d0

Ionization fraction of H H_ion_fr = H+/(H+ + H)

Definition at line 90 of file mod_ffhd_phys.t.

◆ he_abundance

double precision, public, protected mod_ffhd_phys::he_abundance =0.1d0

Helium abundance over Hydrogen.

Definition at line 87 of file mod_ffhd_phys.t.

◆ he_ion_fr

double precision, public, protected mod_ffhd_phys::he_ion_fr =1d0

Ionization fraction of He He_ion_fr = (He2+ + He+)/(He2+ + He+ + He)

Definition at line 93 of file mod_ffhd_phys.t.

◆ he_ion_fr2

double precision, public, protected mod_ffhd_phys::he_ion_fr2 =1d0

Ratio of number He2+ / number He+ + He2+ He_ion_fr2 = He2+/(He2+ + He+)

Definition at line 96 of file mod_ffhd_phys.t.

◆ hypertc_kappa

double precision, public mod_ffhd_phys::hypertc_kappa

The thermal conductivity kappa in hyperbolic thermal conduction.

Definition at line 84 of file mod_ffhd_phys.t.

◆ mom

integer, dimension(:), allocatable, public, protected mod_ffhd_phys::mom

Indices of the momentum density.

Definition at line 58 of file mod_ffhd_phys.t.

◆ p_

integer, public, protected mod_ffhd_phys::p_

Index of the gas pressure (-1 if not present) should equal e_.

Definition at line 64 of file mod_ffhd_phys.t.

◆ q_

integer, public, protected mod_ffhd_phys::q_

Definition at line 72 of file mod_ffhd_phys.t.

◆ rc_fl

type(rc_fluid), allocatable, public mod_ffhd_phys::rc_fl

type of fluid for radiative cooling

Definition at line 31 of file mod_ffhd_phys.t.

◆ rho_

integer, public, protected mod_ffhd_phys::rho_

Index of the density (in the w array)

Definition at line 55 of file mod_ffhd_phys.t.

◆ rr

double precision, public, protected mod_ffhd_phys::rr =1d0

Definition at line 100 of file mod_ffhd_phys.t.

◆ tc_fl

type(tc_fluid), allocatable, public mod_ffhd_phys::tc_fl

type of fluid for thermal conduction

Definition at line 24 of file mod_ffhd_phys.t.

◆ tcoff_

integer, public, protected mod_ffhd_phys::tcoff_

Index of the cutoff temperature for the TRAC method.

Definition at line 70 of file mod_ffhd_phys.t.

◆ te_

integer, public, protected mod_ffhd_phys::te_

Indices of temperature.

Definition at line 67 of file mod_ffhd_phys.t.

◆ te_fl_ffhd

type(te_fluid), allocatable, public mod_ffhd_phys::te_fl_ffhd

type of fluid for thermal emission synthesis

Definition at line 26 of file mod_ffhd_phys.t.

◆ tweight_

integer, public, protected mod_ffhd_phys::tweight_

Definition at line 71 of file mod_ffhd_phys.t.