MPI-AMRVAC 3.1
The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)
Loading...
Searching...
No Matches
Functions/Subroutines | Variables
mod_srhd_phys Module Reference

Special Relativistic Hydrodynamics (with EOS) physics module. More...

Functions/Subroutines

subroutine, public srhd_phys_init ()
 Initialize the module.
 
subroutine, public srhd_check_params
 
subroutine, public srhd_check_w (primitive, ixil, ixol, w, flag)
 Returns logical argument flag T where values are not ok.
 
subroutine, public srhd_get_auxiliary_prim (ixil, ixol, w)
 Set auxiliary variables lfac and xi from a primitive state only used when handle_small_values average on primitives.
 
subroutine, public srhd_get_auxiliary (ixil, ixol, w, x)
 Compute auxiliary variables lfac and xi from a conservative state using srhd_con2prim to calculate enthalpy and lorentz factor.
 
subroutine, public srhd_to_conserved (ixil, ixol, w, x)
 Transform primitive variables into conservative ones.
 
subroutine, public srhd_to_primitive (ixil, ixol, w, x)
 Transform conservative variables into primitive ones.
 
subroutine, public srhd_get_csound2 (w, x, ixil, ixol, csound2)
 Calculate the square of the thermal sound speed csound2 within ixO^L. here computed from conservative set and uses con2prim!!! public version!
 
subroutine, public srhd_get_pthermal (w, x, ixil, ixol, pth)
 Calculate thermal pressure p within ixO^L must follow after update conservative with auxiliaries.
 
subroutine, public srhd_get_geff_eos (w, ixil, ixol, varconserve, geff)
 calculate effective gamma
 
subroutine, public srhd_get_enthalpy_eos (ixol, rho, p, rhoh)
 Compute the enthalpy rho*h from rho and pressure p.
 

Variables

logical, public, protected srhd_particles = .false.
 Whether particles module is added.
 
integer, public, protected srhd_n_tracer = 0
 Number of tracer species.
 
integer, public, protected rho_
 Index of the density (in the w array)
 
integer, public, protected d_
 
integer, dimension(:), allocatable, public, protected mom
 Indices of the momentum density.
 
integer, dimension(:), allocatable, public, protected tracer
 Indices of the tracers.
 
integer, public, protected e_
 Index of the energy density.
 
integer, public, protected p_
 Index of the gas pressure should equal e_.
 
integer, public, protected lfac_
 Index of the Lorentz factor.
 
integer, public, protected xi_
 Index of the inertia.
 
logical, public srhd_eos = .false.
 Whether synge eos is used.
 
double precision, public srhd_gamma = 5.d0/3.0d0
 The adiabatic index and derived values.
 
double precision, public gamma_1
 
double precision, public inv_gamma_1
 
double precision, public gamma_to_gamma_1
 
double precision, public small_e
 The smallest allowed energy.
 
double precision, public small_xi
 The smallest allowed inertia.
 
double precision, public, protected he_abundance =0.0d0
 Helium abundance over Hydrogen.
 
integer, public maxitnr = 100
 parameters for NR in con2prim
 
double precision, public absaccnr = 1.0d-8
 
double precision, public tolernr = 1.0d-9
 
double precision, public dmaxvel = 1.0d-7
 
double precision, public lfacmax
 
double precision, public minp
 
double precision, public minrho
 
double precision, public smalltau
 
double precision, public smallxi
 

Detailed Description

Special Relativistic Hydrodynamics (with EOS) physics module.

Function/Subroutine Documentation

◆ srhd_check_params()

subroutine, public mod_srhd_phys::srhd_check_params

Definition at line 209 of file mod_srhd_phys.t.

◆ srhd_check_w()

subroutine, public mod_srhd_phys::srhd_check_w ( 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 
)

Returns logical argument flag T where values are not ok.

Definition at line 263 of file mod_srhd_phys.t.

◆ srhd_get_auxiliary()

subroutine, public mod_srhd_phys::srhd_get_auxiliary ( 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 
)

Compute auxiliary variables lfac and xi from a conservative state using srhd_con2prim to calculate enthalpy and lorentz factor.

Definition at line 330 of file mod_srhd_phys.t.

◆ srhd_get_auxiliary_prim()

subroutine, public mod_srhd_phys::srhd_get_auxiliary_prim ( integer, intent(in)  ixi,
integer, intent(in)  l,
integer, intent(in)  ixo,
  l,
double precision, dimension(ixi^s, nw), intent(inout)  w 
)

Set auxiliary variables lfac and xi from a primitive state only used when handle_small_values average on primitives.

Definition at line 308 of file mod_srhd_phys.t.

Here is the call graph for this function:

◆ srhd_get_csound2()

subroutine, public mod_srhd_phys::srhd_get_csound2 ( double precision, dimension(ixi^s,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,
double precision, dimension(ixo^s), intent(out)  csound2 
)

Calculate the square of the thermal sound speed csound2 within ixO^L. here computed from conservative set and uses con2prim!!! public version!

Definition at line 521 of file mod_srhd_phys.t.

Here is the call graph for this function:

◆ srhd_get_enthalpy_eos()

subroutine, public mod_srhd_phys::srhd_get_enthalpy_eos ( integer, intent(in)  ixo,
integer, intent(in)  l,
double precision, dimension(ixo^s), intent(in)  rho,
double precision, dimension(ixo^s), intent(in)  p,
double precision, dimension(ixo^s), intent(out)  rhoh 
)

Compute the enthalpy rho*h from rho and pressure p.

Definition at line 1028 of file mod_srhd_phys.t.

◆ srhd_get_geff_eos()

subroutine, public mod_srhd_phys::srhd_get_geff_eos ( double precision, dimension(ixi^s, 1:nw), intent(in)  w,
integer, intent(in)  ixi,
integer, intent(in)  l,
integer, intent(in)  ixo,
  l,
logical, intent(in)  varconserve,
double precision, dimension(ixi^s), intent(out)  geff 
)

calculate effective gamma

Definition at line 959 of file mod_srhd_phys.t.

◆ srhd_get_pthermal()

subroutine, public mod_srhd_phys::srhd_get_pthermal ( 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 
)

Calculate thermal pressure p within ixO^L must follow after update conservative with auxiliaries.

Definition at line 541 of file mod_srhd_phys.t.

Here is the call graph for this function:

◆ srhd_phys_init()

subroutine, public mod_srhd_phys::srhd_phys_init

Initialize the module.

Definition at line 111 of file mod_srhd_phys.t.

Here is the call graph for this function:

◆ srhd_to_conserved()

subroutine, public mod_srhd_phys::srhd_to_conserved ( 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 
)

Transform primitive variables into conservative ones.

Definition at line 409 of file mod_srhd_phys.t.

Here is the call graph for this function:

◆ srhd_to_primitive()

subroutine, public mod_srhd_phys::srhd_to_primitive ( 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 
)

Transform conservative variables into primitive ones.

Definition at line 450 of file mod_srhd_phys.t.

Here is the call graph for this function:

Variable Documentation

◆ absaccnr

double precision, public mod_srhd_phys::absaccnr = 1.0d-8

Definition at line 53 of file mod_srhd_phys.t.

◆ d_

integer, public, protected mod_srhd_phys::d_

Definition at line 17 of file mod_srhd_phys.t.

◆ dmaxvel

double precision, public mod_srhd_phys::dmaxvel = 1.0d-7

Definition at line 55 of file mod_srhd_phys.t.

◆ e_

integer, public, protected mod_srhd_phys::e_

Index of the energy density.

Definition at line 26 of file mod_srhd_phys.t.

◆ gamma_1

double precision, public mod_srhd_phys::gamma_1

Definition at line 41 of file mod_srhd_phys.t.

◆ gamma_to_gamma_1

double precision, public mod_srhd_phys::gamma_to_gamma_1

Definition at line 41 of file mod_srhd_phys.t.

◆ he_abundance

double precision, public, protected mod_srhd_phys::he_abundance =0.0d0

Helium abundance over Hydrogen.

Definition at line 49 of file mod_srhd_phys.t.

◆ inv_gamma_1

double precision, public mod_srhd_phys::inv_gamma_1

Definition at line 41 of file mod_srhd_phys.t.

◆ lfac_

integer, public, protected mod_srhd_phys::lfac_

Index of the Lorentz factor.

Definition at line 31 of file mod_srhd_phys.t.

◆ lfacmax

double precision, public mod_srhd_phys::lfacmax

Definition at line 56 of file mod_srhd_phys.t.

◆ maxitnr

integer, public mod_srhd_phys::maxitnr = 100

parameters for NR in con2prim

Definition at line 52 of file mod_srhd_phys.t.

◆ minp

double precision, public mod_srhd_phys::minp

Definition at line 57 of file mod_srhd_phys.t.

◆ minrho

double precision, public mod_srhd_phys::minrho

Definition at line 57 of file mod_srhd_phys.t.

◆ mom

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

Indices of the momentum density.

Definition at line 20 of file mod_srhd_phys.t.

◆ p_

integer, public, protected mod_srhd_phys::p_

Index of the gas pressure should equal e_.

Definition at line 28 of file mod_srhd_phys.t.

◆ rho_

integer, public, protected mod_srhd_phys::rho_

Index of the density (in the w array)

Definition at line 16 of file mod_srhd_phys.t.

◆ small_e

double precision, public mod_srhd_phys::small_e

The smallest allowed energy.

Definition at line 44 of file mod_srhd_phys.t.

◆ small_xi

double precision, public mod_srhd_phys::small_xi

The smallest allowed inertia.

Definition at line 46 of file mod_srhd_phys.t.

◆ smalltau

double precision, public mod_srhd_phys::smalltau

Definition at line 57 of file mod_srhd_phys.t.

◆ smallxi

double precision, public mod_srhd_phys::smallxi

Definition at line 57 of file mod_srhd_phys.t.

◆ srhd_eos

logical, public mod_srhd_phys::srhd_eos = .false.

Whether synge eos is used.

Definition at line 37 of file mod_srhd_phys.t.

◆ srhd_gamma

double precision, public mod_srhd_phys::srhd_gamma = 5.d0/3.0d0

The adiabatic index and derived values.

Definition at line 40 of file mod_srhd_phys.t.

◆ srhd_n_tracer

integer, public, protected mod_srhd_phys::srhd_n_tracer = 0

Number of tracer species.

Definition at line 13 of file mod_srhd_phys.t.

◆ srhd_particles

logical, public, protected mod_srhd_phys::srhd_particles = .false.

Whether particles module is added.

Definition at line 10 of file mod_srhd_phys.t.

◆ tolernr

double precision, public mod_srhd_phys::tolernr = 1.0d-9

Definition at line 54 of file mod_srhd_phys.t.

◆ tracer

integer, dimension(:), allocatable, public, protected mod_srhd_phys::tracer

Indices of the tracers.

Definition at line 23 of file mod_srhd_phys.t.

◆ xi_

integer, public, protected mod_srhd_phys::xi_

Index of the inertia.

Definition at line 34 of file mod_srhd_phys.t.