mod_srhd_phys.t

Go to the documentation of this file.

!> Special Relativistic Hydrodynamics (with EOS) physics module
module mod_srhd_phys
  use mod_physics
  use mod_constants
  use mod_comm_lib, only: mpistop
  implicit none
  private
 
  !> Whether particles module is added
  logical, public, protected              :: srhd_particles = .false.
 
  !> Number of tracer species
  integer, public,protected              :: srhd_n_tracer = 0
 
  !> Index of the density (in the w array)
  integer, public,protected              :: rho_
  integer, public,protected              :: d_ 
 
  !> Indices of the momentum density
  integer, allocatable, public, protected :: mom(:)
 
  !> Indices of the tracers
  integer, allocatable, public, protected :: tracer(:)
 
  !> Index of the energy density 
  integer, public,protected              :: e_
  !> Index of the gas pressure should equal e_
  integer, public,protected              :: p_
 
  !> Index of the Lorentz factor
  integer, public,protected     :: lfac_
 
  !> Index of the inertia
  integer, public,protected     :: xi_
 
  !> Whether synge eos is used
  logical, public                         :: srhd_eos = .false.
 
  !> The adiabatic index and derived values
  double precision, public                :: srhd_gamma = 5.d0/3.0d0
  double precision, public                :: gamma_1,inv_gamma_1,gamma_to_gamma_1
 
  !> The smallest allowed inertia
  double precision, public             :: small_xi
 
  !> Helium abundance over Hydrogen
  double precision, public, protected  :: he_abundance=0.0d0
 
  !> parameters for NR in con2prim
  integer, public                  :: maxitnr   = 100
  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, minrho, smalltau, smallxi
 
  ! Public methods
  public :: srhd_phys_init
  public :: srhd_get_pthermal
  public :: srhd_get_auxiliary
  public :: srhd_get_auxiliary_prim
  public :: srhd_get_csound2
  public :: srhd_to_conserved
  public :: srhd_to_primitive
  public :: srhd_check_params
  public :: srhd_check_w 
  public :: srhd_get_geff_eos
  public :: srhd_get_enthalpy_eos
contains
 
  !> Read this module's parameters from a file
  subroutine srhd_read_params(files)
    use mod_global_parameters
    character(len=*), intent(in) :: files(:)
    integer                      :: n
 
    namelist /srhd_list/ srhd_n_tracer, srhd_eos, srhd_gamma, &
                    srhd_particles, &
                    si_unit, he_abundance
 
    do n = 1, size(files)
       open(unitpar, file=trim(files(n)), status="old")
       read(unitpar, srhd_list, end=111)
111    close(unitpar)
    end do
 
  end subroutine srhd_read_params
 
  !> Write this module's parameters to a snapshot
  subroutine srhd_write_info(fh)
    use mod_global_parameters
    integer, intent(in)                 :: fh
    integer, parameter                  :: n_par = 1
    double precision                    :: values(n_par)
    character(len=name_len)             :: names(n_par)
    integer, dimension(MPI_STATUS_SIZE) :: st
    integer                             :: er
 
    call mpi_file_write(fh, n_par, 1, mpi_integer, st, er)
 
    names(1) = "gamma"
    values(1) = srhd_gamma
    call mpi_file_write(fh, values, n_par, mpi_double_precision, st, er)
    call mpi_file_write(fh, names, n_par * name_len, mpi_character, st, er)
 
  end subroutine srhd_write_info
 
  !> Initialize the module
  subroutine srhd_phys_init()
    use mod_global_parameters
    integer :: itr,idir
 
    call srhd_read_params(par_files)
 
    physics_type = "srhd"
    phys_energy  = .true.
    phys_total_energy  = .true.
    phys_gamma = srhd_gamma
 
    ! unused physics options
    phys_internal_e = .false.
    phys_trac=.false.
 
    use_particles = srhd_particles
 
    ! note: number_species is 1 for srhd
    allocate(start_indices(number_species),stop_indices(number_species))
    ! set the index of the first flux variable for species 1
    start_indices(1)=1
 
    ! Determine flux variables
    rho_ = var_set_rho()
    d_=rho_
 
    allocate(mom(ndir))
    mom(:) = var_set_momentum(ndir)
 
    ! Set index of energy variable
    e_ = var_set_energy()
    p_ = e_
 
    ! derive units from basic units
    call srhd_physical_units()
 
    allocate(tracer(srhd_n_tracer))
 
    ! Set starting index of tracers
    do itr = 1, srhd_n_tracer
       tracer(itr) = var_set_fluxvar("trc", "trp", itr, need_bc=.false.)
    end do
 
    ! Set index for auxiliary variables
    ! MUST be after the possible tracers (which have fluxes)
    xi_  = var_set_auxvar('xi','xi')
    lfac_= var_set_auxvar('lfac','lfac')
 
    ! set number of variables which need update ghostcells
    nwgc=nwflux+nwaux
 
    ! set the index of the last flux variable for species 1
    stop_indices(1)=nwflux
 
    ! Check whether custom flux types have been defined
    if (.not. allocated(flux_type)) then
       allocate(flux_type(ndir, nw))
       flux_type = flux_default
    else if (any(shape(flux_type) /= [ndir, nw])) then
       call mpistop("phys_check error: flux_type has wrong shape")
    end if
 
    nvector      = 1 ! No. vector vars
    allocate(iw_vector(nvector))
    iw_vector(1) = mom(1) - 1
 
    ! dummy for now, no extra source terms precoded
    phys_add_source          => srhd_add_source
    phys_get_dt              => srhd_get_dt
 
    ! actual srhd routines
    phys_check_params        => srhd_check_params
    phys_check_w             => srhd_check_w
    phys_get_cmax            => srhd_get_cmax
    phys_get_cbounds         => srhd_get_cbounds
    phys_get_flux            => srhd_get_flux
    phys_add_source_geom     => srhd_add_source_geom
    phys_to_conserved        => srhd_to_conserved
    phys_to_primitive        => srhd_to_primitive
    phys_get_pthermal        => srhd_get_pthermal
    phys_get_auxiliary       => srhd_get_auxiliary
    phys_get_auxiliary_prim  => srhd_get_auxiliary_prim
    phys_get_pthermal        => srhd_get_pthermal
    phys_get_v               => srhd_get_v
    phys_write_info          => srhd_write_info
    phys_handle_small_values => srhd_handle_small_values
 
 
  end subroutine srhd_phys_init
 
  subroutine srhd_check_params
    use mod_global_parameters
    use mod_geometry, only: coordinate
    use mod_particles, only: particles_init
    use mod_particles, only: npayload,nusrpayload,ngridvars,num_particles,physics_type_particles
 
    ! Initialize particles module
    if (srhd_particles) then
       call particles_init()
    end if
 
    if (srhd_gamma <= 0.0d0 .or. srhd_gamma == 1.0d0) &
            call mpistop ("Error: srhd_gamma <= 0 or srhd_gamma == 1")
    ! additional useful values
    gamma_1=srhd_gamma-1.0d0
    inv_gamma_1=1.0d0/gamma_1
    gamma_to_gamma_1=srhd_gamma/gamma_1
   
    ! the following sets small_e and small_xi from small_density/small_pressure
    ! according to the srhd_eos used
    call srhd_get_smallvalues_eos
 
    if(mype==0)then
       write(*,*)'------------------------------------------------------------'
       write(*,*)'Using EOS set via srhd_eos=',srhd_eos
       write(*,*)'Maximal lorentz factor (via dmaxvel) is=',lfacmax
       write(*,*)'Use fixes set through check/fix small values:', check_small_values,fix_small_values
       write(*,*)'Controlled with small pressure/density:', small_pressure,small_density
       write(*,*)'Derived small values: xi and e ',small_xi,small_e
       write(*,*)'------------------------------------------------------------'
    endif
 
    if(mype==0)then
           write(*,*)'====SRHD run with settings===================='
           write(*,*)'Using mod_srhd_phys with settings:'
           write(*,*)'SI_unit=',si_unit
           write(*,*)'Dimensionality   :',ndim
           write(*,*)'vector components:',ndir
           write(*,*)'coordinate set to type,slab:',coordinate,slab
           write(*,*)'number of variables          nw=',nw
           write(*,*)'    start index         iwstart=',iwstart
           write(*,*)'number of      vector variables=',nvector
           write(*,*)'number of stagger variables nws=',nws
           write(*,*)'number of    variables with BCs=',nwgc
           write(*,*)'number of      vars with fluxes=',nwflux
           write(*,*)'number of   vars with flux + BC=',nwfluxbc
           write(*,*)'number of   auxiliary variables=',nwaux
           write(*,*)'number of extra vars without flux=',nwextra
           write(*,*)'number of extra vars   for wextra=',nw_extra
           write(*,*)'number of auxiliary I/O variables=',nwauxio
           write(*,*)'number of             srhd_n_tracer=',srhd_n_tracer
           write(*,*)'    srhd_particles=',srhd_particles
           if(srhd_particles) then
              write(*,*) '*****Using particles: npayload,ngridvars :', npayload,ngridvars
              write(*,*) '*****Using particles:        nusrpayload :', nusrpayload
              write(*,*) '*****Using particles:      num_particles :', num_particles
              write(*,*) '*****Using particles: physics_type_particles=',physics_type_particles
           end if
           write(*,*)'number of             ghostcells=',nghostcells
           write(*,*)'number due to phys_wider_stencil=',phys_wider_stencil
           write(*,*)'==========================================='
    endif
 
 
  end subroutine srhd_check_params
 
  subroutine srhd_physical_units
    use mod_global_parameters
    double precision :: mp,kb
 
    ! Derive scaling units
    if(si_unit) then
      mp=mp_si
      kb=kb_si
      unit_velocity=c_si
    else
      mp=mp_cgs
      kb=kb_cgs
      unit_velocity=const_c
    end if
    if(unit_numberdensity*unit_length<=0.0d0)then
       call mpistop("Abort: must set positive values for unit length and numberdensity")
    endif
    ! we assume user sets: unit_numberdensity, unit_length, He_abundance
    ! then together with light speed c, all units fixed
    unit_density=(1.0d0+4.0d0*he_abundance)*mp*unit_numberdensity
    unit_pressure=unit_density*unit_velocity**2
    unit_temperature=unit_pressure/((2.0d0+3.0d0*he_abundance)*unit_numberdensity*kb)
    unit_time=unit_length/unit_velocity
    unit_mass = unit_density*unit_length**3
 
  end subroutine srhd_physical_units
 
  !> Returns logical argument flag T where values are not ok
  subroutine srhd_check_w(primitive, ixI^L, ixO^L, w, flag)
    use mod_global_parameters
    logical, intent(in)          :: primitive
    integer, intent(in)          :: ixi^l, ixo^l
    double precision, intent(in) :: w(ixi^s, nw)
    logical, intent(inout)       :: flag(ixi^s,1:nw)
 
    flag=.false.
 
    ! NOTE: we should not check or use nwaux variables here
    if(primitive) then
       where(w(ixo^s,rho_) < small_density) flag(ixo^s,rho_) = .true.
       where(w(ixo^s,p_) < small_pressure) flag(ixo^s,p_) = .true.
    else
       where(w(ixo^s,d_) < small_density) flag(ixo^s,d_) = .true.
       where(w(ixo^s,e_) < small_e) flag(ixo^s,e_) = .true.
    endif
 
  end subroutine srhd_check_w
 
  !> Returns logical argument flag T where auxiliary values are not ok
  subroutine srhd_check_w_aux(ixI^L, ixO^L, w, flag)
    use mod_global_parameters
    integer, intent(in)          :: ixi^l, ixo^l
    double precision, intent(in) :: w(ixi^s, nw)
    logical, intent(inout)       :: flag(ixi^s,1:nw)
 
    flag=.false.
 
    where(w(ixo^s,xi_) < small_xi) flag(ixo^s,xi_) = .true.
    where(w(ixo^s,lfac_) < one) flag(ixo^s,lfac_) = .true.
 
    if(any(flag(ixo^s,xi_)))then
       write(*,*)'auxiliary xi too low: abort'
       call mpistop('auxiliary  check failed')
    endif
    if(any(flag(ixo^s,lfac_)))then
       write(*,*)'auxiliary lfac too low: abort'
       call mpistop('auxiliary  check failed')
    endif
 
  end subroutine srhd_check_w_aux
 
  !> Set auxiliary variables lfac and xi from a primitive state
  !> only used when handle_small_values average on primitives
  subroutine srhd_get_auxiliary_prim(ixI^L,ixO^L,w)
    use mod_global_parameters
    integer, intent(in)                :: ixi^l, ixo^l
    double precision, intent(inout)    :: w(ixi^s, nw)
    double precision, dimension(ixO^S) :: rho,rhoh,pth
 
    ! assume four-velocity in momentum vector (i.e. lfac*v)
    rho(ixo^s)    = sum(w(ixo^s, mom(:))**2, dim=ndim+1)
    w(ixo^s,lfac_) = dsqrt(1.0d0+rho(ixo^s))
 
    rho(ixo^s)=w(ixo^s,rho_)
    pth(ixo^s)=w(ixo^s,p_)
    ! compute rho*h (enthalpy h) from density-pressure
    call srhd_get_enthalpy_eos(ixo^l,rho,pth,rhoh)
 
    ! fill auxiliary variable xi= lfac^2 rhoh
    w(ixo^s,xi_) = w(ixo^s,lfac_)**2.0d0*rhoh(ixo^s)
 
  end subroutine srhd_get_auxiliary_prim
 
  !> Compute auxiliary variables lfac and xi from a conservative state
  !> using srhd_con2prim to calculate enthalpy and lorentz factor
  subroutine srhd_get_auxiliary(ixI^L,ixO^L,w,x)
    use mod_global_parameters
    implicit none
 
    integer, intent(in)             :: ixi^l,ixo^l
    double precision, intent(inout) :: w(ixi^s, nw)
    double precision, intent(in)    :: x(ixi^s, 1:ndim)
 
    integer                        :: ix^d,ierror,idir
    integer                        :: flag_error(ixo^s)
    double precision               :: ssqr
 
    if(srhd_eos)then
      {do ix^db=ixomin^db,ixomax^db\}
        ierror=0
        ssqr=0.0d0
        do idir=1,ndir
          ssqr= ssqr+w(ix^d,mom(idir))**2
        enddo
        if(w(ix^d,d_)<small_density)then
           print *,'entering con2prim with', w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_)
           print *,'in position',ix^d,x(ix^d,1:ndim)
           print *,small_density,small_e,small_pressure,small_xi
           if(check_small_values) call mpistop('small density on entry con2prim')
           if(fix_small_values) w(ix^d,d_)=small_density
        endif
        if(w(ix^d,e_)<small_e)then
           print *,'entering con2prim with', w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_)
           print *,'in position',ix^d,x(ix^d,1:ndim)
           print *,small_density,small_e,small_pressure,small_xi
           if(check_small_values) call mpistop('small energy on entry con2prim')
           if(fix_small_values) w(ix^d,e_)=small_e
        endif
        call con2prim_eos(w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_),ierror)
        flag_error(ix^d) = ierror
      {enddo^d&\}
    else
      {do ix^db=ixomin^db,ixomax^db\}
        ierror=0
        ssqr=0.0d0
        do idir=1,ndir
          ssqr= ssqr+w(ix^d,mom(idir))**2
        enddo
        if(w(ix^d,d_)<small_density)then
           print *,'entering con2prim with', w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_)
           print *,'in position',ix^d,x(ix^d,1:ndim)
           print *,small_density,small_e,small_pressure,small_xi
           if(check_small_values) call mpistop('small density on entry con2prim')
           if(fix_small_values) w(ix^d,d_)=small_density
        endif
        if(w(ix^d,e_)<small_e)then
           print *,'entering con2prim with', w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_)
           print *,'in position',ix^d,x(ix^d,1:ndim)
           print *,small_density,small_e,small_pressure,small_xi
           if(check_small_values) call mpistop('small energy on entry con2prim')
           if(fix_small_values) w(ix^d,e_)=small_e
        endif
        call con2prim(w(ix^d,lfac_),w(ix^d,xi_), &
                    w(ix^d,d_),ssqr,w(ix^d,e_),ierror)
        flag_error(ix^d) = ierror
      {enddo^d&\}
    endif
 
    if(check_small_values)then
     if(any(flag_error(ixo^s)/=0))then
         print *,flag_error(ixo^s)
         call mpistop('Problem when getting auxiliaries')
    !    call srhd_handle_small_values(.false.,w,x,ixI^L,ixO^L,'srhd_get_auxiliary')
     end if 
    end if 
 
  end subroutine srhd_get_auxiliary
 
  !> Transform primitive variables into conservative ones
  subroutine srhd_to_conserved(ixI^L, ixO^L, w, x)
    use mod_global_parameters
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(inout) :: w(ixi^s, nw)
    double precision, intent(in)    :: x(ixi^s, 1:ndim)
    integer                         :: idir,itr
    double precision, dimension(ixO^S) :: rhoh,rho,pth
 
    ! assume four-velocity in momentum vector (i.e. lfac*v)
    ! use rhoh slot for temporary array
    rhoh(ixo^s)    = sum(w(ixo^s, mom(:))**2, dim=ndim+1)
    w(ixo^s,lfac_) = dsqrt(1.0d0+rhoh(ixo^s))
 
    rho(ixo^s)=w(ixo^s,rho_)
    pth(ixo^s)=w(ixo^s,p_)
    ! compute rho*h (enthalpy h) from density-pressure
    call srhd_get_enthalpy_eos(ixo^l,rho,pth,rhoh)
 
    ! compute rhoh*lfac (recycle rhoh)
    rhoh(ixo^s)= rhoh(ixo^s)*w(ixo^s,lfac_)
    ! fill auxiliary variable xi= lfac^2 rhoh
    w(ixo^s,xi_) = w(ixo^s,lfac_)*rhoh(ixo^s)
 
    ! set conservative density: d = lfac * rho
    w(ixo^s,d_)=w(ixo^s,lfac_)*rho(ixo^s)
 
    ! Convert four-velocity (lfac*v) to momentum (xi*v=[rho*h*lfac^2]*v)
    do idir = 1, ndir
       w(ixo^s, mom(idir)) = rhoh(ixo^s)*w(ixo^s, mom(idir))
    end do 
 
    ! set tau = xi-p-d energy variable
    w(ixo^s,e_) = w(ixo^s,xi_)-pth(ixo^s)-w(ixo^s,d_)
 
    do itr=1,srhd_n_tracer
       w(ixo^s,tracer(itr)) = w(ixo^s,d_)*w(ixo^s,tracer(itr))
    end do
 
  end subroutine srhd_to_conserved
 
  !> Transform conservative variables into primitive ones
  subroutine srhd_to_primitive(ixI^L, ixO^L, w, x)
    use mod_global_parameters
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(inout) :: w(ixi^s, nw)
    double precision, intent(in)    :: x(ixi^s, 1:ndim)
    integer                         :: idir,itr
    double precision, dimension(ixO^S) :: rho,rhoh,e
    double precision, dimension(ixI^S) :: pth
    character(len=30)                  :: subname_loc
 
    ! get auxiliary variables lfac and xi from conserved set
    call srhd_get_auxiliary(ixi^l,ixo^l,w,x)
 
    ! from d to rho (d=rho*lfac)
    rho(ixo^s) = w(ixo^s,d_)/w(ixo^s,lfac_)
 
    ! compute pressure
    ! deduce rho*h from xi/lfac^2
    rhoh(ixo^s) = w(ixo^s,xi_)/w(ixo^s,lfac_)**2.0d0
    call srhd_get_pressure_eos(ixi^l,ixo^l,rho,rhoh,pth,e)
 
    w(ixo^s,rho_)=rho(ixo^s)
    ! from xi*v to U=lfac*v (four-velocity) 
    do idir=1,ndir
      w(ixo^s,mom(idir)) = w(ixo^s,lfac_)*w(ixo^s,mom(idir))&
                           /w(ixo^s,xi_)
    end do
    w(ixo^s,p_)=pth(ixo^s)
 
    do itr=1,srhd_n_tracer
       w(ixo^s,tracer(itr)) = w(ixo^s,tracer(itr)) &
                               /(rho(ixo^s)*w(ixo^s,lfac_))
    end do
 
  end subroutine srhd_to_primitive
 
  !> Calculate v vector from conservatives
  subroutine srhd_get_v(w,x,ixI^L,ixO^L,v)
    use mod_global_parameters
    integer, intent(in)           :: ixi^l, ixo^l
    double precision, intent(in)  :: w(ixi^s, nw), x(ixi^s,1:ndim)
    double precision, intent(out) :: v(ixi^s,1:ndir)
    integer :: idir
 
    ! get v from xi*v
    do idir=1,ndir
      v(ixo^s,idir) = w(ixo^s, mom(idir))/w(ixo^s,xi_)
    end do 
 
  end subroutine srhd_get_v
 
  !> Calculate the square of the thermal sound speed csound2 within ixO^L.
  !> here computed from conservative set WITH ADDED rho*h
  !> local version: does not do con2prim
  subroutine srhd_get_csound2_rhoh(w,x,ixI^L,ixO^L,rhoh,csound2)
    use mod_global_parameters
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: w(ixi^s,nw),rhoh(ixo^s)
    double precision, intent(in)    :: x(ixi^s,1:ndim)
    double precision, intent(out)   :: csound2(ixo^s)
 
    double precision                :: rho(ixo^s)
 
    rho=w(ixo^s,d_)/w(ixo^s,lfac_)
    call srhd_get_csound2_eos(ixi^l,ixo^l,rho,rhoh,csound2)
 
  end subroutine srhd_get_csound2_rhoh
 
  !> Calculate the square of the thermal sound speed csound2 within ixO^L.
  !> here computed from conservative set and uses con2prim!!!
  !> public version!
  subroutine srhd_get_csound2(w,x,ixI^L,ixO^L,csound2)
    use mod_global_parameters
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(inout) :: w(ixi^s,nw)
    double precision, intent(in)    :: x(ixi^s,1:ndim)
    double precision, intent(out)   :: csound2(ixo^s)
 
    double precision                :: rho(ixo^s),rhoh(ixo^s)
 
    ! get auxiliary variables lfac and xi from conserved set
    call srhd_get_auxiliary(ixi^l,ixo^l,w,x)
    ! quantify rho, rho*h
    rho  = w(ixo^s,d_)/w(ixo^s,lfac_)
    rhoh = w(ixo^s,xi_)/w(ixo^s,lfac_)**2.0d0
    call srhd_get_csound2_eos(ixi^l,ixo^l,rho,rhoh,csound2)
 
  end subroutine srhd_get_csound2
 
  !> Calculate thermal pressure p within ixO^L
  !> must follow after update conservative with auxiliaries
  subroutine srhd_get_pthermal(w, x, ixI^L, ixO^L, pth)
    use mod_global_parameters
    use mod_small_values, only: trace_small_values
 
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: w(ixi^s, nw)
    double precision, intent(in)    :: x(ixi^s, 1:ndim)
    double precision, intent(out)   :: pth(ixi^s)
 
    integer                      :: iw, ix^d
    double precision             :: rho(ixo^s),rhoh(ixo^s),e(ixo^s)
 
    ! quantify rho, rho*h, tau and get pthermal
    rho  = w(ixo^s,d_)/w(ixo^s,lfac_)
    rhoh = w(ixo^s,xi_)/w(ixo^s,lfac_)**2.0d0
    call srhd_get_pressure_eos(ixi^l,ixo^l,rho,rhoh,pth,e)
 
  end subroutine srhd_get_pthermal
 
  !> dummy addsource subroutine
  ! w[iw]= w[iw]+qdt*S[wCT, qtC, x] where S is the source based on wCT within ixO
  subroutine srhd_add_source(qdt,dtfactor,ixI^L,ixO^L,wCT,wCTprim,w,x,qsourcesplit,active)
    use mod_global_parameters
 
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: qdt,dtfactor
    double precision, intent(in)    :: wct(ixi^s, 1:nw),wctprim(ixi^s,1:nw), x(ixi^s, 1:ndim)
    double precision, intent(inout) :: w(ixi^s, 1:nw)
    logical, intent(in)             :: qsourcesplit
    logical, intent(inout)          :: active
 
  end subroutine srhd_add_source
 
  !> dummy get_dt subroutine
  subroutine srhd_get_dt(w, ixI^L, ixO^L, dtnew, dx^D, x)
    use mod_global_parameters
 
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: dx^d, x(ixi^s, 1:^nd)
    double precision, intent(in)    :: w(ixi^s, 1:nw)
    double precision, intent(inout) :: dtnew
 
    dtnew = bigdouble
 
  end subroutine srhd_get_dt
 
  !> Calculate cmax_idim within ixO^L
  !> used especially for setdt CFL limit
  subroutine srhd_get_cmax(w, x, ixI^L, ixO^L, idim, cmax)
    use mod_global_parameters
 
    integer, intent(in)                       :: ixi^l, ixo^l, idim
    double precision, intent(in)              :: w(ixi^s, nw), x(ixi^s, 1:ndim)
    double precision, intent(inout)           :: cmax(ixi^s)
 
    double precision, dimension(ixO^S)        :: csound2,tmp1,tmp2,v2
    double precision, dimension(ixI^S)        :: vidim, cmin
 
    logical       :: flag(ixi^s,1:nw)
 
    ! input w is in primitive form 
    ! auxiliaries are filled here
    tmp1=w(ixo^s,rho_)
    tmp2=w(ixo^s,xi_)/w(ixo^s,lfac_)**2.0d0
    v2=w(ixo^s,p_)
    call srhd_get_csound2_prim_eos(ixo^l,tmp1,tmp2,v2,csound2)
    v2(ixo^s)=1.0d0-1.0d0/w(ixo^s,lfac_)**2
    vidim(ixo^s) = w(ixo^s, mom(idim))/w(ixo^s, lfac_)
    tmp2(ixo^s)=vidim(ixo^s)**2.0d0
    tmp1(ixo^s)=1.0d0-v2(ixo^s)*csound2(ixo^s) &
                        -tmp2(ixo^s)*(1.0d0-csound2(ixo^s))
    tmp2(ixo^s)=dsqrt(csound2(ixo^s)*(one-v2(ixo^s))*tmp1(ixo^s))
    tmp1(ixo^s)=vidim(ixo^s)*(one-csound2(ixo^s))
    cmax(ixo^s)=(tmp1(ixo^s)+tmp2(ixo^s))/(one-v2(ixo^s)*csound2(ixo^s))
    cmin(ixo^s)=(tmp1(ixo^s)-tmp2(ixo^s))/(one-v2(ixo^s)*csound2(ixo^s))
    ! Limit by speed of light
    cmin(ixo^s) = max(cmin(ixo^s), - 1.0d0)
    cmin(ixo^s) = min(cmin(ixo^s),   1.0d0)
    cmax(ixo^s) = max(cmax(ixo^s), - 1.0d0)
    cmax(ixo^s) = min(cmax(ixo^s),   1.0d0)
    ! now take extremal value only for dt limit
    cmax(ixo^s) = max(dabs(cmax(ixo^s)),dabs(cmin(ixo^s)))
 
  end subroutine srhd_get_cmax
 
  !> local version for recycling code when computing cmax-cmin
  subroutine srhd_get_cmax_loc(ixI^L,ixO^L,vidim,csound2,v2,cmax,cmin)
    use mod_global_parameters
    integer, intent(in)          :: ixi^l, ixo^l
    double precision, intent(in)             :: vidim(ixi^s)
    double precision, intent(in), dimension(ixO^S) :: csound2
    double precision, intent(in)             :: v2(ixi^s)
    double precision, intent(out)          :: cmax(ixi^s)
    double precision, intent(out)          :: cmin(ixi^s)
 
    double precision, dimension(ixI^S):: tmp1,tmp2
 
    tmp2(ixo^s)=vidim(ixo^s)**2.0d0
    tmp1(ixo^s)=1.0d0-v2(ixo^s)*csound2(ixo^s) &
                        -tmp2(ixo^s)*(1.0d0-csound2(ixo^s))
    tmp2(ixo^s)=dsqrt(csound2(ixo^s)*(one-v2(ixo^s))*tmp1(ixo^s))
    tmp1(ixo^s)=vidim(ixo^s)*(one-csound2(ixo^s))
    cmax(ixo^s)=(tmp1(ixo^s)+tmp2(ixo^s))/(one-v2(ixo^s)*csound2(ixo^s))
    ! Limit by speed of light
    cmax(ixo^s) = max(cmax(ixo^s), - 1.0d0)
    cmax(ixo^s) = min(cmax(ixo^s),   1.0d0)
    cmin(ixo^s)=(tmp1(ixo^s)-tmp2(ixo^s))/(one-v2(ixo^s)*csound2(ixo^s))
    ! Limit by speed of light
    cmin(ixo^s) = max(cmin(ixo^s), - 1.0d0)
    cmin(ixo^s) = min(cmin(ixo^s),   1.0d0)
 
  end subroutine srhd_get_cmax_loc
 
  !> Estimating bounds for the minimum and maximum signal velocities
  !> here we will not use Hspeed at all (one species only)
  subroutine srhd_get_cbounds(wLC,wRC,wLp,wRp,x,ixI^L,ixO^L,idim,Hspeed,cmax,cmin)
    use mod_global_parameters
    use mod_variables
 
    integer, intent(in)             :: ixi^l, ixo^l, idim
    ! conservative left and right status
    double precision, intent(in)    :: wlc(ixi^s, nw), wrc(ixi^s, nw)
    ! primitive left and right status
    double precision, intent(in)    :: wlp(ixi^s, nw), wrp(ixi^s, nw)
    double precision, intent(in)    :: x(ixi^s, 1:ndim)
    double precision, intent(inout) :: cmax(ixi^s,1:number_species)
    double precision, intent(inout), optional :: cmin(ixi^s,1:number_species)
    double precision, intent(in)    :: hspeed(ixi^s,1:number_species)
 
    double precision :: wmean(ixi^s,nw)
    double precision, dimension(ixO^S) :: csound2,tmp1,tmp2,tmp3
    double precision, dimension(ixI^S) :: vidim,cmaxl,cmaxr,cminl,cminr,v2
 
    logical       :: flag(ixi^s,1:nw)
 
    select case(boundspeed)
    case(1) ! we do left-right first and take maximals
      !!call srhd_check_w(.true.,ixI^L, ixO^L, wLp, flag)
      !!call srhd_check_w_aux(ixI^L, ixO^L, wLp, flag)
      tmp1=wlp(ixo^s,rho_)
      tmp2=wlp(ixo^s,xi_)/wlp(ixo^s,lfac_)**2.0d0
      tmp3=wlp(ixo^s,p_)
      call srhd_get_csound2_prim_eos(ixo^l,tmp1,tmp2,tmp3,csound2)
      vidim(ixo^s) = wlp(ixo^s, mom(idim))/wlp(ixo^s, lfac_)
      v2(ixo^s) = 1.0d0-1.0d0/wlp(ixo^s,lfac_)**2
      call srhd_get_cmax_loc(ixi^l,ixo^l,vidim,csound2,v2,cmaxl,cminl)
 
      !!call srhd_check_w(.true.,ixI^L, ixO^L, wRp, flag)
      !!call srhd_check_w_aux(ixI^L, ixO^L, wRp, flag)
      tmp1=wrp(ixo^s,rho_)
      tmp2=wrp(ixo^s,xi_)/wrp(ixo^s,lfac_)**2.0d0
      tmp3=wrp(ixo^s,p_)
      call srhd_get_csound2_prim_eos(ixo^l,tmp1,tmp2,tmp3,csound2)
      vidim(ixo^s) = wrp(ixo^s, mom(idim))/wrp(ixo^s, lfac_)
      v2(ixo^s) = 1.0d0-1.0d0/wrp(ixo^s,lfac_)**2
      call srhd_get_cmax_loc(ixi^l,ixo^l,vidim,csound2,v2,cmaxr,cminr)
 
      if(present(cmin))then
        ! for HLL
        cmax(ixo^s,1)=max(cmaxl(ixo^s),cmaxr(ixo^s))
        cmin(ixo^s,1)=min(cminl(ixo^s),cminr(ixo^s))
      else
        ! for TVDLF
        cmaxl(ixo^s)=max(cmaxl(ixo^s),dabs(cminl(ixo^s)))
        cmaxr(ixo^s)=max(cmaxr(ixo^s),dabs(cminr(ixo^s)))
        cmax(ixo^s,1)=max(cmaxl(ixo^s),cmaxr(ixo^s))
      endif
    case(2) ! this is cmaxmean from conservatives
      ! here we do arithmetic mean of conservative vars
      wmean(ixo^s,1:nwflux)=0.5d0*(wlc(ixo^s,1:nwflux)+wrc(ixo^s,1:nwflux))
      ! get auxiliary variables
      call srhd_get_auxiliary(ixi^l,ixo^l,wmean,x)
      ! here tmp1 is rhoh
      tmp1=wmean(ixo^s,xi_)/wmean(ixo^s,lfac_)**2.0d0
      call srhd_get_csound2_rhoh(wmean,x,ixi^l,ixo^l,tmp1,csound2)
      vidim(ixo^s) = wmean(ixo^s, mom(idim))/wmean(ixo^s, xi_)
      v2(ixo^s)=1.0d0-1.0d0/wmean(ixo^s,lfac_)**2
      call srhd_get_cmax_loc(ixi^l,ixo^l,vidim,csound2,v2,cmaxl,cminl)
      if(present(cmin)) then
        cmax(ixo^s,1)=cmaxl(ixo^s)
        cmin(ixo^s,1)=cminl(ixo^s)
      else
        cmax(ixo^s,1)=max(cmaxl(ixo^s),dabs(cminl(ixo^s)))
      endif
    case(3) ! this is cmaxmean from primitives
      ! here we do arithmetic mean of primitive vars
      wmean(ixo^s,1:nwflux)=0.5d0*(wlp(ixo^s,1:nwflux)+wrp(ixo^s,1:nwflux))
      ! get auxiliary variables for wmean (primitive array)
      call srhd_get_auxiliary_prim(ixi^l,ixo^l,wmean)
      ! here tmp1 is rhoh
      tmp1=wmean(ixo^s,rho_)
      tmp2=wmean(ixo^s,xi_)/wmean(ixo^s,lfac_)**2.0d0
      tmp3=wmean(ixo^s,p_)
      call srhd_get_csound2_prim_eos(ixo^l,tmp1,tmp2,tmp3,csound2)
      vidim(ixo^s) = wmean(ixo^s, mom(idim))/wmean(ixo^s, lfac_)
      v2(ixo^s) = 1.0d0-1.0d0/wmean(ixo^s,lfac_)**2
      call srhd_get_cmax_loc(ixi^l,ixo^l,vidim,csound2,v2,cmaxl,cminl)
      if(present(cmin)) then
        cmax(ixo^s,1)=cmaxl(ixo^s)
        cmin(ixo^s,1)=cminl(ixo^s)
      else
        cmax(ixo^s,1)=max(cmaxl(ixo^s),dabs(cminl(ixo^s)))
      endif
    end select
 
  end subroutine srhd_get_cbounds
 
  !> Calculate fluxes within ixO^L.
  subroutine srhd_get_flux(wC,wP,x,ixI^L,ixO^L,idim,f)
    use mod_global_parameters
    integer, intent(in)          :: ixi^l, ixo^l, idim
    ! conservative w
    double precision, intent(in) :: wc(ixi^s,nw)
    ! primitive w
    double precision, intent(in) :: wp(ixi^s,nw)
    double precision, intent(in) :: x(ixi^s,1:ndim)
    double precision,intent(out) :: f(ixi^s,nwflux)
 
    double precision             :: pth(ixi^s)
    double precision             :: v(ixi^s,1:ndir)
    integer                      :: iw,idir
 
    pth(ixo^s)=wp(ixo^s,p_)
    do idir=1,ndir
      v(ixo^s,idir) = wp(ixo^s, mom(idir))/wp(ixo^s,lfac_)
    end do 
 
    ! Get flux of density d, namely D*v 
    f(ixo^s,d_)=v(ixo^s,idim)*wc(ixo^s,rho_)
 
    ! Get flux of tracer
    do iw=1,srhd_n_tracer
      f(ixo^s,tracer(iw))=v(ixo^s,idim)*wc(ixo^s,tracer(iw))
    end do
 
    ! Get flux of momentum
    ! f_i[m_k]=v_i*m_k [+pth if i==k]
    do idir=1,ndir
      f(ixo^s,mom(idir))= v(ixo^s,idim)*wc(ixo^s,mom(idir))
    end do 
    f(ixo^s,mom(idim))=pth(ixo^s)+f(ixo^s,mom(idim))
 
    ! Get flux of energy
    ! f_i[e]=v_i*e+v_i*pth
    f(ixo^s,e_)=v(ixo^s,idim)*(wc(ixo^s,e_) + pth(ixo^s))
 
  end subroutine srhd_get_flux
 
  !> Add geometrical source terms to w
  subroutine srhd_add_source_geom(qdt, dtfactor, ixI^L, ixO^L, wCT, wprim, w, x)
    use mod_global_parameters
    use mod_usr_methods, only: usr_set_surface
    use mod_geometry
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: qdt, dtfactor, x(ixi^s, 1:ndim)
    double precision, intent(inout) :: wct(ixi^s, 1:nw), wprim(ixi^s, 1:nw), w(ixi^s, 1:nw)
 
    double precision :: pth(ixi^s), source(ixi^s), v(ixi^s,1:ndir)
    integer                         :: idir, h1x^l{^nooned, h2x^l}
    integer :: mr_,mphi_ ! Polar var. names
    double precision :: exp_factor(ixi^s), del_exp_factor(ixi^s), exp_factor_primitive(ixi^s)
 
    select case (coordinate)
 
    case(cartesian_expansion)
      !the user provides the functions of exp_factor and del_exp_factor
      if(associated(usr_set_surface)) &
        call usr_set_surface(ixi^l,x,block%dx,exp_factor,del_exp_factor,exp_factor_primitive)
      ! get auxiliary variables lfac and xi from conserved set
      call srhd_get_auxiliary(ixi^l,ixo^l,wct,x)
      call srhd_get_pthermal(wct, x, ixi^l, ixo^l, source)
      source(ixo^s) = source(ixo^s)*del_exp_factor(ixo^s)/exp_factor(ixo^s)
      w(ixo^s,mom(1)) = w(ixo^s,mom(1)) + qdt*source(ixo^s)
 
    case (cylindrical)
          mr_   = mom(r_)
          ! get auxiliary variables lfac and xi from conserved set
          call srhd_get_auxiliary(ixi^l,ixo^l,wct,x)
          call srhd_get_pthermal(wct, x, ixi^l, ixo^l, source)
          if (phi_ > 0) then
             mphi_ = mom(phi_)
             source(ixo^s) = source(ixo^s) + wct(ixo^s, mphi_)*wprim(ixo^s,mom(phi_))
             w(ixo^s, mr_) = w(ixo^s, mr_) + qdt * source(ixo^s) / x(ixo^s, r_)
             source(ixo^s) = -wct(ixo^s, mphi_) * wprim(ixo^s,mom(r_))
             w(ixo^s, mphi_) = w(ixo^s, mphi_) + qdt * source(ixo^s) / x(ixo^s, r_)
          else
             w(ixo^s, mr_) = w(ixo^s, mr_) + qdt * source(ixo^s) / x(ixo^s, r_)
          end if
 
    case (spherical)
       mr_   = mom(r_)
       h1x^l=ixo^l-kr(1,^d); {^nooned h2x^l=ixo^l-kr(2,^d);}
       ! s[mr]=((stheta*vtheta+sphi*vphi)+2*p)/r
       ! get auxiliary variables lfac and xi from conserved set
       call srhd_get_auxiliary(ixi^l,ixo^l,wct,x)
       call srhd_get_pthermal(wct, x, ixi^l, ixo^l, pth)
       source(ixo^s) = pth(ixo^s) * x(ixo^s, 1) &
            *(block%surfaceC(ixo^s, 1) - block%surfaceC(h1x^s, 1)) &
            /block%dvolume(ixo^s)
       if (ndir > 1) then
         do idir = 2, ndir
           source(ixo^s) = source(ixo^s) + wct(ixo^s, mom(idir))*wprim(ixo^s,mom(idir))
         end do
       end if
       w(ixo^s, mr_) = w(ixo^s, mr_) + qdt * source(ixo^s) / x(ixo^s, 1)
 
       {^nooned
       ! s[mtheta]=-(stheta*vr)/r+cot(theta)*(sphi*vphi+p)/r
       source(ixo^s) = pth(ixo^s) * x(ixo^s, 1) &
            * (block%surfaceC(ixo^s, 2) - block%surfaceC(h2x^s, 2)) &
            / block%dvolume(ixo^s)
       if (ndir == 3) then
          source(ixo^s) = source(ixo^s) + (wct(ixo^s, mom(3))*v(ixo^s,ndir)) / dtan(x(ixo^s, 2))
       end if
       source(ixo^s) = source(ixo^s) - wct(ixo^s, mom(2)) * wprim(ixo^s, mom(1))
       w(ixo^s, mom(2)) = w(ixo^s, mom(2)) + qdt * source(ixo^s) / x(ixo^s, 1)
 
       if (ndir == 3) then
         ! s[mphi]=-(sphi*vr)/r-cot(theta)*(sphi*vtheta)/r
         source(ixo^s) = -(wct(ixo^s, mom(3)) * wprim(ixo^s, mom(1))) &
                        - (wct(ixo^s, mom(3)) * wprim(ixo^s, mom(2))) / dtan(x(ixo^s, 2))
         w(ixo^s, mom(3)) = w(ixo^s, mom(3)) + qdt * source(ixo^s) / x(ixo^s, 1)
       end if
       }
    end select
 
  end subroutine srhd_add_source_geom
 
  !> handles bootstrapping
  subroutine srhd_handle_small_values(primitive, w, x, ixI^L, ixO^L, subname)
    use mod_global_parameters
    use mod_small_values
    logical, intent(in)             :: primitive
    integer, intent(in)             :: ixi^l,ixo^l
    double precision, intent(inout) :: w(ixi^s,1:nw)
    double precision, intent(in)    :: x(ixi^s,1:ndim)
    character(len=*), intent(in)    :: subname
 
    integer :: n,idir
    logical :: flag(ixi^s,1:nw),flagall(ixi^s)
 
    call srhd_check_w(primitive, ixi^l, ixo^l, w, flag)
 
    if (any(flag)) then
      select case (small_values_method)
      case ("replace")
        ! any faulty cell is replaced by physical lower limit
        flagall(ixo^s)=(flag(ixo^s,rho_).or.flag(ixo^s,e_)) 
 
        where(flagall(ixo^s))
           ! D or rho: no difference primitive-conservative
           w(ixo^s,rho_) = small_density
           !w(ixO^S,lfac_)= 1.0d0
           !w(ixO^S,xi_)  = small_xi
        endwhere
        !do idir = 1, ndir
        !   where(flagall(ixO^S)) w(ixO^S, mom(idir)) = 0.0d0
        !end do
        if(primitive) then
            where(flagall(ixo^s)) w(ixo^s, p_) = small_pressure
        else
            where(flagall(ixo^s)) w(ixo^s, e_) = small_e 
        endif
 
      case ("average")
        ! note: in small_values_average we use 
        ! small_values_fix_iw(1:nw) and small_values_daverage       
        ! when fails, may use small_pressure/small_density
        if(primitive)then
           ! averaging for all primitive fields (p, lfac*v, tau))
           call small_values_average(ixi^l, ixo^l, w, x, flag)
           ! update the auxiliaries from primitives
           call srhd_get_auxiliary_prim(ixi^l,ixo^l,w)
        else
           ! do averaging of density d
           call small_values_average(ixi^l, ixo^l, w, x, flag, d_)
           ! do averaging of energy tau
           call small_values_average(ixi^l, ixo^l, w, x, flag, e_)
           ! and now hope for the best....
        endif
      case default
        if(.not.primitive) then
          ! note that we throw error here, which assumes w is primitive
          write(*,*) "handle_small_values default: note reporting conservatives!"
        end if
        call small_values_error(w, x, ixi^l, ixo^l, flag, subname)
      end select
    end if
 
  end subroutine srhd_handle_small_values
 
  !> calculate effective gamma
  subroutine srhd_get_geff_eos(w,ixI^L,ixO^L,varconserve,Geff)
    use mod_global_parameters, only: nw
  !================== IMPORTANT ==================!
  !This subroutine is used with conserved variables in w when varconserve=T
  !This subroutine is used with primitive variables in w when varconserve=F
  !   both cases assume updated auxiliary variables xi_ en lfac_
  !===============================================!
    integer, intent(in)                :: ixi^l,ixo^l
    double precision, intent(in)       :: w(ixi^s, 1:nw)
    logical, intent(in)                :: varconserve
    double precision, intent(out)      :: geff(ixi^s)
 
    double precision, dimension(ixO^S) :: pth,rho,e_th,e
 
    if (srhd_eos) then
      if (varconserve) then
        pth(ixo^s)=w(ixo^s,xi_)-w(ixo^s,e_)-w(ixo^s,d_)
        rho(ixo^s)=w(ixo^s,d_)/w(ixo^s,lfac_)
        e_th = pth*inv_gamma_1
        e    = e_th+dsqrt(e_th**2+rho**2)
        geff(ixo^s) = srhd_gamma-half*gamma_1 *          &
                             (one-(rho(ixo^s)/e(ixo^s))**2)
      else
        ! primitives available
        e_th = w(ixo^s,p_)*inv_gamma_1
        e    = e_th+dsqrt(e_th**2+w(ixo^s,rho_)**2)
        geff(ixo^s) = srhd_gamma-half*gamma_1 *          &
                             (one-(w(ixo^s,rho_)/e(ixo^s))**2)
      end if
    else
      geff(ixo^s) = srhd_gamma
    endif
 
  end subroutine srhd_get_geff_eos
 
  !> Compute the small value limits
  subroutine srhd_get_smallvalues_eos
    use mod_global_parameters, only: small_pressure, small_density, small_e
    implicit none
    ! local small values
    double precision :: lsmalle,lsmallp,lsmallrho
 
    ! the maximal allowed Lorentz factor
    lfacmax=one/dsqrt(one-(one-dmaxvel)**2)
    minrho=small_density
    minp=small_pressure
    if(small_density*small_pressure<=0.0d0)then
       call mpistop("must set finite values small-density/pressure for small value treatments")
    endif
    if(srhd_eos)then
       lsmallp=(one+10.d0*small_pressure)*small_pressure
       lsmallrho=(one+10.d0*small_density)*small_density
       !!Lsmallp=small_pressure
       !!Lsmallrho=small_density
       lsmalle=lsmallp*inv_gamma_1+&
                dsqrt((lsmallp*inv_gamma_1)**2+lsmallrho**2)
       small_xi=half*((srhd_gamma+one)*lsmalle-&
                      gamma_1*lsmallrho*(lsmallrho/lsmalle))
       small_e=small_xi-lsmallp-lsmallrho
    else
       small_xi=small_density+gamma_to_gamma_1*small_pressure
       small_e =small_pressure*inv_gamma_1
    endif
    smallxi=small_xi
    smalltau=small_e
 
  end subroutine srhd_get_smallvalues_eos
 
  !> Compute the enthalpy rho*h from rho and pressure p
  subroutine srhd_get_enthalpy_eos(ixO^L,rho,p,rhoh)
    use mod_global_parameters
    integer, intent(in)                :: ixo^l
    double precision, intent(in)       :: rho(ixo^s),p(ixo^s)
    double precision, intent(out)      :: rhoh(ixo^s)
 
    double precision, dimension(ixO^S) :: e_th,e
    integer :: ix^d
 
    if(srhd_eos) then
     e_th = p*inv_gamma_1
     e    = e_th+dsqrt(e_th**2+rho**2)
     ! writing rho/E on purpose, for numerics 
     rhoh = half*((srhd_gamma+one)*e &
                   - gamma_1*rho*(rho/e))
    else
     rhoh = rho+gamma_to_gamma_1*p
    end if
 
    if (check_small_values) then
      {do ix^db= ixo^lim^db\}
         if(rhoh(ix^d)<small_xi) then
           write(*,*) "local pressure and density",p(ix^d),rho(ix^d)
           write(*,*) "Error: small value of enthalpy rho*h=",rhoh(ix^d),&
                " encountered when call srhd_get_enthalpy_eos"
           call mpistop('enthalpy below small_xi: stop (may need to turn on fixes)')
         end if
      {enddo^d&\}
    end if
 
    if (fix_small_values) then
      {do ix^db= ixo^lim^db\}
         if(rhoh(ix^d)<small_xi) then
            rhoh(ix^d)=small_xi
         endif
      {enddo^d&\}
    endif
 
  end subroutine srhd_get_enthalpy_eos
 
  !> Calculate thermal pressure p from density rho and enthalpy rho*h 
  !> will provide p (and E if srhd_eos)
  subroutine srhd_get_pressure_eos(ixI^L,ixO^L,rho,rhoh,p,E)
    use mod_global_parameters
    integer, intent(in)            :: ixi^l, ixo^l
    double precision, intent(in)   :: rho(ixo^s),rhoh(ixo^s)
    double precision, intent(out)  :: p(ixi^s)
    double precision, intent(out)  :: e(ixo^s)
    integer :: ix^d
 
    if(srhd_eos) then
     e = (rhoh+dsqrt(rhoh**2+(srhd_gamma**2-one)*rho**2)) &
         /(srhd_gamma+one)
     p(ixo^s) = half*gamma_1* (e-rho*(rho/e))
    else 
     p(ixo^s) = (rhoh-rho)/gamma_to_gamma_1
    end if 
 
    if (check_small_values) then
      {do ix^db= ixo^lim^db\}
         if(p(ix^d)<small_pressure) then
           write(*,*) "local enthalpy rho*h and density rho",rhoh(ix^d),rho(ix^d)
           if(srhd_eos) write(*,*) 'E, rho^2/E, difference', &
                       e(ix^d),rho(ix^d)**2/e(ix^d),e(ix^d)-rho(ix^d)**2/e(ix^d)
           write(*,*) "Error: small value of gas pressure",p(ix^d),&
                " encountered when call srhd_get_pressure_eos"
           call mpistop('pressure below small_pressure: stop (may need to turn on fixes)')
         end if
      {enddo^d&\}
    end if
 
    if (fix_small_values) then
      {do ix^db= ixo^lim^db\}
         if(p(ix^d)<small_pressure) then
            p(ix^d)=small_pressure
            if(srhd_eos)e(ix^d)=max(small_e,e(ix^d))
         endif
      {enddo^d&\}
    endif
 
  end subroutine srhd_get_pressure_eos
 
  !> Calculate the square of the thermal sound speed csound2 within ixO^L.
  !> available rho - rho*h 
  subroutine srhd_get_csound2_eos(ixI^L,ixO^L,rho,rhoh,csound2)
    use mod_global_parameters
    integer, intent(in)             :: ixi^l, ixo^l
    double precision, intent(in)    :: rho(ixo^s),rhoh(ixo^s)
    double precision, intent(out)   :: csound2(ixo^s)
 
    double precision                :: p(ixi^s)
    double precision                :: e(ixo^s)
    integer :: ix^d
 
    call srhd_get_pressure_eos(ixi^l,ixo^l,rho,rhoh,p,e)
    if(srhd_eos) then
       csound2(ixo^s)=(p(ixo^s)*((srhd_gamma+one)&
                          +gamma_1*(rho(ixo^s)/e(ixo^s))**2))&
                      /(2.0d0*rhoh(ixo^s))
    else
       csound2(ixo^s)=srhd_gamma*p(ixo^s)/rhoh(ixo^s)
    end if
 
    if (check_small_values) then
      {do ix^db= ixo^lim^db\}
         if(csound2(ix^d)>=1.0d0.or.csound2(ix^d)<=0.0d0) then
           write(*,*) "sound speed error with p - rho - rhoh",p(ix^d),rhoh(ix^d),rho(ix^d)
           if(srhd_eos) write(*,*) 'and E', e(ix^d)
           write(*,*) "Error: value of csound2",csound2(ix^d),&
                " encountered when call srhd_get_csound2_eos"
           call mpistop('sound speed stop (may need to turn on fixes)')
         end if
      {enddo^d&\}
    end if
 
    if (fix_small_values) then
      {do ix^db= ixo^lim^db\}
         if(csound2(ix^d)>=1.0d0) then
            csound2(ix^d)=1.0d0-1.0d0/lfacmax**2
         endif
         if(csound2(ix^d)<=0.0d0) then
            csound2(ix^d)=srhd_gamma*small_pressure/small_xi
         endif
      {enddo^d&\}
    endif
 
  end subroutine srhd_get_csound2_eos
 
  !> Calculate the square of the thermal sound speed csound2 within ixO^L.
  !> available rho - rho*h - p
  subroutine srhd_get_csound2_prim_eos(ixO^L,rho,rhoh,p,csound2)
    use mod_global_parameters
    integer, intent(in)             :: ixo^l
    double precision, intent(in)    :: rho(ixo^s),rhoh(ixo^s),p(ixo^s)
    double precision, intent(out)   :: csound2(ixo^s)
 
    double precision                :: e(ixo^s)
    integer :: ix^d
 
    if(srhd_eos) then
       e = (rhoh+dsqrt(rhoh**2+(srhd_gamma**2-one)&
            *rho**2))/(srhd_gamma+one)
       csound2(ixo^s)=(p*((srhd_gamma+one)&
                          +gamma_1*(rho/e)**2))&
                      /(2.0d0*rhoh)
    else
       csound2(ixo^s)=srhd_gamma*p/rhoh
    end if
 
    if (check_small_values) then
      {do ix^db= ixo^lim^db\}
         if(csound2(ix^d)>=1.0d0.or.csound2(ix^d)<=0.0d0) then
           write(*,*) "sound speed error with p - rho - rhoh",p(ix^d),rhoh(ix^d),rho(ix^d)
           if(srhd_eos) write(*,*) 'and E', e(ix^d)
           write(*,*) "Error: value of csound2",csound2(ix^d),&
                " encountered when call srhd_get_csound2_prim_eos"
           call mpistop('sound speed stop (may need to turn on fixes)')
         end if
      {enddo^d&\}
    end if
 
    if (fix_small_values) then
      {do ix^db= ixo^lim^db\}
         if(csound2(ix^d)>=1.0d0) then
            csound2(ix^d)=1.0d0-1.0d0/lfacmax**2
         endif
         if(csound2(ix^d)<=0.0d0) then
            csound2(ix^d)=srhd_gamma*small_pressure/small_xi
         endif
      {enddo^d&\}
    endif
 
  end subroutine srhd_get_csound2_prim_eos
 
  !> con2prim: (D,S**2,tau) --> compute auxiliaries lfac and xi
  subroutine con2prim_eos(lfac,xi,myd,myssqr,mytau,ierror)
    use mod_con2prim_vars
 
    double precision, intent(in)    :: myd, myssqr, mytau
    double precision, intent(inout) :: lfac, xi
    integer, intent(inout)          :: ierror
 
    ! .. local ..
    double precision:: f,df,lfacl
    !------------------------------------------------------------------
 
    ! Save the input-state in mod_con2prim_vars 
    d = myd; ssqr = myssqr; tau = mytau; 
 
    ierror=0
 
    ! Check if guess is close enough: gives f,df,lfacl
    if(xi>smallxi)then
    call funcd_eos(xi,f,df,lfacl,d,ssqr,tau,ierror)
    if (ierror == 0 .and. dabs(f/df)<absaccnr) then
       xi   = xi - f/df
       lfac = lfacl
       return
    else
       ierror = 0
    end if
    else
      write(*,*)'entering con2prim_eos with xi=',xi
    end if
 
    ! ierror=1 : must have D>=minrho, tau>=smalltau
    !if(d<minrho .or. tau<smalltau)then
    !   ierror=1
    !   return
    !endif
 
    call con2primhydro_eos(lfac,xi,d,ssqr,tau,ierror)
 
  end subroutine con2prim_eos
 
  subroutine funcd_eos(xi,f,df,mylfac,d,ssqr,tau,ierror)
    double precision, intent(in)  :: xi,d,ssqr,tau
    double precision, intent(out) :: f,df,mylfac
    integer, intent(inout)        :: ierror
 
    ! .. local ..
    double precision  :: dlfac
    double precision  :: vsqr,p,dpdxi
    !-----------------------------------------------------------------
 
    vsqr = ssqr/xi**2
 
    if (vsqr<one) then
       mylfac = one/dsqrt(one-vsqr)
       dlfac = -mylfac**3*ssqr/(xi**3)
       !===== Pressure, calculate using EOS =====!
       call funcpressure_eos(xi,mylfac,d,dlfac,p,dpdxi)
       !=========================================!
       f  = xi-tau-d-p
       df = one-dpdxi
    else
       ! print *,'Erroneous input to funcd since vsqr=',vsqr,' >=1'
       ! print *,'input values d, ssqr, tau:',d,ssqr,tau
       ierror =6
       return
    end if
 
  end subroutine funcd_eos
 
  !> SRHD iteration solves for p via NR, and then gives xi as output
  subroutine con2primhydro_eos(lfac,xi,d,sqrs,tau,ierror)
    double precision, intent(out) :: xi,lfac
    double precision, intent(in)  :: d,sqrs,tau
    integer,intent(inout)         :: ierror
 
    ! .. local ..
    integer          :: ni,niiter,nit,n2it,ni3
    double precision :: pcurrent,pnew
    double precision :: er,er1,ff,df,dp,v2
    double precision :: pmin,lfac2inv,plabs,prabs,pprev
    double precision :: s2overcubeg2rh
    double precision :: xicurrent,h,dhdp
    double precision :: oldff1,oldff2,nff
    double precision :: pleft,pright
    !---------------------------------------------------------------------
 
    ierror=0
    ! ierror=0 : ok
    !  we already checked D>=minrho, tau>=smalltau (ierror=1)
    !
    ! ierror<>0
    !
    ! ierror=2 : maxitnr reached without convergence
    ! ierror=3 : final pressure value < smallp or xi<smallxi during iteration
    ! ierror=4 : final v^2=1 hence problem as lfac=1/0
    ! ierror=5 : nonmonotonic function f (as df=0)
 
    ! left and right brackets for p-range
    pmin=dsqrt(sqrs)/(one-dmaxvel)-tau-d
    plabs=max(minp,pmin)
    prabs=1.0d99
    ! start value from input
    pcurrent=plabs
 
    er1=one
    pprev=pcurrent
 
    ! Fudge Parameters
    oldff1=1.0d7  ! High number
    oldff2=1.0d9  ! High number bigger then oldff1
    n2it = 0
    nit  = 0
 
    loopnr:  do ni=1,maxitnr
       nit = nit + 1
       !=== Relax NR iteration accuracy=======!
       if(nit>maxitnr/4)then
          ! mix pressure value for convergence
          pcurrent=half*(pcurrent+pprev)
          ! relax accuracy requirement
          er1=10.0d0*er1
          nit = nit - maxitnr/10
       endif
       !=======================================!
 
       niiter=ni
       xicurrent=tau+d+pcurrent
 
       if(xicurrent<smallxi) then
          !        print *,'stop: too small xi iterate:',xicurrent
          !        print *,'for pressure iterate p',pcurrent
          !        print *,'pressure bracket pLabs pRabs',pLabs,pRabs
          !        print *,'iteration number:',ni
          !        print *,'values for d,s,tau,s2:',d,sqrs,tau,sqrs
          ierror=3
          return
       endif
 
       v2=sqrs/xicurrent**2
       lfac2inv=one - v2
       if(lfac2inv>zero) then
          lfac=one/dsqrt(lfac2inv)
       else
          !        print *,'stop: negative or zero factor 1-v2:',lfac2inv
          !        print *,'for pressure iterate p',pcurrent
          !        print *,'absolute pressure bracket pLabs pRabs',pLabs,pRabs
          !        print *,'iteration number:',ni
          !        print *,'values for d,s,tau,s2:',d,sqrs,tau,sqrs
          !        print *,'values for v2,xi:',v2,xicurrent
          ierror=4
          return
       endif
 
       s2overcubeg2rh=sqrs/(xicurrent**3)
       !== calculation done using the EOS ==!
       call funcenthalpy_eos(pcurrent,lfac2inv,d,sqrs,xicurrent,&
                          s2overcubeg2rh,h,dhdp)
       !=======================================!
       ff=-xicurrent*lfac2inv + h
       df=- two*sqrs/xicurrent**2  + dhdp - lfac2inv
 
       if (ff*df==zero) then
          if (ff==zero) then
             exit ! zero found
          else
             !     print *,'stop: df becomes zero, non-monotonic f(p)!'
             ierror=5
             return
          endif
       else
          pnew=pcurrent-ff/df
          if (ff*df>zero) then
             ! pressure iterate has decreased
             ! restrict to left
             pnew=max(pnew,plabs)
          else  ! ff*df<0
             ! pressure iterate has increased
             ! restrict to right
             pnew=min(pnew,prabs)
          endif
       endif
 
       !===============================================!
       dp=pcurrent-pnew
       er=two*dabs(dp)/(pnew+pcurrent)
       if(((er<tolernr*er1).or.(dabs(dp)<absaccnr))) exit loopnr
       !===============================================!
 
       ! For very small values of pressure, NR algorithm is not efficient to
       ! find root, use Euler algorithm to find precise value of pressure
       if((dabs(oldff2-ff) < 1.0d-8 .or. niiter >= maxitnr-maxitnr/20).and.&
            ff * oldff1 < zero    .and.  dabs(ff)>absaccnr)then
 
          n2it=n2it+1
          if(n2it<=3) pcurrent=half*(pnew+pcurrent)
          if(n2it>3)then
             pright =pcurrent
             pleft=pprev
             pcurrent=half*(pleft+pright)
             dicho:  do ni3=1,maxitnr
                !===================!
                xicurrent=tau+d+pcurrent
                v2=sqrs/xicurrent**2
                lfac2inv=one - v2
 
                if(lfac2inv>zero)then
                   lfac=one/dsqrt(lfac2inv)
                else
                   ierror=4
                   return
                endif
                !===================!
 
                !== calculation done using the EOS ==!
                call bisection_enthalpy_eos(pnew,lfac2inv,d,xicurrent,h)
                nff=-xicurrent*lfac2inv + h
                !=======================================!
                !==== Iterate ====!
                if(ff * nff < zero)then
                   pleft=pcurrent
                else
                   pright=pcurrent
                endif
 
                pcurrent=half*(pleft+pright)
                !==================!
 
                !=== The iteration converged ===!
                if(2.0d0*dabs(pleft-pright)/(pleft+pright)< absaccnr &
                     .or. dabs(ff)<absaccnr)then
                   pnew=pcurrent
                   exit loopnr
                endif
                !==============================!
 
                !==============================!
 
                !=== conserve the last value of Nff ===!
                ff=nff
                !======================================!
             enddo    dicho
          endif
 
       else
          !====== There is no problems, continue the NR iteration ======!
          pprev=pcurrent
          pcurrent=pnew
          !=============================================================!
       endif
 
 
       !=== keep the values of the 2 last ff ===!
       oldff2=oldff1
       oldff1=ff
       !========================================!
    enddo loopnr
 
    if(niiter==maxitnr)then
       ierror=2
       return
    endif
 
    if(pcurrent<minp) then
       ierror=3
       return
    endif
 
    !------------------------------!
    xi=tau+d+pcurrent
    v2=sqrs/xicurrent**2
    lfac2inv=one - v2
    if(lfac2inv>zero) then
       lfac=one/dsqrt(lfac2inv)
    else
       ierror=4
       return
    endif
 
  end subroutine con2primhydro_eos
 
  !> pointwise evaluations used in con2prim
  !> compute pointwise value for pressure p and dpdxi
  subroutine funcpressure_eos(xicurrent,lfac,d,dlfacdxi,p,dpdxi)
 
    double precision, intent(in)         :: xicurrent,lfac,d,dlfacdxi
    double precision, intent(out)        :: p,dpdxi
    ! .. local ..
    double precision                     :: rho,h,e,dhdxi,rhotoe
    double precision                     :: dpdchi,dedxi
 
    ! rhoh here called h
    h=xicurrent/(lfac**2)
    rho=d/lfac
    e = (h+dsqrt(h**2+(srhd_gamma**2-one)*rho**2)) &
              /(srhd_gamma+one)
    ! output pressure
    rhotoe = rho/e
    p = half*gamma_1*(e-rho*rhotoe)
 
    dhdxi = one/(lfac**2)-2.0d0*xicurrent/(lfac**2)*dlfacdxi/lfac
 
    dedxi=(dhdxi+(h*dhdxi-(srhd_gamma**2-one)*rho**2*dlfacdxi/lfac)&
        /dsqrt(h**2+(srhd_gamma**2-one)*rho**2))&
        /(srhd_gamma+one)
 
    ! output pressure derivative to xi
    dpdxi=half*gamma_1*(2.0d0*rho*rhotoe*dlfacdxi/lfac+&
          (one+rhotoe**2)*dedxi)
 
  end subroutine funcpressure_eos
 
  !> pointwise evaluations used in con2prim
  !> returns enthalpy rho*h (h) and derivative d(rho*h)/dp (dhdp)
  subroutine funcenthalpy_eos(pcurrent,lfac2inv,d,sqrs,xicurrent,dv2d2p,h,dhdp)
 
    double precision, intent(in) :: pcurrent,lfac2inv,d,sqrs,xicurrent,dv2d2p
    double precision, intent(out):: h,dhdp
 
    ! local
    double precision:: rho,e_th,e,de_thdp,dedp
 
    rho=d*dsqrt(lfac2inv)
    e_th = pcurrent*inv_gamma_1
    e = (e_th + dsqrt(e_th**2+rho**2))
    !== Enthalpy ==!
    h = half*((srhd_gamma+one)*e-gamma_1*rho*(rho/e))
    !=== Derivative of thermal energy ===!
    de_thdp = one*inv_gamma_1
    !=== Derivative of internal energy ===!
    dedp = de_thdp * (one+e_th/dsqrt(e_th**2+rho**2))&
              +  d**2*dv2d2p/dsqrt(e_th**2+rho**2)
    !====== Derivative of Enthalpy ======!
    dhdp = half*((srhd_gamma+one)*dedp + &
              gamma_1*(rho*(rho/e))*(-2.0d0*dv2d2p/lfac2inv+dedp/e))
  end subroutine funcenthalpy_eos
 
  !> pointwise evaluations used in con2prim
  !> returns enthalpy rho*h (h)
  subroutine bisection_enthalpy_eos(pcurrent,lfac2inv,d,xicurrent,h)
 
    double precision, intent(in) :: pcurrent,lfac2inv,d,xicurrent
    double precision, intent(out):: h
 
    ! local
    double precision:: rho,e_th,e
 
    rho=d*dsqrt(lfac2inv)
    e_th = pcurrent*inv_gamma_1
    e = (e_th + dsqrt(e_th**2+rho**2))
    !== Enthalpy ==!
    h = half*((srhd_gamma+one)*e-gamma_1*rho*(rho/e))
 
    return
  end subroutine bisection_enthalpy_eos
 
  !> con2prim: (D,S**2,tau) --> compute auxiliaries lfac and xi
  subroutine con2prim(lfac,xi,myd,myssqr,mytau,ierror)
    use mod_con2prim_vars
 
    double precision, intent(in)    :: myd, myssqr, mytau
    double precision, intent(inout) :: lfac, xi
    integer, intent(inout)          :: ierror
 
    ! .. local ..
    double precision:: f,df,lfacl
    !------------------------------------------------------------------
 
    ! Save the input-state in mod_con2prim_vars 
    d = myd; ssqr = myssqr; tau = mytau; 
 
    ierror=0
 
    ! Check if guess is close enough: gives f,df,lfacl
    if(xi>smallxi)then
    call funcd(xi,f,df,lfacl,d,ssqr,tau,ierror)
    if (ierror == 0 .and. dabs(f/df)<absaccnr) then
       xi   = xi - f/df
       lfac = lfacl
       return
    else
       ierror = 0
    end if
    else
       write(*,*) 'entering con2prim with xi=',xi
    end if
 
    ! ierror=1 : must have D>=minrho, tau>=smalltau
    !if(d<minrho .or. tau<smalltau)then
    !   ierror=1
    !   return
    !endif
 
    call con2primhydro(lfac,xi,d,ssqr,tau,ierror)
 
  end subroutine con2prim
 
  subroutine funcd(xi,f,df,mylfac,d,ssqr,tau,ierror)
    double precision, intent(in)  :: xi,d,ssqr,tau
    double precision, intent(out) :: f,df,mylfac
    integer, intent(inout)        :: ierror
 
    ! .. local ..
    double precision  :: dlfac
    double precision  :: vsqr,p,dpdxi
    !-----------------------------------------------------------------
 
    vsqr = ssqr/xi**2
 
    if (vsqr<one) then
       mylfac = one/dsqrt(one-vsqr)
       dlfac = -mylfac**3*ssqr/(xi**3)
       !===== Pressure, calculate using EOS =====!
       call funcpressure(xi,mylfac,d,dlfac,p,dpdxi)
       !=========================================!
       f  = xi-tau-d-p
       df = one-dpdxi
    else
       ! print *,'Erroneous input to funcd since vsqr=',vsqr,' >=1'
       ! print *,'input values d, ssqr, tau:',d,ssqr,tau
       ierror =6
       return
    end if
 
  end subroutine funcd
 
  !> SRHD iteration solves for p via NR, and then gives xi as output
  subroutine con2primhydro(lfac,xi,d,sqrs,tau,ierror)
    double precision, intent(out) :: xi,lfac
    double precision, intent(in)  :: d,sqrs,tau
    integer,intent(inout)         :: ierror
 
    ! .. local ..
    integer          :: ni,niiter,nit,n2it,ni3
    double precision :: pcurrent,pnew
    double precision :: er,er1,ff,df,dp,v2
    double precision :: pmin,lfac2inv,plabs,prabs,pprev
    double precision :: s2overcubeg2rh
    double precision :: xicurrent,h,dhdp
    double precision :: oldff1,oldff2,nff
    double precision :: pleft,pright
    !---------------------------------------------------------------------
 
    ierror=0
    ! ierror=0 : ok
    !  we already checked D>=minrho, tau>=smalltau (ierror=1)
    !
    ! ierror<>0
    !
    ! ierror=2 : maxitnr reached without convergence
    ! ierror=3 : final pressure value < smallp or xi<smallxi during iteration
    ! ierror=4 : final v^2=1 hence problem as lfac=1/0
    ! ierror=5 : nonmonotonic function f (as df=0)
 
    ! left and right brackets for p-range
    pmin=dsqrt(sqrs)/(one-dmaxvel)-tau-d
    plabs=max(minp,pmin)
    prabs=1.0d99
    ! start value from input
    pcurrent=plabs
 
    er1=one
    pprev=pcurrent
 
    ! Fudge Parameters
    oldff1=1.0d7  ! High number
    oldff2=1.0d9  ! High number bigger then oldff1
    n2it = 0
    nit  = 0
 
    loopnr:  do ni=1,maxitnr
       nit = nit + 1
       !=== Relax NR iteration accuracy=======!
       if(nit>maxitnr/4)then
          ! mix pressure value for convergence
          pcurrent=half*(pcurrent+pprev)
          ! relax accuracy requirement
          er1=10.0d0*er1
          nit = nit - maxitnr/10
       endif
       !=======================================!
 
       niiter=ni
       xicurrent=tau+d+pcurrent
 
       if(xicurrent<smallxi) then
          !        print *,'stop: too small xi iterate:',xicurrent
          !        print *,'for pressure iterate p',pcurrent
          !        print *,'pressure bracket pLabs pRabs',pLabs,pRabs
          !        print *,'iteration number:',ni
          !        print *,'values for d,s,tau,s2:',d,sqrs,tau,sqrs
          ierror=3
          return
       endif
 
       v2=sqrs/xicurrent**2
       lfac2inv=one - v2
       if(lfac2inv>zero) then
          lfac=one/dsqrt(lfac2inv)
       else
          !        print *,'stop: negative or zero factor 1-v2:',lfac2inv
          !        print *,'for pressure iterate p',pcurrent
          !        print *,'absolute pressure bracket pLabs pRabs',pLabs,pRabs
          !        print *,'iteration number:',ni
          !        print *,'values for d,s,tau,s2:',d,sqrs,tau,sqrs
          !        print *,'values for v2,xi:',v2,xicurrent
          ierror=4
          return
       endif
 
       s2overcubeg2rh=sqrs/(xicurrent**3)
       !== calculation done using the EOS ==!
       call funcenthalpy(pcurrent,lfac2inv,d,sqrs,xicurrent,&
                          s2overcubeg2rh,h,dhdp)
       !=======================================!
       ff=-xicurrent*lfac2inv + h
       df=- two*sqrs/xicurrent**2  + dhdp - lfac2inv
 
       if (ff*df==zero) then
          if (ff==zero) then
             exit ! zero found
          else
             !     print *,'stop: df becomes zero, non-monotonic f(p)!'
             ierror=5
             return
          endif
       else
          pnew=pcurrent-ff/df
          if (ff*df>zero) then
             ! pressure iterate has decreased
             ! restrict to left
             pnew=max(pnew,plabs)
          else  ! ff*df<0
             ! pressure iterate has increased
             ! restrict to right
             pnew=min(pnew,prabs)
          endif
       endif
 
       !===============================================!
       dp=pcurrent-pnew
       er=two*dabs(dp)/(pnew+pcurrent)
       if(((er<tolernr*er1).or.(dabs(dp)<absaccnr))) exit loopnr
       !===============================================!
 
       ! For very small values of pressure, NR algorithm is not efficient to
       ! find root, use Euler algorithm to find precise value of pressure
       if((dabs(oldff2-ff) < 1.0d-8 .or. niiter >= maxitnr-maxitnr/20).and.&
            ff * oldff1 < zero    .and.  dabs(ff)>absaccnr)then
 
          n2it=n2it+1
          if(n2it<=3) pcurrent=half*(pnew+pcurrent)
          if(n2it>3)then
             pright =pcurrent
             pleft=pprev
             pcurrent=half*(pleft+pright)
             dicho:  do ni3=1,maxitnr
                !===================!
                xicurrent=tau+d+pcurrent
                v2=sqrs/xicurrent**2
                lfac2inv=one - v2
 
                if(lfac2inv>zero)then
                   lfac=one/dsqrt(lfac2inv)
                else
                   ierror=4
                   return
                endif
                !===================!
 
                !== calculation done using the EOS ==!
                call bisection_enthalpy(pnew,lfac2inv,d,xicurrent,h)
                nff=-xicurrent*lfac2inv + h
                !=======================================!
                !==== Iterate ====!
                if(ff * nff < zero)then
                   pleft=pcurrent
                else
                   pright=pcurrent
                endif
 
                pcurrent=half*(pleft+pright)
                !==================!
 
                !=== The iteration converged ===!
                if(2.0d0*dabs(pleft-pright)/(pleft+pright)< absaccnr &
                     .or. dabs(ff)<absaccnr)then
                   pnew=pcurrent
                   exit loopnr
                endif
                !==============================!
 
                !==============================!
 
                !=== conserve the last value of Nff ===!
                ff=nff
                !======================================!
             enddo    dicho
          endif
 
       else
          !====== There is no problems, continue the NR iteration ======!
          pprev=pcurrent
          pcurrent=pnew
          !=============================================================!
       endif
 
 
       !=== keep the values of the 2 last ff ===!
       oldff2=oldff1
       oldff1=ff
       !========================================!
    enddo loopnr
 
    if(niiter==maxitnr)then
       ierror=2
       return
    endif
 
    if(pcurrent<minp) then
       ierror=3
       return
    endif
 
    !------------------------------!
    xi=tau+d+pcurrent
    v2=sqrs/xicurrent**2
    lfac2inv=one - v2
    if(lfac2inv>zero) then
       lfac=one/dsqrt(lfac2inv)
    else
       ierror=4
       return
    endif
 
  end subroutine con2primhydro
 
  !> pointwise evaluations used in con2prim
  !> compute pointwise value for pressure p and dpdxi
  subroutine funcpressure(xicurrent,lfac,d,dlfacdxi,p,dpdxi)
 
    double precision, intent(in)         :: xicurrent,lfac,d,dlfacdxi
    double precision, intent(out)        :: p,dpdxi
    ! .. local ..
    double precision                     :: rho,h,e,dhdxi,rhotoe
    double precision                     :: dpdchi,dedxi
 
    ! rhoh here called h
    h=xicurrent/(lfac**2)
    rho=d/lfac
    ! output pressure
    p = (h - rho)/gamma_to_gamma_1
    dpdchi = one/gamma_to_gamma_1
    dpdxi = dpdchi * one/lfac**2
    ! zero case dlfacdxi implies zero velocity (ssqr=0)
    if (dlfacdxi /= 0.0d0) &
          dpdxi = dpdxi  + dpdchi * ((d*lfac-2.0d0*xicurrent)/lfac**3) * dlfacdxi
 
  end subroutine funcpressure
 
  !> pointwise evaluations used in con2prim
  !> returns enthalpy rho*h (h) and derivative d(rho*h)/dp (dhdp)
  subroutine funcenthalpy(pcurrent,lfac2inv,d,sqrs,xicurrent,dv2d2p,h,dhdp)
 
    double precision, intent(in) :: pcurrent,lfac2inv,d,sqrs,xicurrent,dv2d2p
    double precision, intent(out):: h,dhdp
 
    ! local
    double precision:: rho,e_th,e,de_thdp,dedp
 
    rho=d*dsqrt(lfac2inv)
    h = rho + gamma_to_gamma_1 * pcurrent
    dhdp = gamma_to_gamma_1 + d/dsqrt(lfac2inv)*sqrs/xicurrent**3
  end subroutine funcenthalpy
 
  !> pointwise evaluations used in con2prim
  !> returns enthalpy rho*h (h)
  subroutine bisection_enthalpy(pcurrent,lfac2inv,d,xicurrent,h)
 
    double precision, intent(in) :: pcurrent,lfac2inv,d,xicurrent
    double precision, intent(out):: h
 
    ! local
    double precision:: rho,e_th,e
 
    rho=d*dsqrt(lfac2inv)
    h = rho + gamma_to_gamma_1 * pcurrent
 
    return
  end subroutine bisection_enthalpy
 
end module mod_srhd_phys