ERF_TwoStreamRadiation.H File Reference

#include <memory>
#include <string>
#include <AMReX_BoxArray.H>
#include <AMReX_DistributionMapping.H>
#include <AMReX_Geometry.H>
#include <AMReX_MultiFab.H>
#include <AMReX_REAL.H>
#include <AMReX_Vector.H>
#include <ERF_RadStruct.H>
#include <ERF_LandSurface.H>
#include <ERF_RadiationDiagnostics.H>
#include <ERF_TwoStreamCanopyForcing.H>

Include dependency graph for ERF_TwoStreamRadiation.H:

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

Go to the source code of this file.

Classes
class	TwoStreamRadiation
	The two-stream radiation model (erf.radiation_model = TwoStream). More...
struct	TwoStreamRadiation::OrbitalCache
struct	TwoStreamRadiation::FluxDiag
struct	TwoStreamSunDate
	The calendar sun of the two-stream model at one time (see two_stream_sun_date()). More...

Functions
void	copy_surface_plane (const amrex::MultiFab &src2d, amrex::MultiFab &dst)
	Copy a 2D field (k = 0 only) into the k = 0 plane of a surface-model field. More...
TwoStreamSunDate	two_stream_sun_date (const RadChoice &rc, TwoStreamRadiation::OrbitalCache &orbit, double epoch_time)
	The calendar sun of the two-stream model at a UTC epoch time (start_time + t). More...

Variables
constexpr amrex::Real	two_stream_tsi_reference = 1360.9
	RRTMGP's reference total solar irradiance [W/m^2], scaled by the date's Earth-Sun distance factor. More...

Function Documentation

copy_surface_plane()

void copy_surface_plane	(	const amrex::MultiFab &	src2d,
		amrex::MultiFab &	dst
	)

Copy a 2D field (k = 0 only) into the k = 0 plane of a surface-model field.

Surface-model fields keep their surface values in the k = 0 plane, which may lie in the field's z ghost region (SLM stores soil layers at k < 0), and carry x/y ghost cells the source need not have. Only the i,j extent of each destination VALID box is written, so ghost columns and every other k are left alone. The two fields must share a horizontal layout: the destination's boxes flattened to k = 0 equal the source's, on the same DistributionMapping – which holds for ERF's ba2d and a land model's data built from the same level grids, and is asserted rather than assumed.

two_stream_sun_date()

TwoStreamSunDate two_stream_sun_date	(	const RadChoice &	rc,
		TwoStreamRadiation::OrbitalCache &	orbit,
		double	epoch_time
	)

The calendar sun of the two-stream model at a UTC epoch time (start_time + t).

The date as the RRTMGP interface forms it, the orbit of the year (or the erf.rad_orbital_* overrides) cached in orbit, and the declination and distance factor of ERF_OrbCosZenith.H. The two-stream sweep places its sun from this, with the column's position, and so does the immersed-boundary balance with erf.ibseb.sun_mode = two_stream.

The calendar sun of the two-stream model at a UTC epoch time: the calendar day with the time of day as its fraction, the declination and the Earth-Sun distance factor, from the date as the RRTMGP interface forms it and the orbital code of ERF_OrbCosZenith.H (orbital_params once per year into orbit, with the erf.rad_orbital_* overrides passed to it, then orbital_decl per call). set_solar_state() takes the sun of every sweep from here, and the immersed-boundary balance its erf.ibseb.sun_mode = two_stream sun, so the two cannot drift apart.

{
    // Calendar date of this call (UTC), as the RRTMGP interface forms it.
    time_t timestamp = time_t(epoch_time);
    struct tm timeinfo{};
#if defined(_WIN32)
    gmtime_s(&timeinfo, &timestamp);
#else
    gmtime_r(&timestamp, &timeinfo);
#endif
    const int year = (rc.rad_orbital_year >= 0) ? rc.rad_orbital_year : timeinfo.tm_year + 1900;
    const int mon = timeinfo.tm_mon + 1;
    const int day = timeinfo.tm_mday;
    const int sec = timeinfo.tm_hour*3600 + timeinfo.tm_min*60 + timeinfo.tm_sec;
 
    // Orbital parameters of the year (Berger 1978) unless overridden: a few
    // hundred series terms and six vectors, so once per year, not per step.
    if (orbit.year != year) {
        int  iyear = year;
        double eccen = rc.rad_orbital_eccentricity;
        double obliq = rc.rad_orbital_obliquity;
        double mvelp = rc.rad_orbital_mvelp;
        double obliqr = 0.0, lambm0 = 0.0, mvelpp = 0.0;
        orbital_params(iyear, eccen, obliq, mvelp, obliqr, lambm0, mvelpp);
        orbit.year = year;
        orbit.eccen = eccen; orbit.obliqr = obliqr; orbit.lambm0 = lambm0; orbit.mvelpp = mvelpp;
    }
 
    // Declination and Earth-Sun distance factor of the day.
    double calday = orbital_calday(year, mon, day, sec);
    double eccen = orbit.eccen, mvelpp = orbit.mvelpp, lambm0 = orbit.lambm0, obliqr = orbit.obliqr;
    double delta = 0.0, eccf = 1.0;
    orbital_decl(calday, eccen, mvelpp, lambm0, obliqr, delta, eccf);
 
    TwoStreamSunDate out;
    out.calday = calday;
    out.declin = delta;
    out.eccf   = eccf;
    return out;
}

Referenced by ERF::ibseb_set_two_stream_sun().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

two_stream_tsi_reference

constexpr amrex::Real two_stream_tsi_reference = 1360.9

inlineconstexpr

RRTMGP's reference total solar irradiance [W/m^2], scaled by the date's Earth-Sun distance factor.

Referenced by ERF::ibseb_set_two_stream_sun().