TopographicShadingChoice Struct Reference

#include <ERF_RadStruct.H>

Collaboration diagram for TopographicShadingChoice:

Public Member Functions
bool	active () const
void	read (const std::string &prefix, const RRTMGPSolarChoice &solar)

Public Attributes
bool	slope_rad = false
bool	topo_shading = false
amrex::Real	shadlen = 25000
amrex::Real	fixed_mu = 0
amrex::Real	fixed_azimuth = -1
amrex::Real	latitude = 0
amrex::Real	longitude = 0
int	radiation_interval = 0

Detailed Description

Inputs for the optional topographic correction of RRTMGP land forcing.

Member Function Documentation

active()

bool TopographicShadingChoice::active ( ) const

inline

{ return slope_rad || topo_shading; }

Referenced by plotfile2d::available_diagnostic_names(), and SolverChoice::init_params().

Here is the caller graph for this function:

read()

void TopographicShadingChoice::read	(	const std::string &	prefix,
		const RRTMGPSolarChoice &	solar
	)

{
    ParmParse pp(prefix);
    pp.queryAdd("slope_rad", slope_rad);
    pp.queryAdd("topo_shading", topo_shading);
    if (!active()) { return; }
    pp.queryAdd("shadlen", shadlen);
    const bool has_azimuth = pp.query("fixed_solar_azimuth_angle", fixed_azimuth);
    fixed_mu = solar.fixed_mu;
    latitude = solar.latitude;
    longitude = solar.longitude;
    radiation_interval = solar.radiation_interval;
    AMREX_ALWAYS_ASSERT_WITH_MESSAGE(std::isfinite(shadlen) && shadlen > 0,
        "erf.shadlen must be a positive finite horizontal distance in metres");
    AMREX_ALWAYS_ASSERT_WITH_MESSAGE(std::isfinite(fixed_mu) && fixed_mu <= 1,
        "erf.fixed_solar_zenith_angle is a cosine and must not exceed 1");
    AMREX_ALWAYS_ASSERT_WITH_MESSAGE(!has_azimuth || fixed_mu > 0,
        "erf.fixed_solar_azimuth_angle requires a positive fixed_solar_zenith_angle");
    AMREX_ALWAYS_ASSERT_WITH_MESSAGE(fixed_mu <= 0 ||
        (has_azimuth && std::isfinite(fixed_azimuth) && fixed_azimuth >= 0 && fixed_azimuth < 360),
        "Topographic radiation with fixed_solar_zenith_angle requires "
        "fixed_solar_azimuth_angle in [0,360), clockwise from geographic north");
    AMREX_ALWAYS_ASSERT_WITH_MESSAGE(radiation_interval > 0,
        "Topographic radiation requires erf.rad_freq_in_steps > 0");
}

Referenced by SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fixed_azimuth

amrex::Real TopographicShadingChoice::fixed_azimuth = -1

Referenced by TopographicShading::apply().

fixed_mu

amrex::Real TopographicShadingChoice::fixed_mu = 0

Referenced by TopographicShading::apply().

latitude

amrex::Real TopographicShadingChoice::latitude = 0

Referenced by TopographicShading::initialize_geometry().

longitude

amrex::Real TopographicShadingChoice::longitude = 0

Referenced by TopographicShading::initialize_geometry().

radiation_interval

int TopographicShadingChoice::radiation_interval = 0

shadlen

amrex::Real TopographicShadingChoice::shadlen = 25000

Referenced by TopographicShading::apply(), and TopographicShading::initialize_geometry().

slope_rad

bool TopographicShadingChoice::slope_rad = false

Referenced by active(), and TopographicShading::apply().

topo_shading

bool TopographicShadingChoice::topo_shading = false

Referenced by active(), TopographicShading::apply(), and TopographicShading::initialize_geometry().

---

The documentation for this struct was generated from the following files:

• Source/DataStructs/ERF_RadStruct.H
• Source/Radiation/ERF_TopographicShading.cpp