ERF_MicrophysicsUtils.H File Reference

#include <cmath>
#include <vector>
#include <AMReX_REAL.H>
#include <AMReX_Array.H>
#include <ERF_Constants.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.

Functions
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 (amrex::Real t)
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 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)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	z0_est (amrex::Real z, amrex::Real bflx, amrex::Real wnd, amrex::Real ustar, amrex::Real &z0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	term_vel_qp (amrex::Real qploc, amrex::Real vrain, amrex::Real vsnow, amrex::Real vgrau, amrex::Real rho, amrex::Real tabs)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	pp (amrex::Real y)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	pn (amrex::Real y)

Function Documentation

erf_dtesati()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesati

(

amrex::Real

t

)

                                    {
    amrex::Real const a0 = 0.503223089;
    amrex::Real const a1 = 0.377174432e-1;
    amrex::Real const a2 = 0.126710138e-2;
    amrex::Real const a3 = 0.249065913e-4;
    amrex::Real const a4 = 0.312668753e-6;
    amrex::Real const a5 = 0.255653718e-8;
    amrex::Real const a6 = 0.132073448e-10;
    amrex::Real const a7 = 0.390204672e-13;
    amrex::Real const a8 = 0.497275778e-16;
 
    amrex::Real dtt = t-273.16;
    AMREX_ALWAYS_ASSERT(dtt>-85);
    amrex::Real dtesati;
    if (dtt > 0.0) {
        dtesati = 0.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 caller graph for this function:

erf_dtesatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_dtesatw

(

amrex::Real

t

)

                                    {
    amrex::Real const a0 = 0.443956472;
    amrex::Real const a1 = 0.285976452e-1;
    amrex::Real const a2 = 0.794747212e-3;
    amrex::Real const a3 = 0.121167162e-4;
    amrex::Real const a4 = 0.103167413e-6;
    amrex::Real const a5 = 0.385208005e-9;
    amrex::Real const a6 = -0.604119582e-12;
    amrex::Real const a7 = -0.792933209e-14;
    amrex::Real const a8 = -0.599634321e-17;
 
    amrex::Real dtt = t-273.16; // Goff-Gratch
    amrex::Real dtesatw;
    if (dtt>-85.0 && dtt<70.) {
        dtesatw = a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
    } else {
        dtesatw = erf_dtesatw_cc(t);
    }
    return dtesatw;
}

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  = 0.6112;
    constexpr amrex::Real svp2  = 17.67;
    constexpr amrex::Real svp3  = 29.65;
    constexpr amrex::Real svpt0 = 273.15;
    amrex::Real dtesatw = 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_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);
    amrex::Real denom   = p - esati;
    dtqsati = Rd_on_Rv * dtesati * p / (denom * denom);
}

Referenced by Morrison::NewtonIterSat(), and 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);
    amrex::Real denom   = p - esatw;
    dtqsatw = Rd_on_Rv * dtesatw * p / (denom * denom);
}

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

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 = 6.11147274;
    amrex::Real const a1 = 0.503160820;
    amrex::Real const a2 = 0.188439774e-1;
    amrex::Real const a3 = 0.420895665e-3;
    amrex::Real const a4 = 0.615021634e-5;
    amrex::Real const a5 = 0.602588177e-7;
    amrex::Real const a6 = 0.385852041e-9;
    amrex::Real const a7 = 0.146898966e-11;
    amrex::Real const a8 = 0.252751365e-14;
 
    amrex::Real dtt = t-273.16;
    AMREX_ALWAYS_ASSERT(dtt>-90);
 
    amrex::Real esati;
    if (dtt > 0.0) {
        esati = 0.0;
    } else {
        esati = a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
    }
    return esati;
}

Referenced by Morrison::Compute_Coefficients(), SAM::Compute_Coefficients(), erf_dtqsati(), and erf_qsati().

Here is the caller graph for this function:

erf_esatw()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_esatw

(

amrex::Real

t

)

                                  {
    amrex::Real const a0 = 6.11239921;
    amrex::Real const a1 = 0.443987641;
    amrex::Real const a2 = 0.142986287e-1;
    amrex::Real const a3 = 0.264847430e-3;
    amrex::Real const a4 = 0.302950461e-5;
    amrex::Real const a5 = 0.206739458e-7;
    amrex::Real const a6 = 0.640689451e-10;
    amrex::Real const a7 = -0.952447341e-13;
    amrex::Real const a8 = -0.976195544e-15;
 
    amrex::Real dtt = t-273.16;
    amrex::Real esatw;
    if (dtt>-85 && dtt<70.0) {
        esatw = a0 + dtt*(a1+dtt*(a2+dtt*(a3+dtt*(a4+dtt*(a5+dtt*(a6+dtt*(a7+a8*dtt)))))));
    } else {
        esatw = erf_esatw_cc(t);
    }
    return esatw;
}

Referenced by Morrison::Compute_Coefficients(), SAM::Compute_Coefficients(), erf_dtqsatw(), erf_qsatw(), and ERF::Write3DPlotFile().

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  = 0.6112;
    constexpr amrex::Real svp2  = 17.67;
    constexpr amrex::Real svp3  = 29.65;
    constexpr amrex::Real svpt0 = 273.15;
    // NOTE: units of
    amrex::Real esatw = 10.0 * svp1 * std::exp(svp2 * (t - svpt0) / (t - svp3));
    return esatw;
}

Referenced by erf_esatw().

Here is the caller graph for this function:

erf_gammafff()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real erf_gammafff

(

amrex::Real

x

)

                                    {
    return std::exp(lgamma(x));
}

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

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
	)

                                                            {
    amrex::Real esati;
    esati = erf_esati(t);
    qsati = Rd_on_Rv*esati/std::max(esati,p-esati);
}

Referenced by SAM::Cloud(), ComputeMoistStratification(), Morrison::NewtonIterSat(), SAM::NewtonIterSat(), and SAM::Precip().

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
	)

                                                            {
    amrex::Real esatw;
    esatw = erf_esatw(t);
    qsatw = Rd_on_Rv*esatw/std::max(esatw,p-esatw);
}

Referenced by Kessler::AdvanceKessler(), SatAdj::AdvanceSatAdj(), SAM::Cloud(), ComputeMoistStratification(), SurfaceLayer::fill_qsurf_with_qsat(), SatAdj::NewtonIterSat(), Morrison::NewtonIterSat(), SAM::NewtonIterSat(), SAM::Precip(), and ERF::Write3DPlotFile().

Here is the call graph for this function:

Here is the caller graph for this function:

pn()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pn

(

amrex::Real

y

)

                           {
    return -std::min(0.0,y);
}

pp()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp

(

amrex::Real

y

)

                           {
    return std::max(0.0,y);
}

Referenced by add_par(), Morrison::Advance(), ERF::appendPlotVariables(), SolverChoice::build_coriolis_forcings_const_lat(), TurbulentPerturbation::calc_tpi_update(), eb_aux_::define(), AdvChoice::display(), ERF::ERF(), ERF::ERF_shared(), ERF::ErrorEst(), Morrison::Init(), NOAHMP::Init(), ERF::init_bcs(), TurbChoice::init_params(), SolverChoice::init_params(), AdvChoice::init_params(), DiffChoice::init_params(), SpongeChoice::init_params(), ProblemBase::init_terrain_surface(), TurbulentPerturbation::init_tpi(), init_which_terrain_grid(), WindFarm::init_windfarm_lat_lon(), init_zlevels(), ERF::InitData_post(), InputSoundingData::InputSoundingData(), InputSpongeData::InputSpongeData(), LineSampler::LineSampler(), SurfaceLayer::make_SurfaceLayer_at_level(), PlaneSampler::PlaneSampler(), ERF::post_timestep(), query_one_or_per_level(), Radiation::Radiation(), SolverChoice::read_int_string(), ReadBndryPlanes::ReadBndryPlanes(), ERF::ReadCheckpointFile(), ERF::ReadParameters(), ERF::refinement_criteria_setup(), MOSTAverage::set_k_indices_N(), MOSTAverage::set_k_indices_T(), MOSTAverage::set_norm_indices_T(), MOSTAverage::set_norm_positions_T(), MOSTAverage::set_z_positions_T(), ERF::setPlotVariables(), ERF::setPlotVariables2D(), IRadiation::setupDataLog(), SHOCInterface::SHOCInterface(), SurfaceLayer::SurfaceLayer(), WriteBndryPlanes::WriteBndryPlanes(), and ERF::WriteSubvolume().

Here is the caller graph for this function:

term_vel_qp()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real term_vel_qp	(	amrex::Real	qploc,
		amrex::Real	vrain,
		amrex::Real	vsnow,
		amrex::Real	vgrau,
		amrex::Real	rho,
		amrex::Real	tabs
	)

{
    amrex::Real term_vel = 0.0;
    if(qploc > qp_threshold) {
        amrex::Real omp = std::max(0.0,std::min(1.0,(tabs-tprmin)*a_pr));
        amrex::Real omg = std::max(0.0,std::min(1.0,(tabs-tgrmin)*a_gr));
        amrex::Real qrr = omp*qploc;
        amrex::Real qss = (1.0-omp)*(1.0-omg)*qploc;
        amrex::Real qgg = (1.0-omp)*(omg)*qploc;
        term_vel = omp*vrain*std::pow(rho*qrr,crain)
                 + (1.0-omp)*( (1.0-omg)*vsnow*std::pow(rho*qss,csnow)
                             +      omg *vgrau*std::pow(rho*qgg,cgrau) );
    }
    return term_vel;
}

z0_est()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void z0_est	(	amrex::Real	z,
		amrex::Real	bflx,
		amrex::Real	wnd,
		amrex::Real	ustar,
		amrex::Real &	z0
	)

                                                                                         {
    amrex::Real vonk = 0.4;
    amrex::Real eps  = 1.0e-10;
    amrex::Real am   = 4.8;
    amrex::Real bm   = 19.3;
    amrex::Real c1   = 3.14159/2.0 - 3.0*log(2.0);
    amrex::Real rlmo = -bflx*vonk/(ustar*ustar*ustar+eps);
    amrex::Real zeta = std::min(1.0,z*rlmo);
    amrex::Real x;
    amrex::Real psi1;
    if(zeta >= 0.0) {
        psi1 = -am*zeta;
    }
    else {
        x = std::sqrt(sqrt(1.0-bm*zeta));
        psi1 = 2.0*std::log(1.0+x) + std::log(1.0+x*x) -2.0*std::atan(x) + c1;
    }
    amrex::Real lnz = std::max(0.0, vonk*wnd/(ustar+eps) +psi1);
    z0 = z*std::exp(-lnz);
}