ERF_EOS.H File Reference

#include <ERF_Constants.H>
#include <AMReX.H>
#include <AMReX_IntVect.H>
#include <AMReX_MFIter.H>
#include <cmath>

Include dependency graph for ERF_EOS.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	getThgivenPandT (const amrex::Real T, const amrex::Real P, const amrex::Real rdOcp)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getTgivenPandTh (const amrex::Real P, const amrex::Real th, const amrex::Real rdOcp)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getTgivenRandRTh (const amrex::Real rho, const amrex::Real rhotheta, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getThgivenRandT (const amrex::Real rho, const amrex::Real T, const amrex::Real rdOcp, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getPgivenRTh (const amrex::Real rhotheta, const amrex::Real qv=0.)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getRhogivenThetaPress (const amrex::Real th, const amrex::Real p, const amrex::Real rdOcp, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getRhogivenTandPress (const amrex::Real T, const amrex::Real p, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getdPdRgivenConstantTheta (const amrex::Real rho, const amrex::Real theta, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getExnergivenP (const amrex::Real P, const amrex::Real rdOcp)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getExnergivenRTh (const amrex::Real rhotheta, const amrex::Real rdOcp, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	getRhoThetagivenP (const amrex::Real p, const amrex::Real qv=0.0)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	compute_vapor_pressure (const amrex::Real p_s, const amrex::Real RH)

Function Documentation

compute_vapor_pressure()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_vapor_pressure	(	const amrex::Real	p_s,
		const amrex::Real	RH
	)

{
    return p_s*RH;
}

getdPdRgivenConstantTheta()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getdPdRgivenConstantTheta	(	const amrex::Real	rho,
		const amrex::Real	theta,
		const amrex::Real	qv = 0.0
	)

Function to return dP/drho at constant theta

@params[in ] rho density @params[in ] theta potential temperature @params[in ] qv water vapor @params[ out] pressure

{
    // We should be using moist value of theta when using moisture
    // theta_m = theta * (1 + R_v/R_d*qv)
    return Gamma * p_0 * std::pow( (R_d * theta * (amrex::Real(1.0) + R_v/R_d*qv) * ip_0), Gamma) * std::pow(rho, Gamma-1.0) ;
}

Referenced by HSEutils::init_isentropic_hse(), and HSEutils::init_isentropic_hse_terrain().

Here is the caller graph for this function:

getExnergivenP()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getExnergivenP	(	const amrex::Real	P,
		const amrex::Real	rdOcp
	)

Function to return the Exner function pi given pressure @params[in ] p pressure @params[in ] rdOcp ratio of R_d to c_p @params[ out] Exner function

{
    // Exner function pi in terms of P
    return std::pow(P * ip_0, rdOcp);
}

Referenced by ERF::erf_enforce_hse().

Here is the caller graph for this function:

getExnergivenRTh()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getExnergivenRTh	(	const amrex::Real	rhotheta,
		const amrex::Real	rdOcp,
		const amrex::Real	qv = 0.0
	)

Function to return the Exner function pi given density times potential temperature

@params[in ] rhotheta density times potential temperature @params[in ] rdOcp ratio of R_d to c_p @params[in ] qv water vapor @params[ out] Exner function

{
    // Exner function pi in terms of (rho theta)
    // We should be using moist value of theta when using moisture
    // theta_m = theta * (1 + R_v/R_d*qv)
    return std::pow(R_d * rhotheta *  (1.0 + R_v/R_d*qv) * ip_0, Gamma * rdOcp);
}

Referenced by init_bx_scalars_from_input_sounding_hse().

Here is the caller graph for this function:

getPgivenRTh()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getPgivenRTh	(	const amrex::Real	rhotheta,
		const amrex::Real	qv = 0.
	)

Function to return pressure given density times theta

@params[in ] rhotheta density times potential temperature @params[in ] qv water vapor @params[ out] pressure

{
    return p_0 * std::pow(R_d * rhotheta * ( amrex::Real(1.0) + (R_v/R_d)*qv) * ip_0, Gamma);
}

Referenced by SAM::Compute_Coefficients(), Kessler::Copy_State_to_Micro(), SAM::Copy_State_to_Micro(), SatAdj::Copy_State_to_Micro(), ERF::derive_diag_profiles(), ERF::derive_diag_profiles_stag(), derived::erf_dersoundspeed(), erf_slow_rhs_pre(), ERF::estTimeStep(), init_bx_scalars_from_input_sounding_hse(), HSEutils::init_isentropic_hse(), HSEutils::init_isentropic_hse_terrain(), Radiation::initialize(), ERF::MakeHorizontalAverages(), and ERF::WritePlotFile().

Here is the caller graph for this function:

getRhogivenTandPress()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getRhogivenTandPress	(	const amrex::Real	T,
		const amrex::Real	p,
		const amrex::Real	qv = 0.0
	)

Function to return density given temperature and pressure

@params[in ] theta potential temperature @params[in ] p pressure @params[in ] rdOcp ratio of R_d to c_p @params[in ] qv water vapor @params[ out] density

{
    return p / ( R_d * T * (amrex::Real(1.0) + (R_v/R_d)*qv) );
}

getRhogivenThetaPress()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getRhogivenThetaPress	(	const amrex::Real	th,
		const amrex::Real	p,
		const amrex::Real	rdOcp,
		const amrex::Real	qv = 0.0
	)

Function to return density given theta and pressure

@params[in ] theta potential temperature @params[in ] p pressure @params[in ] rdOcp ratio of R_d to c_p @params[in ] qv water vapor @params[ out] density

{
    // We should be using moist value of theta when using moisture
    // theta_m = theta * (1 + R_v/R_d*qv)
    return std::pow(p_0, rdOcp) * std::pow(p, iGamma) / (R_d * th * (amrex::Real(1.0) + R_v/R_d*qv) );
}

Referenced by InputSoundingData::calc_rho_p(), and HSEutils::Newton_Raphson_hse().

Here is the caller graph for this function:

getRhoThetagivenP()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getRhoThetagivenP	(	const amrex::Real	p,
		const amrex::Real	qv = 0.0
	)

Function to return (rho theta) given pressure

@params[in ] p pressure @params[in ] qv water vapor @params[ out] density times potential temperature

{
    // diagnostic relation for the full pressure
    // see https://erf.readthedocs.io/en/latest/theory/NavierStokesEquations.html
    // For cases with moisture, theta = theta_m / (1 + R_v/R_d*qv)
    return std::pow(p*std::pow(p_0, Gamma-1), iGamma) * iR_d / (1.0 + R_v/R_d*qv) ;
}

Referenced by buoyancy_dry_anelastic_T(), ERF::erf_enforce_hse(), init_bx_scalars_from_input_sounding_hse(), ERF::init_from_hse(), and ERF::ReadCheckpointFile().

Here is the caller graph for this function:

getTgivenPandTh()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getTgivenPandTh	(	const amrex::Real	P,
		const amrex::Real	th,
		const amrex::Real	rdOcp
	)

Function to return temperature given pressure and potential temperature

@params[in ] P pressure @params[in ] th potential temperature @params[in ] rdOcp ratio of R_d to c_p @params[ out] temperature

{
    return th / std::pow(p_0/P, rdOcp);
}

Referenced by buoyancy_dry_anelastic_T(), buoyancy_dry_Tpert(), and buoyancy_moist_Tpert().

Here is the caller graph for this function:

getTgivenRandRTh()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getTgivenRandRTh	(	const amrex::Real	rho,
		const amrex::Real	rhotheta,
		const amrex::Real	qv = 0.0
	)

Function to return temperature given density and potential temperature

@params[in ] rho density @params[in ] rhotheta (density times potential temperature) @params[in ] qv water vapor @params[ out] temperature

{
    // rho and rhotheta are dry values. We should be using moist value of theta when using moisture
    // theta_m = theta * (1 + R_v/R_d*qv)
    amrex::Real p_loc = p_0 * std::pow(R_d * rhotheta * (1.0 + R_v/R_d*qv) * ip_0, Gamma);
 
    // p = rho_d * R_d * T_v (not T)
    // T_v = T * (1 + R_v/R_d*qv)
    return p_loc / (R_d * rho * (1.0 + R_v/R_d*qv) );
}

Referenced by buoyancy_dry_Tpert(), buoyancy_moist_Tpert(), SAM::Compute_Coefficients(), Kessler::Copy_State_to_Micro(), SAM::Copy_State_to_Micro(), SatAdj::Copy_State_to_Micro(), derived::erf_dermoisttemp(), derived::erf_dertemp(), Radiation::initialize(), and ERF::WritePlotFile().

Here is the caller graph for this function:

getThgivenPandT()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getThgivenPandT	(	const amrex::Real	T,
		const amrex::Real	P,
		const amrex::Real	rdOcp
	)

Function to return potential temperature given pressure and temperature

@params[in ] P pressure @params[in ] T temperature @params[in ] rdOcp ratio of R_d to c_p @params[ out] potential temperature

{
    return T * std::pow(p_0/P, rdOcp);
}

Referenced by SatAdj::AdvanceSatAdj(), SAM::Cloud(), and SAM::Precip().

Here is the caller graph for this function:

getThgivenRandT()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getThgivenRandT	(	const amrex::Real	rho,
		const amrex::Real	T,
		const amrex::Real	rdOcp,
		const amrex::Real	qv = 0.0
	)

Function to return potential temperature given density and temperature

@params[in ] rho density @params[in ] T temperature @params[in ] rdOcp ratio of R_d to c_p @params[in ] qv water vapor @params[ out] potential temperature

{
    // p = rho_d * R_d * T_moist
    amrex::Real p_loc = rho * R_d * T * (1.0 + R_v/R_d*qv);
 
    // theta_d = T * (p0/p)^(R_d/C_p)
    return T * std::pow((p_0/p_loc),rdOcp);
}

Referenced by ReadBndryPlanes::read_file().

Here is the caller graph for this function: