MPI-AMRVAC  2.0
The MPI - Adaptive Mesh Refinement - Versatile Advection Code
Functions/Subroutines | Variables
mod_hd_phys Module Reference

Hydrodynamics physics module. More...

Functions/Subroutines

subroutine hd_write_info (fh)
 Write this module's parameters to a snapsoht. More...
 
subroutine hd_angmomfix (fC, x, wnew, ixIL, ixOL, idim)
 Add fluxes in an angular momentum conserving way. More...
 
subroutine, public hd_phys_init ()
 Initialize the module. More...
 
subroutine hd_check_params
 
subroutine hd_physical_units
 
subroutine hd_check_w (primitive, ixIL, ixOL, w, flag)
 Returns 0 in argument flag where values are ok. More...
 
subroutine, public hd_to_conserved (ixIL, ixOL, w, x)
 Transform primitive variables into conservative ones. More...
 
subroutine, public hd_to_primitive (ixIL, ixOL, w, x)
 Transform conservative variables into primitive ones. More...
 
subroutine e_to_rhos (ixIL, ixOL, w, x)
 
subroutine rhos_to_e (ixIL, ixOL, w, x)
 
subroutine hd_get_v (w, x, ixIL, ixOL, idim, v)
 Calculate v_i = m_i / rho within ixO^L. More...
 
subroutine hd_get_cmax (w, x, ixIL, ixOL, idim, cmax)
 Calculate cmax_idim = csound + abs(v_idim) within ixO^L. More...
 
subroutine hd_get_cbounds (wLC, wRC, wLp, wRp, x, ixIL, ixOL, idim, cmax, cmin)
 Calculate cmax_idim = csound + abs(v_idim) within ixO^L. More...
 
subroutine hd_get_csound2 (w, x, ixIL, ixOL, csound2)
 Calculate the square of the thermal sound speed csound2 within ixO^L. csound2=gamma*p/rho. More...
 
subroutine, public hd_get_pthermal (w, x, ixIL, ixOL, pth)
 Calculate thermal pressure=(gamma-1)*(e-0.5*m**2/rho) within ixO^L. More...
 
subroutine hd_get_flux_cons (w, x, ixIL, ixOL, idim, f)
 
subroutine hd_get_flux (wC, w, x, ixIL, ixOL, idim, f)
 
subroutine hd_add_source_geom (qdt, ixIL, ixOL, wCT, w, x)
 Add geometrical source terms to w. More...
 
subroutine hd_add_source (qdt, ixIL, ixOL, wCT, w, x, qsourcesplit, active)
 
subroutine hd_get_dt (w, ixIL, ixOL, dtnew, dxD, x)
 
double precision function, dimension(ixo^s), public hd_kin_en (w, ixIL, ixOL, inv_rho)
 
double precision function, dimension(ixo^s) hd_inv_rho (w, ixIL, ixOL)
 
subroutine hd_handle_small_values (primitive, w, x, ixIL, ixOL, subname)
 

Variables

logical, public, protected hd_energy = .true.
 Whether an energy equation is used. More...
 
logical, public, protected hd_thermal_conduction = .false.
 Whether thermal conduction is added. More...
 
logical, public, protected hd_radiative_cooling = .false.
 Whether radiative cooling is added. More...
 
logical, public, protected hd_dust = .false.
 Whether dust is added. More...
 
logical, public, protected hd_viscosity = .false.
 Whether viscosity is added. More...
 
logical, public, protected hd_gravity = .false.
 Whether gravity is added. More...
 
logical, public, protected hd_particles = .false.
 Whether particles module is added. More...
 
integer, public, protected hd_n_tracer = 0
 Number of tracer species. 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, dimension(:), allocatable, public, protected tracer
 Indices of the tracers. 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...
 
double precision, public hd_gamma = 5.d0/3.0d0
 The adiabatic index. More...
 
double precision, public hd_adiab = 1.0d0
 The adiabatic constant. More...
 
double precision, public, protected he_abundance =0.1d0
 Helium abundance over Hydrogen. More...
 

Detailed Description

Hydrodynamics physics module.

Function/Subroutine Documentation

◆ e_to_rhos()

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

Definition at line 410 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_add_source()

subroutine mod_hd_phys::hd_add_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,
logical, intent(in)  qsourcesplit,
logical, intent(inout)  active 
)

Definition at line 786 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_add_source_geom()

subroutine mod_hd_phys::hd_add_source_geom ( 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(inout)  wCT,
double precision, dimension(ixi^s, 1:nw), intent(inout)  w,
double precision, dimension(ixi^s, 1:ndim), intent(in)  x 
)

Add geometrical source terms to w.

Notice that the expressions of the geometrical terms depend only on ndir, not ndim. Eg, they are the same in 2.5D and in 3D, for any geometry.

Ileyk : to do :

  • address the source term for the dust in case (typeaxial == 'spherical')

Definition at line 677 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_angmomfix()

subroutine mod_hd_phys::hd_angmomfix ( double precision, dimension(ixi^s,1:nwflux,1:ndim), intent(inout)  fC,
double precision, dimension(ixi^s,1:ndim), intent(in)  x,
double precision, dimension(ixi^s,1:nw), intent(inout)  wnew,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L,
integer, intent(in)  idim 
)

Add fluxes in an angular momentum conserving way.

Definition at line 105 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_check_params()

subroutine mod_hd_phys::hd_check_params ( )

Definition at line 269 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_check_w()

subroutine mod_hd_phys::hd_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,
integer, dimension(ixi^s), intent(inout)  flag 
)

Returns 0 in argument flag where values are ok.

Definition at line 313 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_cbounds()

subroutine mod_hd_phys::hd_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), intent(inout)  cmax,
double precision, dimension(ixi^s), intent(inout), optional  cmin 
)

Calculate cmax_idim = csound + abs(v_idim) within ixO^L.

Definition at line 473 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_cmax()

subroutine mod_hd_phys::hd_get_cmax ( 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 
)

Calculate cmax_idim = csound + abs(v_idim) within ixO^L.

Definition at line 451 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_csound2()

subroutine mod_hd_phys::hd_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 
)

Calculate the square of the thermal sound speed csound2 within ixO^L. csound2=gamma*p/rho.

Definition at line 546 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_dt()

subroutine mod_hd_phys::hd_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:^nd), intent(in)  x 
)

Definition at line 841 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_flux()

subroutine mod_hd_phys::hd_get_flux ( double precision, dimension(ixi^s, 1:nw), intent(in)  wC,
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,
integer, intent(in)  idim,
double precision, dimension(ixi^s, nwflux), intent(out)  f 
)

Definition at line 619 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_flux_cons()

subroutine mod_hd_phys::hd_get_flux_cons ( 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,
integer, intent(in)  idim,
double precision, dimension(ixi^s, nwflux), intent(out)  f 
)

Definition at line 580 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_pthermal()

subroutine, public mod_hd_phys::hd_get_pthermal ( 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)  pth 
)

Calculate thermal pressure=(gamma-1)*(e-0.5*m**2/rho) within ixO^L.

Definition at line 562 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_get_v()

subroutine mod_hd_phys::hd_get_v ( 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 
)

Calculate v_i = m_i / rho within ixO^L.

Definition at line 441 of file mod_hd_phys.t.

◆ hd_handle_small_values()

subroutine mod_hd_phys::hd_handle_small_values ( 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 897 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_inv_rho()

double precision function, dimension(ixo^s) mod_hd_phys::hd_inv_rho ( double precision, dimension(ixi^s, nw), intent(in)  w,
integer, intent(in)  ixI,
integer, intent(in)  L,
integer, intent(in)  ixO,
  L 
)

Definition at line 887 of file mod_hd_phys.t.

◆ hd_kin_en()

double precision function, dimension(ixo^s), public mod_hd_phys::hd_kin_en ( 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 873 of file mod_hd_phys.t.

◆ hd_phys_init()

subroutine, public mod_hd_phys::hd_phys_init ( )

Initialize the module.

Definition at line 164 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_physical_units()

subroutine mod_hd_phys::hd_physical_units ( )

Definition at line 287 of file mod_hd_phys.t.

◆ hd_to_conserved()

subroutine, public mod_hd_phys::hd_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 338 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_to_primitive()

subroutine, public mod_hd_phys::hd_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 373 of file mod_hd_phys.t.

Here is the call graph for this function:

◆ hd_write_info()

subroutine mod_hd_phys::hd_write_info ( integer, intent(in)  fh)

Write this module's parameters to a snapsoht.

Definition at line 87 of file mod_hd_phys.t.

◆ rhos_to_e()

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

Definition at line 425 of file mod_hd_phys.t.

Here is the call graph for this function:

Variable Documentation

◆ e_

integer, public, protected mod_hd_phys::e_

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

Definition at line 41 of file mod_hd_phys.t.

◆ hd_adiab

double precision, public mod_hd_phys::hd_adiab = 1.0d0

The adiabatic constant.

Definition at line 50 of file mod_hd_phys.t.

◆ hd_dust

logical, public, protected mod_hd_phys::hd_dust = .false.

Whether dust is added.

Definition at line 17 of file mod_hd_phys.t.

◆ hd_energy

logical, public, protected mod_hd_phys::hd_energy = .true.

Whether an energy equation is used.

Definition at line 8 of file mod_hd_phys.t.

◆ hd_gamma

double precision, public mod_hd_phys::hd_gamma = 5.d0/3.0d0

The adiabatic index.

Definition at line 47 of file mod_hd_phys.t.

◆ hd_gravity

logical, public, protected mod_hd_phys::hd_gravity = .false.

Whether gravity is added.

Definition at line 23 of file mod_hd_phys.t.

◆ hd_n_tracer

integer, public, protected mod_hd_phys::hd_n_tracer = 0

Number of tracer species.

Definition at line 29 of file mod_hd_phys.t.

◆ hd_particles

logical, public, protected mod_hd_phys::hd_particles = .false.

Whether particles module is added.

Definition at line 26 of file mod_hd_phys.t.

◆ hd_radiative_cooling

logical, public, protected mod_hd_phys::hd_radiative_cooling = .false.

Whether radiative cooling is added.

Definition at line 14 of file mod_hd_phys.t.

◆ hd_thermal_conduction

logical, public, protected mod_hd_phys::hd_thermal_conduction = .false.

Whether thermal conduction is added.

Definition at line 11 of file mod_hd_phys.t.

◆ hd_viscosity

logical, public, protected mod_hd_phys::hd_viscosity = .false.

Whether viscosity is added.

Definition at line 20 of file mod_hd_phys.t.

◆ he_abundance

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

Helium abundance over Hydrogen.

Definition at line 56 of file mod_hd_phys.t.

◆ mom

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

Indices of the momentum density.

Definition at line 35 of file mod_hd_phys.t.

◆ p_

integer, public, protected mod_hd_phys::p_

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

Definition at line 44 of file mod_hd_phys.t.

◆ rho_

integer, public, protected mod_hd_phys::rho_

Index of the density (in the w array)

Definition at line 32 of file mod_hd_phys.t.

◆ tracer

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

Indices of the tracers.

Definition at line 38 of file mod_hd_phys.t.