ERF_MicrophysicsUtils.H File Reference

#include <algorithm>
#include <cmath>
#include <limits>
#include <vector>
#include <AMReX_REAL.H>
#include <AMReX_Array.H>
#include <ERF_Constants.H>
#include "ERF_EOS.H"

Include dependency graph for ERF_MicrophysicsUtils.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MicrophysicsThermoState

Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE MicrophysicsThermoState	diagnose_microphysics_thermo_state (const amrex::Real rho, const amrex::Real rho_theta, const amrex::Real qv, const amrex::Real rdOcp, const bool use_anelastic_reference_pressure, const amrex::Real p0) noexcept
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_gammafff (amrex::Real x)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_esati (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_esatw_cc (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_esatw_flatau_poly (amrex::Real dtt)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_dtesatw_flatau_poly (amrex::Real dtt)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	erf_use_positive_esatw_poly (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_esatw (amrex::Real t, bool use_empirical=false)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_dtesati (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_dtesatw_cc (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_dtesatw (amrex::Real t)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_qsat_from_esat (amrex::Real esat, amrex::Real p)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	erf_dtqsat_from_esat (amrex::Real esat, amrex::Real dtesat, amrex::Real p)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	erf_qsati (amrex::Real t, amrex::Real p, amrex::Real &qsati)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	erf_qsatw (amrex::Real t, amrex::Real p, amrex::Real &qsatw)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	erf_dtqsati (amrex::Real t, amrex::Real p, amrex::Real &dtqsati)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	erf_dtqsatw (amrex::Real t, amrex::Real p, amrex::Real &dtqsatw)

Function Documentation

diagnose_microphysics_thermo_state()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE MicrophysicsThermoState diagnose_microphysics_thermo_state ( const amrex::Real  rho, const amrex::Real  rho_theta, const amrex::Real  qv, const amrex::Real  rdOcp, const bool  use_anelastic_reference_pressure, const amrex::Real  p0  )

noexcept

Diagnose the state used by one Eulerian microphysics cell.

In anelastic mode, the conserved state supplies theta while the hydrostatic reference pressure supplied by BaseState supplies the thermodynamic pressure. In compressible mode, retain ERF's existing local-EOS diagnosis.

{
    if (use_anelastic_reference_pressure) {
        const amrex::Real theta = rho_theta / rho;
        return {p0, getTgivenPandTh(p0, theta, rdOcp)};
    }
 
    return {getPgivenRTh(rho_theta, qv),
            getTgivenRandRTh(rho, rho_theta, qv)};
}

Referenced by kessler_copy_state_to_micro_cell(), morrison_copy_state_to_micro_cell(), sam_cons_to_primitive_with_base_state(), wdm6_copy_state_to_micro_cell(), and wsm6_copy_state_to_micro_cell().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_dtesati()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesati

(

amrex::Real

t

)

                                    {
    amrex::Real const a0 = amrex::Real(0.503223089);
    amrex::Real const a1 = amrex::Real(0.377174432e-1);
    amrex::Real const a2 = amrex::Real(0.126710138e-2);
    amrex::Real const a3 = amrex::Real(0.249065913e-4);
    amrex::Real const a4 = amrex::Real(0.312668753e-6);
    amrex::Real const a5 = amrex::Real(0.255653718e-8);
    amrex::Real const a6 = amrex::Real(0.132073448e-10);
    amrex::Real const a7 = amrex::Real(0.390204672e-13);
    amrex::Real const a8 = amrex::Real(0.497275778e-16);
 
    amrex::Real dtt = t-amrex::Real(273.16);
    const amrex::Real tol = amrex::Real(16.0) * std::numeric_limits<amrex::Real>::epsilon();
    AMREX_ALWAYS_ASSERT(dtt >= -amrex::Real(85.0) - tol);
    amrex::Real dtesati;
    if (dtt > amrex::Real(0)) {
        dtesati = amrex::Real(0);
    } else {
        dtesati = a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
    }
    return dtesati;
}

Referenced by erf_dtqsati().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_dtesatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesatw

(

amrex::Real

t

)

                                    {
    if (erf_use_positive_esatw_poly(t)) {
        return erf_dtesatw_flatau_poly(t - amrex::Real(273.16));
    }
 
    return erf_dtesatw_cc(t);
}

Referenced by erf_dtqsatw().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_dtesatw_cc()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesatw_cc

(

amrex::Real

t

)

                                       {
    constexpr amrex::Real svp1  = amrex::Real(0.6112);
    constexpr amrex::Real svp2  = amrex::Real(17.67);
    constexpr amrex::Real svp3  = amrex::Real(29.65);
    constexpr amrex::Real svpt0 = amrex::Real(273.15);
    amrex::Real dtesatw = amrex::Real(10.0) * svp1 * svp2 * std::exp(svp2 * (t - svpt0) / (t - svp3))
                        * (svpt0 - svp3) / ((t - svp3) * (t - svp3));
    return dtesatw;
}

Referenced by erf_dtesatw().

Here is the caller graph for this function:

erf_dtesatw_flatau_poly()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesatw_flatau_poly

(

amrex::Real

dtt

)

{
    amrex::Real const a0 = amrex::Real(0.443956472);
    amrex::Real const a1 = amrex::Real(0.285976452e-1);
    amrex::Real const a2 = amrex::Real(0.794747212e-3);
    amrex::Real const a3 = amrex::Real(0.121167162e-4);
    amrex::Real const a4 = amrex::Real(0.103167413e-6);
    amrex::Real const a5 = amrex::Real(0.385208005e-9);
    amrex::Real const a6 = -amrex::Real(0.604119582e-12);
    amrex::Real const a7 = -amrex::Real(0.792933209e-14);
    amrex::Real const a8 = -amrex::Real(0.599634321e-17);
 
    return a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
}

Referenced by erf_dtesatw().

Here is the caller graph for this function:

erf_dtqsat_from_esat()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtqsat_from_esat	(	amrex::Real	esat,
		amrex::Real	dtesat,
		amrex::Real	p
	)

{
    if ((p - esat) >= esat) {
        amrex::Real const denom = p - esat;
        return RdoRv * dtesat * p / (denom * denom);
    }
 
    return amrex::Real(0);
}

Referenced by erf_dtqsati(), and erf_dtqsatw().

Here is the caller graph for this function:

erf_dtqsati()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void erf_dtqsati	(	amrex::Real	t,
		amrex::Real	p,
		amrex::Real &	dtqsati
	)

                                                                {
    amrex::Real esati   = erf_esati(t);
    amrex::Real dtesati = erf_dtesati(t);
    dtqsati = erf_dtqsat_from_esat(esati, dtesati, p);
}

Referenced by SAM::NewtonIterSat().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_dtqsatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void erf_dtqsatw	(	amrex::Real	t,
		amrex::Real	p,
		amrex::Real &	dtqsatw
	)

                                                                {
    amrex::Real esatw   = erf_esatw(t);
    amrex::Real dtesatw = erf_dtesatw(t);
    dtqsatw = erf_dtqsat_from_esat(esatw, dtesatw, p);
}

Referenced by Kessler::AdvanceKessler(), SAM::NewtonIterSat(), and SatAdj::NewtonSolveSatTemperature().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_esati()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_esati

(

amrex::Real

t

)

                                  {
    amrex::Real const a0 = amrex::Real(6.11147274);
    amrex::Real const a1 = amrex::Real(0.503160820);
    amrex::Real const a2 = amrex::Real(0.188439774e-1);
    amrex::Real const a3 = amrex::Real(0.420895665e-3);
    amrex::Real const a4 = amrex::Real(0.615021634e-5);
    amrex::Real const a5 = amrex::Real(0.602588177e-7);
    amrex::Real const a6 = amrex::Real(0.385852041e-9);
    amrex::Real const a7 = amrex::Real(0.146898966e-11);
    amrex::Real const a8 = amrex::Real(0.252751365e-14);
 
    amrex::Real dtt = t-amrex::Real(273.16);
    const amrex::Real tol = amrex::Real(16.0) * std::numeric_limits<amrex::Real>::epsilon();
    AMREX_ALWAYS_ASSERT(dtt >= -amrex::Real(90.0) - tol);
 
    amrex::Real esati;
    if (dtt > amrex::Real(0)) {
        esati = amrex::Real(0);
    } else {
        esati = a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
    }
    return esati;
}

Referenced by saturation_funcs::compute_saturation_pressure_ice(), erf_dtqsati(), erf_qsati(), and sam_compute_coefficient_row().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_esatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_esatw	(	amrex::Real	t,
		bool	use_empirical = false
	)

{
    if (use_empirical) {
        return amrex::Real(0.01) *
               std::exp(amrex::Real(34.494) - amrex::Real(4924.99)/(t - amrex::Real(273.15) + amrex::Real(237.1))) /
               std::pow(t - amrex::Real(273.15) + amrex::Real(105.0), amrex::Real(1.57));
    }
 
    if (erf_use_positive_esatw_poly(t)) {
        return erf_esatw_flatau_poly(t - amrex::Real(273.16));
    }
 
    return erf_esatw_cc(t);
}

Referenced by HSEutils::compute_saturation_pressure(), saturation_funcs::compute_saturation_pressure_H2O(), erf_dtqsatw(), erf_qsatw(), ERF::FillPlot3DVars(), sam_compute_coefficient_row(), and erf_cloud_chamber::vapor_mixing_ratio_from_relative_humidity().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_esatw_cc()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_esatw_cc

(

amrex::Real

t

)

                                     {
    constexpr amrex::Real svp1  = amrex::Real(0.6112);
    constexpr amrex::Real svp2  = amrex::Real(17.67);
    constexpr amrex::Real svp3  = amrex::Real(29.65);
    constexpr amrex::Real svpt0 = amrex::Real(273.15);
    amrex::Real esatw = amrex::Real(10.0) * svp1 * std::exp(svp2 * (t - svpt0) / (t - svp3));
    return esatw;
}

Referenced by erf_esatw(), and ERF::FillPlot3DVars().

Here is the caller graph for this function:

erf_esatw_flatau_poly()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_esatw_flatau_poly

(

amrex::Real

dtt

)

{
    amrex::Real const a0 = amrex::Real(6.11239921);
    amrex::Real const a1 = amrex::Real(0.443987641);
    amrex::Real const a2 = amrex::Real(0.142986287e-1);
    amrex::Real const a3 = amrex::Real(0.264847430e-3);
    amrex::Real const a4 = amrex::Real(0.302950461e-5);
    amrex::Real const a5 = amrex::Real(0.206739458e-7);
    amrex::Real const a6 = amrex::Real(0.640689451e-10);
    amrex::Real const a7 = -amrex::Real(0.952447341e-13);
    amrex::Real const a8 = -amrex::Real(0.976195544e-15);
 
    return a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
}

Referenced by erf_esatw(), and erf_use_positive_esatw_poly().

Here is the caller graph for this function:

erf_gammafff()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_gammafff

(

amrex::Real

x

)

                                    {
    AMREX_ALWAYS_ASSERT(x > amrex::Real(0));
    return std::exp(std::lgamma(x));
}

Referenced by SAM::Compute_Coefficients(), and SAM::PrecipFall().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_qsat_from_esat()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_qsat_from_esat	(	amrex::Real	esat,
		amrex::Real	p
	)

{
    return RdoRv * esat / std::max(esat, p - esat);
}

Referenced by erf_qsati(), and erf_qsatw().

Here is the caller graph for this function:

erf_qsati()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void erf_qsati	(	amrex::Real	t,
		amrex::Real	p,
		amrex::Real &	qsati
	)

                                                            {
    qsati = erf_qsat_from_esat(erf_esati(t), p);
}

Referenced by SAM::Cloud(), saturation_funcs::compute_saturation_vapfrac_ice(), ComputeMoistStratification(), SAM::NewtonIterSat(), and sam_precip_cell_update().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_qsatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void erf_qsatw	(	amrex::Real	t,
		amrex::Real	p,
		amrex::Real &	qsatw
	)

                                                            {
    qsatw = erf_qsat_from_esat(erf_esatw(t), p);
}

Referenced by SatAdj::AdjustSatAdjCell(), Kessler::AdvanceKessler(), erf_cloud_chamber_wall_flux::bulk_vapor_flux_in(), SAM::Cloud(), saturation_funcs::compute_saturation_vapfrac_H2O(), ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), ComputeMoistStratification(), SurfaceLayer::fill_qsurf_with_qsat(), ERF::FillPlot3DVars(), erf_cloud_chamber_wall_flux::most_wall_coefficients(), SAM::NewtonIterSat(), SatAdj::NewtonSolveSatTemperature(), ERF::PackAtmosphericStates(), erf_cloud_chamber_wall_flux::resolved_vapor_flux_in(), and sam_precip_cell_update().

Here is the call graph for this function:

Here is the caller graph for this function:

erf_use_positive_esatw_poly()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool erf_use_positive_esatw_poly

(

amrex::Real

t

)

{
    amrex::Real const dtt = t - amrex::Real(273.16);
    amrex::Real const poly_min_dtt = -amrex::Real(70.0);
    return dtt > poly_min_dtt && dtt < amrex::Real(70.0) &&
           erf_esatw_flatau_poly(dtt) > amrex::Real(0.0);
}

Referenced by erf_dtesatw(), and erf_esatw().

Here is the call graph for this function:

Here is the caller graph for this function: