mod_eos_shared_functions.t

Go to the documentation of this file.

!=============================================================================
!> Shared EoS accessors (EoS-type-agnostic) for the eos% family.
!>
!> Carved out of mod_eos.t (the per-type split). These operate on `eos` and the
!> conserved/primitive state without committing to FI / LTE / PI, so they are
!> the common dependency that mod_eos_FI / mod_eos_LTE / mod_eos_PI and the
!> orchestrating mod_eos all draw on -- keeping the type-specific modules free
!> of any back-dependency on mod_eos (no circular use). mod_eos re-exports the
!> public names so existing `use mod_eos` callers are unaffected.
!=============================================================================
module mod_eos_shared_functions
    use mod_global_parameters
    use mod_eos_container
 
    implicit none
    private
 
    public :: get_rho, get_nh, get_ne_nh
    public :: get_temperature_from_etot
    public :: eos_get_log_t_floor
 
contains
 
    !> Mass density (code units).
    !>
    !> Under equilibrium splitting (iw_equi_rho>0) the rho slot carries only the
    !> perturbation about the static background, so the background is added back
    !> here. This is the single place that check lives: get_nH and get_ne_nH both
    !> route through this routine rather than reading the rho slot themselves.
    subroutine get_rho(w,x,ixI^L,ixO^L,rho)
        integer, intent(in)           :: ixi^l, ixo^l
        double precision, intent(in)  :: w(ixi^s,1:nw)
        double precision, intent(in)  :: x(ixi^s,1:ndim)
        double precision, intent(out) :: rho(ixi^s)
 
        if (iw_equi_rho > 0) then
            rho(ixo^s) = w(ixo^s,iw_rho) &
                 + block%equi_vars(ixo^s,iw_equi_rho,b0i)
        else
            rho(ixo^s) = w(ixo^s,iw_rho)
        end if
 
    end subroutine get_rho
 
    !> Hydrogen number density: nH = rho / nH2rhoFactor.
    subroutine get_nh(w,x,ixI^L,ixO^L,nH)
        integer, intent(in)           :: ixi^l, ixo^l
        double precision, intent(in)  :: w(ixi^s,1:nw)
        double precision, intent(in)  :: x(ixi^s,1:ndim)
        double precision, intent(out) :: nh(ixi^s)
 
        call get_rho(w,x,ixi^l,ixo^l,nh)
        nh(ixo^s) = nh(ixo^s) / eos%nH2rhoFactor
 
    end subroutine get_nh
 
    !> Return electron and hydrogen number densities in code units.
    !> For LTE (iw_ne allocated): ne from Saha EoS, nH from rho/nH2rhoFactor.
    !> For FI  (iw_ne not allocated): ne = nH * neOnH_FI (full ionisation).
    !>
    !> x is unused here but keeps the signature uniform with get_rho/get_nH, so
    !> the density can be taken from get_nH and the equilibrium-splitting check
    !> stays in get_rho alone.
    subroutine get_ne_nh(ixI^L, ixO^L, w, x, ne, nH)
        integer, intent(in)           :: ixi^l, ixo^l
        double precision, intent(in)  :: w(ixi^s, 1:nw)
        double precision, intent(in)  :: x(ixi^s, 1:ndim)
        double precision, intent(out) :: ne(ixi^s), nh(ixi^s)
 
        call get_nh(w, x, ixi^l, ixo^l, nh)
        if (iw_ne > 0) then
            ne(ixo^s) = w(ixo^s, iw_ne)
        else
            ne(ixo^s) = nh(ixo^s) * eos%neOnH_FI
        end if
    end subroutine get_ne_nh
 
    !> Temperature from the TOTAL energy: strip kinetic (+magnetic) energy via
    !> phys_e_to_ei, then delegate to the type-specific eos%get_temperature_from_eint.
    subroutine get_temperature_from_etot(w, x, ixI^L, ixO^L, res)
        use mod_physics
        integer, intent(in)             :: ixi^l,ixo^l
        double precision, intent(in)    :: x(ixi^s,1:ndim)
        double precision, intent(in)    :: w(ixi^s,1:nw)
        double precision, intent(out)   :: res(ixi^s)
        double precision :: wlocal(ixi^s,1:nw)
 
        !> No timing here: get_temperature_from_eint is already timed.
        !> The array copy and e_to_ei subtraction are trivial.
        wlocal(ixi^s,1:nw)=w(ixi^s,1:nw)
        call phys_e_to_ei(ixi^l, ixo^l, wlocal, x)
        call eos%get_temperature_from_eint(wlocal, x, ixi^l, ixo^l, res)
 
    end subroutine get_temperature_from_etot
 
    !> Lower log10(T) bound for the (rho,T) inverse table; FI (no tables) floors
    !> at log10(smalldouble). Used by the TC fluid-port log_T_floor.
    double precision function eos_get_log_t_floor() result(log_T_min)
        if (eos%method_id == eos_entropy .and. allocated(eos%eintT%table)) then
            log_t_min = eos%eintT%var2_min
        else if (allocated(eos%eint_from_T%table)) then
            log_t_min = eos%eint_from_T%var2_min
        else
            log_t_min = dlog10(smalldouble)
        end if
    end function eos_get_log_t_floor
 
end module mod_eos_shared_functions