Frozen-field hydrodynamics module. More...
Functions/Subroutines | |
| subroutine, public | ffhd_phys_init () |
| subroutine, public | ffhd_to_conserved_origin (ixil, ixol, w, x) |
| subroutine, public | 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) |
| double precision function, dimension(ixo^s), public | ffhd_get_ei (w, ixil, ixol) |
| Internal energy eint = E_total - E_kinetic (single field-aligned momentum). Wired to phys_get_ei; the LTE+ionE radiative cooling uses it to recover the gas internal energy from the conserved state. | |
| subroutine, public | ffhd_get_v_idim (w, x, ixil, ixol, idim, v) |
| subroutine, public | ffhd_get_pthermal_origin (w, x, ixil, ixol, pth) |
| subroutine, public | ffhd_get_temperature_from_te (w, x, ixil, ixol, res) |
| subroutine, public | ffhd_get_temperature_from_eint (w, x, ixil, ixol, res) |
| subroutine, public | ffhd_get_temperature_from_etot (w, x, ixil, ixol, res) |
| subroutine, public | ffhd_get_csound2 (w, x, ixil, ixol, csound2) |
| subroutine, public | ffhd_get_rho (w, x, ixil, ixol, rho) |
| subroutine, public | rfactor_from_constant_ionization (w, x, ixil, ixol, rfactor) |
Variables | |
| logical, public, protected | ffhd_energy = .true. |
| Whether an energy equation is used. | |
| logical, public, protected | ffhd_thermal_conduction = .false. |
| Whether thermal conduction is used. | |
| logical, public, protected | ffhd_hyperbolic_tc = .false. |
| Whether hyperbolic type thermal conduction is used. | |
| logical, public, protected | ffhd_hyperbolic_tc_sat = .false. |
| Whether saturation is considered for hyperbolic TC. | |
| logical, public, protected | ffhd_hyperbolic_tc_use_perp = .false. |
| Whether the perpendicular hyperbolic-TC channel is enabled. | |
| type(tc_fluid), allocatable, public | tc_fl |
| type of fluid for thermal conduction | |
| type(te_fluid), allocatable, public | te_fl_ffhd |
| type of fluid for thermal emission synthesis | |
| logical, public, protected | ffhd_radiative_cooling = .false. |
| Whether radiative cooling is added. | |
| type(rc_fluid), allocatable, public | rc_fl |
| type of fluid for radiative cooling | |
| logical, public, protected | ffhd_gravity = .false. |
| Whether gravity is added. | |
| logical, public, protected | ffhd_trac = .false. |
| Whether TRAC method is used. | |
| integer, public, protected | ffhd_trac_type =1 |
| Which TRAC method is used. | |
| double precision, public, protected | ffhd_trac_mask = 0.d0 |
| Height of the mask used in the TRAC method. | |
| integer, public, protected | ffhd_trac_finegrid =4 |
| Distance between two adjacent traced magnetic field lines (in finest cell size) | |
| integer, public, protected | rho_ |
| Whether plasma is partially ionized. | |
| integer, dimension(:), allocatable, public, protected | mom |
| Indices of the momentum density. | |
| integer, public, protected | e_ |
| Index of the energy density (-1 if not present) | |
| integer, public, protected | p_ |
| Index of the gas pressure (-1 if not present) should equal e_. | |
| integer, public, protected | te_ |
| Indices of temperature and electron number density (LTE stored aux state) | |
| integer, public, protected | ne_ |
| integer, public, protected | tcoff_ |
| Index of the cutoff temperature for the TRAC method. | |
| integer, public, protected | tweight_ |
| integer, public, protected | q_ |
| double precision, public | ffhd_adiab = 1.0d0 |
| The adiabatic index (now owned by eos%; use eosgamma) | |
| double precision, public | hyperbolic_tc_kappa |
| The thermal conductivity kappa in hyperbolic thermal conduction. | |
| double precision, public, protected | h_ion_fr =1d0 |
| Helium abundance over Hydrogen (now owned by eos%; use eosHe_abundance) Ionization fraction of H H_ion_fr = H+/(H+ + H) | |
| double precision, public, protected | he_ion_fr =1d0 |
| Ionization fraction of He He_ion_fr = (He2+ + He+)/(He2+ + He+ + He) | |
| double precision, public, protected | he_ion_fr2 =1d0 |
| Ratio of number He2+ / number He+ + He2+ He_ion_fr2 = He2+/(He2+ + He+) | |
| double precision, public, protected | rr =1d0 |
| procedure(sub_convert), pointer, public | ffhd_to_primitive => null() |
| procedure(sub_convert), pointer, public | ffhd_to_conserved => null() |
| procedure(sub_small_values), pointer, public | ffhd_handle_small_values => null() |
| procedure(sub_get_pthermal), pointer, public | ffhd_get_pthermal => null() |
| procedure(sub_get_pthermal), pointer, public | ffhd_get_rfactor => 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
◆ 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 762 of file mod_ffhd_phys.t.
◆ 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 753 of file mod_ffhd_phys.t.
◆ ffhd_get_csound2()
◆ ffhd_get_ei()
| double precision function, dimension(ixo^s), public mod_ffhd_phys::ffhd_get_ei | ( | double precision, dimension(ixi^s, nw), intent(in) | w, |
| integer, intent(in) | ixi, | ||
| integer, intent(in) | l, | ||
| integer, intent(in) | ixo, | ||
| l | |||
| ) |
Internal energy eint = E_total - E_kinetic (single field-aligned momentum). Wired to phys_get_ei; the LTE+ionE radiative cooling uses it to recover the gas internal energy from the conserved state.
Definition at line 781 of file mod_ffhd_phys.t.
◆ ffhd_get_pthermal_origin()
| subroutine, public 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 1134 of file mod_ffhd_phys.t.
◆ ffhd_get_rho()
◆ ffhd_get_temperature_from_eint()
| subroutine, public 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 1180 of file mod_ffhd_phys.t.
◆ ffhd_get_temperature_from_etot()
| subroutine, public 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 1192 of file mod_ffhd_phys.t.
◆ ffhd_get_temperature_from_te()
| subroutine, public 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 1170 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 | ||
| ) |
◆ ffhd_phys_init()
| subroutine, public mod_ffhd_phys::ffhd_phys_init |
LTE stores Ne_/Te_ as advection-free extra vars (repopulated each step by eosupdate_eos); PI keeps Te_ as an auxiliary var for the ionisation degree. Mirrors mhd: register here (before stop_indices) so FI leaves nwaux=0 and the var layout byte-identical.
Definition at line 184 of file mod_ffhd_phys.t.
◆ ffhd_to_conserved_origin()
| subroutine, public 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 725 of file mod_ffhd_phys.t.
◆ ffhd_to_primitive_origin()
| subroutine, public 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 | ||
| ) |
Definition at line 737 of file mod_ffhd_phys.t.
◆ rfactor_from_constant_ionization()
| subroutine, public 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 1398 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 62 of file mod_ffhd_phys.t.
◆ ffhd_adiab
| double precision, public mod_ffhd_phys::ffhd_adiab = 1.0d0 |
The adiabatic index (now owned by eos%; use eosgamma)
The adiabatic constant
Definition at line 79 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 18 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 117 of file mod_ffhd_phys.t.
◆ ffhd_get_rfactor
| procedure(sub_get_pthermal), pointer, public mod_ffhd_phys::ffhd_get_rfactor => null() |
Definition at line 118 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 119 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 120 of file mod_ffhd_phys.t.
◆ ffhd_gravity
| logical, public, protected mod_ffhd_phys::ffhd_gravity = .false. |
Whether gravity is added.
Definition at line 39 of file mod_ffhd_phys.t.
◆ ffhd_handle_small_values
| procedure(sub_small_values), pointer, public mod_ffhd_phys::ffhd_handle_small_values => null() |
Definition at line 116 of file mod_ffhd_phys.t.
◆ ffhd_hyperbolic_tc
| logical, public, protected mod_ffhd_phys::ffhd_hyperbolic_tc = .false. |
Whether hyperbolic type thermal conduction is used.
Definition at line 23 of file mod_ffhd_phys.t.
◆ ffhd_hyperbolic_tc_sat
| logical, public, protected mod_ffhd_phys::ffhd_hyperbolic_tc_sat = .false. |
Whether saturation is considered for hyperbolic TC.
Definition at line 25 of file mod_ffhd_phys.t.
◆ ffhd_hyperbolic_tc_use_perp
| logical, public, protected mod_ffhd_phys::ffhd_hyperbolic_tc_use_perp = .false. |
Whether the perpendicular hyperbolic-TC channel is enabled.
Definition at line 27 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 121 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 34 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 21 of file mod_ffhd_phys.t.
◆ ffhd_to_conserved
| procedure(sub_convert), pointer, public mod_ffhd_phys::ffhd_to_conserved => null() |
Definition at line 115 of file mod_ffhd_phys.t.
◆ ffhd_to_primitive
| procedure(sub_convert), pointer, public mod_ffhd_phys::ffhd_to_primitive => null() |
Definition at line 114 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 42 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 51 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 48 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 45 of file mod_ffhd_phys.t.
◆ h_ion_fr
| double precision, public, protected mod_ffhd_phys::h_ion_fr =1d0 |
Helium abundance over Hydrogen (now owned by eos%; use eosHe_abundance) Ionization fraction of H H_ion_fr = H+/(H+ + H)
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 90 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 93 of file mod_ffhd_phys.t.
◆ hyperbolic_tc_kappa
| double precision, public mod_ffhd_phys::hyperbolic_tc_kappa |
The thermal conductivity kappa in hyperbolic thermal conduction.
Definition at line 82 of file mod_ffhd_phys.t.
◆ mom
| integer, dimension(:), allocatable, public, protected mod_ffhd_phys::mom |
Indices of the momentum density.
Definition at line 59 of file mod_ffhd_phys.t.
◆ ne_
| integer, public, protected mod_ffhd_phys::ne_ |
Definition at line 69 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 65 of file mod_ffhd_phys.t.
◆ q_
| integer, public, protected mod_ffhd_phys::q_ |
Definition at line 74 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 36 of file mod_ffhd_phys.t.
◆ rho_
| integer, public, protected mod_ffhd_phys::rho_ |
Whether plasma is partially ionized.
Index of the density (in the w array)
Definition at line 56 of file mod_ffhd_phys.t.
◆ rr
| double precision, public, protected mod_ffhd_phys::rr =1d0 |
Definition at line 97 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 29 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 72 of file mod_ffhd_phys.t.
◆ te_
| integer, public, protected mod_ffhd_phys::te_ |
Indices of temperature and electron number density (LTE stored aux state)
Definition at line 68 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 31 of file mod_ffhd_phys.t.
◆ tweight_
| integer, public, protected mod_ffhd_phys::tweight_ |
Definition at line 73 of file mod_ffhd_phys.t.
