MoistureComponentIndices Struct Reference

The moisture data carried by the active microphysics scheme. More...

#include <ERF_DataStruct.H>

Collaboration diagram for MoistureComponentIndices:

Classes
struct	CompList
	An ordered list of conserved-state components forming an aggregate moisture output variable (qt, qn, qp, moist_density). More...
struct	VarAvailability
	Whether this map decides a variable's availability, and if so whether the variable is available. More...

Public Member Functions
	MoistureComponentIndices (int qv_comp, int qc_comp, int qi_comp=absent, int qr_comp=absent, int qs_comp=absent, int qg_comp=absent, int nc_comp=absent, int ni_comp=absent, int nr_comp=absent, int ns_comp=absent, int ng_comp=absent, int nn_comp=absent)
	Construct the conserved-state component map. More...
	MoistureComponentIndices ()=default
	Construct an empty map, i.e. a dry run. More...
CompList	total_water_comps () const
	Components summed for total water, "qt": every mass mixing ratio. More...
CompList	nonprecipitating_comps () const
	Components summed for non-precipitating water, "qn": vapor plus the suspended condensate. Also the moist part of "moist_density". More...
CompList	precipitating_comps () const
	Components summed for precipitating water, "qp": the falling species. More...
bool	has_comp (int comp) const
	Test whether a conserved-state component holds one of the moisture variables this scheme carries. More...
bool	has_reflectivity_species () const
	Test whether the active scheme carries rain, snow and graupel in the RhoQ4/RhoQ5/RhoQ6 slots assumed by erf_derreflectivity and erf_dermaxreflectivity. More...
bool	has_moisture () const
	Test whether the active scheme carries any moisture at all. More...
int	comp_for_var (const std::string &name) const
	The conserved-state component behind a single-species output name, or absent if the name is not a single species or the scheme does not carry it. More...
int	qmoist_index_for_var (const std::string &name) const
	The qmoist slot behind a moist diagnostic output name. More...
VarAvailability	query_var (const std::string &name) const
	Classify an output variable name against this index map. More...
bool	has_derived_var (const std::string &name) const
	Test whether the moist species behind a derived/plot variable name is carried by the active scheme. More...

Static Public Member Functions
static MoistureComponentIndices	from_moisture_model (const MoistureType moisture_type)
	Build the complete index map – conserved-state components and qmoist diagnostic slots – for a moisture model. More...

Public Attributes
int	qv = absent
	water vapor More...
int	qc = absent
	cloud liquid water More...
int	qi = absent
	cloud ice More...
int	qr = absent
	rain More...
int	qs = absent
	snow More...
int	qg = absent
	graupel More...
int	nc = absent
	cloud liquid water number More...
int	ni = absent
	cloud ice number More...
int	nr = absent
	rain number More...
int	ns = absent
	snow number More...
int	ng = absent
	graupel number More...
int	nn = absent
	CCN / total aerosol number. More...
int	rain_accum = absent
	accumulated surface rain More...
int	snow_accum = absent
	accumulated surface snow More...
int	graup_accum = absent
	accumulated surface graupel More...
int	rel_hum = absent
	relative humidity More...
int	cond_rate = absent
	condensation rate More...

Static Public Attributes
static constexpr int	absent = -1
	not carried by the active scheme More...
static constexpr int	computed_from_state = -2

Detailed Description

The moisture data carried by the active microphysics scheme.

This struct is the single source of truth for the question "which moisture quantities does this run actually have?". Everything downstream of the microphysics – source terms, turbulence closures, and every output path (3D plotfiles, 2D plotfiles, subvolumes) – answers that question by querying this struct instead of enumerating MoistureType values, so a newly added scheme only has to declare its layout once, in from_moisture_model() below.

Two kinds of index live here:

1. Conserved-state components (qv ... nn). Absolute component indices into the conserved state array, i.e. one of RhoQ1_comp ... RhoQ11_comp. They name the rho-weighted species: state(i,j,k,qv) is rho*qv, so an output path must divide by Rho_comp to recover the mixing ratio.
2. qmoist diagnostic slots (rain_accum ... cond_rate). Indices into the per-level qmoist vector that is filled from Microphysics::Get_Qmoist_Ptr(lev,idx). Each scheme chooses that layout independently, so the slot numbers differ between schemes and are recorded per scheme below.

In both cases the value is absent when the active scheme does not carry the quantity, so index >= 0 is the criterion for "this exists and is meaningful to write". That is deliberately not the same test as "the storage is allocated": several schemes allocate a wider state than they integrate (the Morrison class always allocates eleven moist components, so Morrison_NoIce owns ice slots it never fills), and writing those slots to a plotfile would publish untouched memory as if it were data.

Constructor & Destructor Documentation

MoistureComponentIndices() [1/2]

MoistureComponentIndices::MoistureComponentIndices ( int  qv_comp, int  qc_comp, int  qi_comp = absent, int  qr_comp = absent, int  qs_comp = absent, int  qg_comp = absent, int  nc_comp = absent, int  ni_comp = absent, int  nr_comp = absent, int  ns_comp = absent, int  ng_comp = absent, int  nn_comp = absent  )

inline

Construct the conserved-state component map.

Prefer from_moisture_model() for production code: it fills in the qmoist diagnostic slots as well. This constructor exists for the callers – unit tests and kernels exercised in isolation – that only need the state map.

Parameters

qv_comp	Water vapor component index.
qc_comp	Cloud liquid water component index.
qi_comp	Cloud ice component index.
qr_comp	Rain component index.
qs_comp	Snow component index.
qg_comp	Graupel component index.
nc_comp	Cloud liquid water number concentration component index.
ni_comp	Cloud ice number concentration component index.
nr_comp	Rain number concentration component index.
ns_comp	Snow number concentration component index.
ng_comp	Graupel number concentration component index.
nn_comp	CCN / total aerosol number concentration component index.

        : qv(qv_comp), qc(qc_comp), qi(qi_comp), qr(qr_comp), qs(qs_comp), qg(qg_comp),
                       nc(nc_comp), ni(ni_comp), nr(nr_comp), ns(ns_comp), ng(ng_comp),
                       nn(nn_comp) {}

MoistureComponentIndices() [2/2]

MoistureComponentIndices::MoistureComponentIndices ( )

default

Construct an empty map, i.e. a dry run.

Member Function Documentation

comp_for_var()

int MoistureComponentIndices::comp_for_var ( const std::string &  name ) const

inline

The conserved-state component behind a single-species output name, or absent if the name is not a single species or the scheme does not carry it.

An output path can use this to copy a species without repeating the name-to-component mapping.

Parameters

name	Derived or plot variable name.

                                                                 {
        if (name == "qv")     { return qv; }
        if (name == "qc")     { return qc; }
        if (name == "qi")     { return qi; }
        if (name == "qrain")  { return qr; }
        if (name == "qsnow")  { return qs; }
        if (name == "qgraup") { return qg; }
        if (name == "nc")     { return nc; }
        if (name == "ni")     { return ni; }
        if (name == "nr")     { return nr; }
        if (name == "ns")     { return ns; }
        if (name == "ng")     { return ng; }
        if (name == "nn")     { return nn; }
        return absent;
    }

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

Here is the caller graph for this function:

from_moisture_model()

static MoistureComponentIndices MoistureComponentIndices::from_moisture_model ( const MoistureType  moisture_type )

inlinestatic

Build the complete index map – conserved-state components and qmoist diagnostic slots – for a moisture model.

This is the one place a scheme declares what it carries. The conserved layout must match the component the scheme reads and writes in its Copy_State_to_Micro / Copy_Micro_to_State pair, and the qmoist slots must match the order the scheme installs in its MicVarMap. A slot that a scheme allocates but never fills is left absent on purpose: see the class comment for why allocation is not the criterion here.

Parameters

moisture_type

Active moisture/microphysics model.

    {
        MoistureComponentIndices mi;
 
        switch (moisture_type) {
 
        case MoistureType::None:
            // Dry: no moisture data of any kind.
            break;
 
        case MoistureType::MoistNoCondensation:
        case MoistureType::SAM_NoPrecip_NoIce:
        case MoistureType::Kessler_NoRain:
            // Vapor plus suspended cloud water, no precipitation and no
            // accumulation diagnostics.
            mi.qv = RhoQ1_comp;
            mi.qc = RhoQ2_comp;
            break;
 
        case MoistureType::SatAdj:
            // As above, but relative humidity is recovered from the state at
            // output time rather than stored: SatAdj publishes no qmoist arrays.
            mi.qv      = RhoQ1_comp;
            mi.qc      = RhoQ2_comp;
            mi.rel_hum = computed_from_state;
            break;
 
        case MoistureType::Kessler:
            // Warm rain in three moist components; qmoist is {rain_accum}.
            mi.qv         = RhoQ1_comp;
            mi.qc         = RhoQ2_comp;
            mi.qr         = RhoQ3_comp;
            mi.rain_accum = 0;
            break;
 
        case MoistureType::SBM:
            // SBM stores the distribution in an auxiliary state.  These two
            // compact liquid lanes are projections for host compatibility.
            mi.qv = RhoQ1_comp;
            mi.qc = RhoQ2_comp;
            mi.qr = RhoQ3_comp;
            break;
 
        case MoistureType::SAM_NoIce:
            // The SAM class always allocates six moist components, so rain sits
            // in the fourth slot even with the ice species switched off.
            mi.qv         = RhoQ1_comp;
            mi.qc         = RhoQ2_comp;
            mi.qr         = RhoQ4_comp;
            mi.rain_accum = 0;
            break;
 
        case MoistureType::SAM:
        case MoistureType::WSM6:
            // Single-moment mixed phase; qmoist is
            // {rain_accum, snow_accum, graup_accum}.
            mi.qv          = RhoQ1_comp;
            mi.qc          = RhoQ2_comp;
            mi.qi          = RhoQ3_comp;
            mi.qr          = RhoQ4_comp;
            mi.qs          = RhoQ5_comp;
            mi.qg          = RhoQ6_comp;
            mi.rain_accum  = 0;
            mi.snow_accum  = 1;
            mi.graup_accum = 2;
            break;
 
        case MoistureType::Morrison:
            // Two-moment mixed phase: six mass species followed by five number
            // concentrations.
            mi.qv          = RhoQ1_comp;
            mi.qc          = RhoQ2_comp;
            mi.qi          = RhoQ3_comp;
            mi.qr          = RhoQ4_comp;
            mi.qs          = RhoQ5_comp;
            mi.qg          = RhoQ6_comp;
            mi.nc          = RhoQ7_comp;
            mi.ni          = RhoQ8_comp;
            mi.nr          = RhoQ9_comp;
            mi.ns          = RhoQ10_comp;
            mi.ng          = RhoQ11_comp;
            mi.rain_accum  = 0;
            mi.snow_accum  = 1;
            mi.graup_accum = 2;
            break;
 
        case MoistureType::Morrison_NoIce:
            // Liquid-only Morrison: the class still allocates all eleven moist
            // components, but only vapor, cloud water and rain -- and the cloud
            // and rain numbers -- are integrated, so the frozen species and
            // their numbers stay absent here.
            mi.qv         = RhoQ1_comp;
            mi.qc         = RhoQ2_comp;
            mi.qr         = RhoQ4_comp;
            mi.nc         = RhoQ7_comp;
            mi.nr         = RhoQ9_comp;
            mi.rain_accum = 0;
            break;
 
        case MoistureType::WDM6:
            // Double-moment warm phase on top of single-moment ice: nn is the
            // aerosol reservoir and takes the slot Morrison uses for ice number,
            // and there are no snow or graupel numbers.
            mi.qv          = RhoQ1_comp;
            mi.qc          = RhoQ2_comp;
            mi.qi          = RhoQ3_comp;
            mi.qr          = RhoQ4_comp;
            mi.qs          = RhoQ5_comp;
            mi.qg          = RhoQ6_comp;
            mi.nc          = RhoQ7_comp;
            mi.nn          = RhoQ8_comp;
            mi.nr          = RhoQ9_comp;
            mi.rain_accum  = 0;
            mi.snow_accum  = 1;
            mi.graup_accum = 2;
            break;
 
        case MoistureType::SuperDroplets:
            // Lagrangian microphysics that still carries the six Eulerian mass
            // species.  Its qmoist layout is its own (see the MicVarMap in
            // SuperDropletsMoist::Init): the graupel accumulation slot exists
            // but is never filled, so it stays absent.
            mi.qv         = RhoQ1_comp;
            mi.qc         = RhoQ2_comp;
            mi.qi         = RhoQ3_comp;
            mi.qr         = RhoQ4_comp;
            mi.qs         = RhoQ5_comp;
            mi.qg         = RhoQ6_comp;
            mi.cond_rate  = 3;
            mi.rel_hum    = 7;
            mi.rain_accum = 8;
            mi.snow_accum = 10;
            break;
 
        default:
            amrex::Abort("Unknown MoistureType in MoistureComponentIndices::from_moisture_model");
        }
 
        return mi;
    }

Referenced by SolverChoice::init_params().

Here is the caller graph for this function:

has_comp()

bool MoistureComponentIndices::has_comp ( int  comp ) const

inline

Test whether a conserved-state component holds one of the moisture variables this scheme carries.

Use this rather than enumerating moisture models when deciding whether a "rhoQn" state component is meaningful for the active scheme.

Parameters

comp	Absolute component index into the conserved state array.

                                                 {
        return ( (comp >= 0) &&
                 ( (comp == qv) || (comp == qc) || (comp == qi) ||
                   (comp == qr) || (comp == qs) || (comp == qg) ||
                   (comp == nc) || (comp == ni) || (comp == nr) ||
                   (comp == ns) || (comp == ng) || (comp == nn) ) );
    }

Referenced by erf_plotfile::plot3d_fixed_variable_available().

Here is the caller graph for this function:

has_derived_var()

bool MoistureComponentIndices::has_derived_var ( const std::string &  name ) const

inline

Test whether the moist species behind a derived/plot variable name is carried by the active scheme.

Names this map does not govern return true, so this can be used directly as a filter over a mixed list of variable names. Use query_var() instead when the caller needs to distinguish "not a moisture variable" from "available".

Parameters

name	Derived or plot variable name.

                                                                     {
        const VarAvailability status = query_var(name);
        return (!status.governed) || status.available;
    }

Referenced by ERF::setSubVolVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

has_moisture()

bool MoistureComponentIndices::has_moisture ( ) const

inline

Test whether the active scheme carries any moisture at all.

Every moist scheme allocates water vapor, so this is equivalent to testing moisture_type != MoistureType::None without needing the enum.

{ return (qv >= 0); }

Referenced by ERF::FillPlot3DVars(), query_var(), ERF::setSubVolVariables(), and ERF::WriteSubvolume().

Here is the caller graph for this function:

has_reflectivity_species()

bool MoistureComponentIndices::has_reflectivity_species ( ) const

inline

Test whether the active scheme carries rain, snow and graupel in the RhoQ4/RhoQ5/RhoQ6 slots assumed by erf_derreflectivity and erf_dermaxreflectivity.

Those kernels read the precipitating species by hardcoded component, so this checks the layout and not just the presence of the species.

                                                         {
        return ( (qr == RhoQ4_comp) && (qs == RhoQ5_comp) && (qg == RhoQ6_comp) );
    }

nonprecipitating_comps()

CompList MoistureComponentIndices::nonprecipitating_comps ( ) const

inline

Components summed for non-precipitating water, "qn": vapor plus the suspended condensate. Also the moist part of "moist_density".

                                                           {
        CompList list;
        list.append(qv); list.append(qc); list.append(qi);
        return list;
    }

Referenced by ERF::FillPlot3DVars().

Here is the call graph for this function:

Here is the caller graph for this function:

precipitating_comps()

CompList MoistureComponentIndices::precipitating_comps ( ) const

inline

Components summed for precipitating water, "qp": the falling species.

                                                        {
        CompList list;
        list.append(qr); list.append(qs); list.append(qg);
        return list;
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

qmoist_index_for_var()

int MoistureComponentIndices::qmoist_index_for_var ( const std::string &  name ) const

inline

The qmoist slot behind a moist diagnostic output name.

Returns absent when the scheme does not provide the diagnostic, and computed_from_state when it does provide it but not through a qmoist array – in that case the caller must derive it from the conserved state.

Parameters

name	Derived or plot variable name.

                                                                         {
        if (name == "rain_accum")        { return rain_accum; }
        if (name == "snow_accum")        { return snow_accum; }
        if (name == "graup_accum")       { return graup_accum; }
        if (name == "rel_humidity")      { return rel_hum; }
        if (name == "condensation_rate") { return cond_rate; }
        return absent;
    }

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

Here is the caller graph for this function:

query_var()

VarAvailability MoistureComponentIndices::query_var ( const std::string &  name ) const

inline

Classify an output variable name against this index map.

This is the one table pairing output names with the data behind them. It is driven off the scheme's index map rather than an enumerated list of moisture models, so it stays correct as schemes are added. Names with no moisture dependence come back not-governed, which lets a caller walk a mixed list of variable names and only defer to this map where it applies.

Parameters

name	Derived or plot variable name.

                                                                          {
 
        // Single species, taken straight from the conserved state
        if ( (name == "qv") || (name == "qc") || (name == "qi") ||
             (name == "qrain") || (name == "qsnow") || (name == "qgraup") ||
             (name == "nc") || (name == "ni") || (name == "nr") ||
             (name == "ns") || (name == "ng") || (name == "nn") ) {
            return {true, comp_for_var(name) >= 0};
        }
 
        // Moist diagnostics, either from a qmoist array or derived at output time
        if ( (name == "rain_accum") || (name == "snow_accum") ||
             (name == "graup_accum") || (name == "rel_humidity") ||
             (name == "condensation_rate") ) {
            return {true, qmoist_index_for_var(name) != absent};
        }
 
        // Aggregates over several species
        if (name == "qt") { return {true, !total_water_comps().empty()}; }
        if (name == "qp") { return {true, !precipitating_comps().empty()}; }
 
        // Non-precipitating water is vapor plus the suspended condensate, and
        // moist density adds that same sum to the dry density
        if ( (name == "qn") || (name == "moist_density") ) {
            return {true, (qv >= 0) && (qc >= 0)};
        }
 
        // Column and thermodynamic diagnostics that read vapor only
        if ( (name == "qsat") || (name == "precipitable") ) {
            return {true, has_moisture()};
        }
 
        return {false, false};
    }

Referenced by has_derived_var(), and erf_plotfile::plot3d_fixed_variable_available().

Here is the call graph for this function:

Here is the caller graph for this function:

total_water_comps()

CompList MoistureComponentIndices::total_water_comps ( ) const

inline

Components summed for total water, "qt": every mass mixing ratio.

Number concentrations are excluded – they are counts, not masses.

                                                      {
        CompList list;
        list.append(qv); list.append(qc); list.append(qi);
        list.append(qr); list.append(qs); list.append(qg);
        return list;
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

absent

constexpr int MoistureComponentIndices::absent = -1

staticconstexpr

not carried by the active scheme

Referenced by comp_for_var(), qmoist_index_for_var(), and query_var().

computed_from_state

constexpr int MoistureComponentIndices::computed_from_state = -2

staticconstexpr

carried, but derived at output time from the conserved state rather than read from a qmoist slot

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

cond_rate

int MoistureComponentIndices::cond_rate = absent

condensation rate

Referenced by from_moisture_model(), and qmoist_index_for_var().

graup_accum

int MoistureComponentIndices::graup_accum = absent

accumulated surface graupel

Referenced by from_moisture_model(), and qmoist_index_for_var().

nc

int MoistureComponentIndices::nc = absent

cloud liquid water number

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

ng

int MoistureComponentIndices::ng = absent

graupel number

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

ni

int MoistureComponentIndices::ni = absent

cloud ice number

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

nn

int MoistureComponentIndices::nn = absent

CCN / total aerosol number.

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

nr

int MoistureComponentIndices::nr = absent

rain number

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

ns

int MoistureComponentIndices::ns = absent

snow number

Referenced by comp_for_var(), from_moisture_model(), and has_comp().

qc

int MoistureComponentIndices::qc = absent

cloud liquid water

Referenced by ShocDriver::apply_state_update(), comp_for_var(), SurfaceLayer::compute_pblh(), ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), ComputeN2(), ComputeN2_EB(), erf_slow_rhs_post(), ShocPreprocess::fill_columns(), ERF::FillPlot3DVars(), from_moisture_model(), ERF::GetFillableAtmosToOceanLanes(), GetMoistureVars(), GetThetavl(), has_comp(), ERF::HasCloudWater(), SolverChoice::init_params(), nonprecipitating_comps(), ERF::PackAtmosphericStates(), query_var(), RadiationSimple::RadiationSimple(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

qg

int MoistureComponentIndices::qg = absent

graupel

Referenced by comp_for_var(), SurfaceLayer::compute_pblh(), from_moisture_model(), GetMoistureVars(), has_comp(), has_reflectivity_species(), SolverChoice::init_params(), precipitating_comps(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

qi

int MoistureComponentIndices::qi = absent

cloud ice

Referenced by ShocDriver::apply_state_update(), comp_for_var(), SurfaceLayer::compute_pblh(), ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), ShocPreprocess::fill_columns(), from_moisture_model(), ERF::GetFillableAtmosToOceanLanes(), GetMoistureVars(), GetThetavl(), has_comp(), ERF::HasCloudWater(), SolverChoice::init_params(), nonprecipitating_comps(), ERF::PackAtmosphericStates(), Radiation::Radiation(), RadiationSimple::RadiationSimple(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

qr

int MoistureComponentIndices::qr = absent

rain

Referenced by comp_for_var(), SurfaceLayer::compute_pblh(), erf_slow_rhs_post(), from_moisture_model(), GetMoistureVars(), has_comp(), has_reflectivity_species(), SolverChoice::init_params(), ERF::PackAtmosphericStates(), precipitating_comps(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

qs

int MoistureComponentIndices::qs = absent

snow

Referenced by comp_for_var(), SurfaceLayer::compute_pblh(), from_moisture_model(), GetMoistureVars(), has_comp(), has_reflectivity_species(), SolverChoice::init_params(), precipitating_comps(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

qv

int MoistureComponentIndices::qv = absent

water vapor

Referenced by ShocDriver::apply_state_update(), comp_for_var(), SurfaceLayer::compute_pblh(), ComputeDiffusivityMRF(), ComputeDiffusivityMYJ(), ComputeDiffusivityYSU(), ComputeDiffusivityYSUNew(), ComputeN2(), ComputeN2_EB(), ComputeQKESourceTerms(), ShocPreprocess::fill_columns(), ERF::FillPlot3DVars(), from_moisture_model(), GetMoistureVars(), GetThetavl(), has_comp(), has_moisture(), SolverChoice::init_params(), nonprecipitating_comps(), query_var(), RadiationSimple::RadiationSimple(), total_water_comps(), and wrf_bdy_var_for_moisture_component().

rain_accum

int MoistureComponentIndices::rain_accum = absent

accumulated surface rain

Referenced by from_moisture_model(), and qmoist_index_for_var().

rel_hum

int MoistureComponentIndices::rel_hum = absent

relative humidity

Referenced by ERF::FillPlot3DVars(), from_moisture_model(), and qmoist_index_for_var().

snow_accum

int MoistureComponentIndices::snow_accum = absent

accumulated surface snow

Referenced by from_moisture_model(), and qmoist_index_for_var().

---

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

• Source/DataStructs/ERF_DataStruct.H