erf_plotfile Namespace Reference

Classes
struct	Plot3DSelectionCapabilities
	What the active run can supply to a 3D plotfile. More...

Functions
bool	radiation_heating_storage_available (RadiationType rad_model)
	Whether the SW/LW heating-rate storage (qsrc_sw, qsrc_lw) exists: every erf.radiation_model other than None (RRTMGP, Simple, TwoStream) allocates the same qheating_rates array. More...
void	plot3d_set_state_capabilities (Plot3DSelectionCapabilities &caps, const MoistureComponentIndices &mi, const int qstate_moist_size, const int qstate_size)
	Record the conserved-state layout of a run on its capabilities. More...
bool	plot3d_batch_resets_interval_means (int plotfiles_written, bool interval_diagnostic_consumed, bool compute_mean_vars, const std::string &reset_mode)
int	plot3d_q_conserved_component_index (const int q)
	Conserved-state component holding the q-th moist variable, or -1 if q is outside the fixed RhoQ1..RhoQ11 layout. More...
amrex::Vector< std::string >	plot3d_conserved_state_names ()
	Names of the raw conserved-state variables, in component order. More...
int	plot3d_conserved_component_index (const std::string &name)
	Conserved-state component behind a raw state variable name ("density", "rhotheta", "smoke", "rhoQ3", ...), or -1 if the name is not one. The smoke scalar is written as stored, i.e. as a mass concentration (rho times the mixing ratio), like rhoadv_0. More...
bool	plot3d_fixed_unconditional_diagnostic (const std::string &name)
	Diagnostics that every run can write, moist or dry. More...
bool	plot3d_interval_mean_diagnostic (const std::string &name)
	Whether a named 3D plot variable can be written by this run. More...
bool	plot3d_selection_has_interval_mean_diagnostic (const amrex::Vector< std::string > &names)
bool	plot3d_fixed_variable_available (const std::string &name, const Plot3DSelectionCapabilities &caps)
bool	plot3d_needs_pressure (const amrex::Vector< std::string > &names)
	Whether any requested variable needs the pressure field computed. More...
amrex::Vector< std::string >	plot3d_selected_particle_count_names (const amrex::Vector< std::string > &requested, const amrex::Vector< std::string > &configured)

Function Documentation

plot3d_batch_resets_interval_means()

bool erf_plotfile::plot3d_batch_resets_interval_means ( int  plotfiles_written, bool  interval_diagnostic_consumed, bool  compute_mean_vars, const std::string &  reset_mode  )

inline

{
    return plotfiles_written > 0 && interval_diagnostic_consumed &&
           compute_mean_vars && reset_mode == "plotfile";
}

Referenced by ERF::ResetIntervalMeansAfter3DPlotfileBatch().

Here is the caller graph for this function:

plot3d_conserved_component_index()

int erf_plotfile::plot3d_conserved_component_index ( const std::string &  name )

inline

Conserved-state component behind a raw state variable name ("density", "rhotheta", "smoke", "rhoQ3", ...), or -1 if the name is not one. The smoke scalar is written as stored, i.e. as a mass concentration (rho times the mixing ratio), like rhoadv_0.

{
    if (name == "density")  return Rho_comp;
    if (name == "rhotheta") return RhoTheta_comp;
    if (name == "rhoKE")    return RhoKE_comp;
    if (name == "rhoadv_0") return RhoScalar_comp;
#ifdef ERF_USE_FIRE
    if (name == "smoke") return RhoSmoke_comp;
#endif
 
    if (name.size() > 4 && name.compare(0, 4, "rhoQ") == 0) {
        // Parse the digits by hand, stopping once past the RhoQ11 limit, so a
        // long numeric suffix cannot overflow int (std::stoi would throw)
        int q = 0;
        for (std::size_t i = 4; i < name.size(); ++i) {
            const char c = name[i];
            if (c < '0' || c > '9') return -1;
            q = 10 * q + (c - '0');
            if (q > 11) return -1;
        }
        return plot3d_q_conserved_component_index(q);
    }
 
    return -1;
}

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

Here is the call graph for this function:

Here is the caller graph for this function:

plot3d_conserved_state_names()

amrex::Vector<std::string> erf_plotfile::plot3d_conserved_state_names ( )

inline

Names of the raw conserved-state variables, in component order.

The optional smoke scalar (RhoSmoke_comp, under ERF_USE_FIRE) sits between rhoadv_0 and rhoQ1 exactly as in ERF_IndexDefines.H. Every name here must map to a component in plot3d_conserved_component_index, or it can never be plotted.

{
    amrex::Vector<std::string> names = {"density", "rhotheta", "rhoKE", "rhoadv_0"};
#ifdef ERF_USE_FIRE
    names.push_back("smoke");
#endif
    names.insert(names.end(), {
        "rhoQ1",  "rhoQ2",  "rhoQ3",
        "rhoQ4",  "rhoQ5",  "rhoQ6",
        "rhoQ7",  "rhoQ8",  "rhoQ9",
        "rhoQ10", "rhoQ11"
    });
    return names;
}

plot3d_fixed_unconditional_diagnostic()

bool erf_plotfile::plot3d_fixed_unconditional_diagnostic ( const std::string &  name )

inline

Diagnostics that every run can write, moist or dry.

{
    static constexpr const char* names[] = {
        "temp", "theta", "KE", "scalar", "soundspeed", "reflectivity",
        "max_reflectivity", "mucape", "vorticity_x", "vorticity_y", "vorticity_z",
        "helicity", "local_helicity", "vort_stretching",
        "magvel", "divU", "pres_hse", "dens_hse",
        "theta_hse", "pi_hse", "qv_hse", "pressure", "pert_pres", "pert_dens", "buoyancy",
        "eq_pot_temp", "VPD", "dpdx", "dpdy", "dpdz", "pres_hse_x", "pres_hse_y",
        "pres_hse_z", "z_phys", "detJ", "h_xi", "h_eta", "h_zeta",
        "mapfac", "lat_m", "lon_m", "pblh",
        "shoc_cldfrac", "shoc_ql", "shoc_ql2", "shoc_cond", "wqls_sec", "wthv_sec",
        "w_sec", "thl_sec", "qw_sec", "qwthl_sec", "wthl_sec", "wqw_sec", "w3",
        "brunt", "isotropy", "shear_prod", "buoy_prod", "diss_tke",
        "terrain_IB_mask", "volfrac",
        "ibseb_nfaces", "ibseb_tskin", "ibseb_sw_abs", "ibseb_shadow",
        "ibseb_lw_net", "ibseb_f_sky", "ibseb_H", "ibseb_G",
        "Tau11", "Tau12", "Tau13", "Tau21", "Tau22", "Tau23",
        "Tau31", "Tau32", "Tau33", "hfx1", "hfx2", "hfx3",
        "q1fx1", "q1fx2", "q1fx3", "q2fx3"
    };
 
    for (const char* candidate : names) {
        if (name == candidate) return true;
    }
 
    return false;
}

Referenced by plot3d_fixed_variable_available().

Here is the caller graph for this function:

plot3d_fixed_variable_available()

bool erf_plotfile::plot3d_fixed_variable_available ( const std::string &  name, const Plot3DSelectionCapabilities &  caps  )

inline

{
    const MoistureComponentIndices& mi = caps.moisture_indices;
 
    // Raw conserved-state components.  Inside the moist window the moisture map
    // decides, since allocated-but-never-integrated slots must not be published
    // as data.  Below the window the state is always allocated dry-or-moist, and
    // above it are the non-water species a scheme may add -- both of those are
    // real data whenever they were allocated, so a bounds check is the right
    // test for them.
    const int cons_comp = plot3d_conserved_component_index(name);
    if (cons_comp >= 0) {
        if ( (cons_comp >= RhoQ1_comp) &&
             (cons_comp <  RhoQ1_comp + caps.moist_state_size) ) {
            return mi.has_comp(cons_comp);
        }
        return (cons_comp < caps.conserved_state_size);
    }
 
    // Every moisture variable -- species, aggregates and moist diagnostics --
    // is decided by the scheme's index map.
    const auto moist_status = mi.query_var(name);
    if (moist_status.governed) return moist_status.available;
 
    if (name == "u_t_avg" || name == "v_t_avg" || name == "w_t_avg" ||
        name == "umag_t_avg") {
        return caps.time_average_storage;
    }
    if (plot3d_interval_mean_diagnostic(name)) {
        return caps.interval_mean_storage;
    }
    if (name == "qsrc_sw" || name == "qsrc_lw") {
        return caps.radiation_heating_storage;
    }
    if (name == "nut" || name == "Kmv" || name == "Kmh" ||
        name == "Khv" || name == "Khh" || name == "Lturb") {
        return caps.eddy_diffusivity_storage;
    }
    if (name == "Rt" || name == "cmu" || name == "cmu_prime" || name == "cap_ratio") {
        return caps.eddy_diffusivity_storage;
    }
    if (name == "diss") return caps.dissipation_storage;
    if (name == "walldist") return caps.wall_distance_storage;
 
    return plot3d_fixed_unconditional_diagnostic(name);
}

Referenced by ERF::canonicalizePlot3DVariables(), and ERF::setSubVolVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

plot3d_interval_mean_diagnostic()

bool erf_plotfile::plot3d_interval_mean_diagnostic ( const std::string &  name )

inline

Whether a named 3D plot variable can be written by this run.

The order of the tests below is the order of authority: raw state components answer from the state layout, moisture variables answer from the active scheme's index map, optional diagnostics answer from their storage flag, and anything left is an always-available diagnostic.

{
    static constexpr const char* names[] = {
        "u_mean", "v_mean", "w_mean", "theta_mean",
        "uu_mean", "vv_mean", "ww_mean", "uw_mean", "vw_mean", "wtheta_mean",
        "uu_fluct", "vv_fluct", "ww_fluct", "uw_fluct", "vw_fluct", "wtheta_fluct", "tke_resolved"
    };
 
    for (const char* candidate : names) {
        if (name == candidate) return true;
    }
    return false;
}

Referenced by plot3d_fixed_variable_available().

Here is the caller graph for this function:

plot3d_needs_pressure()

bool erf_plotfile::plot3d_needs_pressure ( const amrex::Vector< std::string > &  names )

inline

Whether any requested variable needs the pressure field computed.

{
    for (const auto& name : names) {
        if (name == "pressure" || name == "pert_pres" ||
            name == "dpdx" || name == "dpdy" || name == "dpdz" ||
            name == "eq_pot_temp" || name == "VPD" || name == "qsat" ||
            name == "rel_humidity") {
            return true;
        }
    }
    return false;
}

Referenced by ERF::FillPlot3DVars().

Here is the caller graph for this function:

plot3d_q_conserved_component_index()

int erf_plotfile::plot3d_q_conserved_component_index ( const int  q )

inline

Conserved-state component holding the q-th moist variable, or -1 if q is outside the fixed RhoQ1..RhoQ11 layout.

{
    if (q < 1 || q > 11) return -1;
    return RhoQ1_comp + q - 1;
}

Referenced by plot3d_conserved_component_index().

Here is the caller graph for this function:

plot3d_selected_particle_count_names()

amrex::Vector<std::string> erf_plotfile::plot3d_selected_particle_count_names ( const amrex::Vector< std::string > &  requested, const amrex::Vector< std::string > &  configured  )

inline

{
    amrex::Vector<std::string> selected;
    for (const auto& count_name : requested) {
        constexpr std::size_t suffix_size = 6; // "_count"
        if (count_name.size() > suffix_size &&
            count_name.compare(count_name.size() - suffix_size, suffix_size, "_count") == 0) {
            const std::string container = count_name.substr(0, count_name.size() - suffix_size);
            if (std::find(configured.cbegin(), configured.cend(), container) == configured.cend() ||
                std::find(selected.cbegin(), selected.cend(), container) != selected.cend()) {
                continue;
            }
            selected.push_back(container);
        }
    }
    return selected;
}

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

Here is the caller graph for this function:

plot3d_selection_has_interval_mean_diagnostic()

bool erf_plotfile::plot3d_selection_has_interval_mean_diagnostic ( const amrex::Vector< std::string > &  names )

inline

{
    return std::any_of(names.begin(), names.end(),
                       [] (const std::string& name) {
                           return plot3d_interval_mean_diagnostic(name);
                       });
}

Referenced by ERF::WriteAtFinalTime(), and ERF::WriteAtIntermediateTime().

Here is the caller graph for this function:

plot3d_set_state_capabilities()

void erf_plotfile::plot3d_set_state_capabilities ( Plot3DSelectionCapabilities &  caps, const MoistureComponentIndices &  mi, const int  qstate_moist_size, const int  qstate_size  )

inline

Record the conserved-state layout of a run on its capabilities.

Every output path that selects raw state names must describe the state the same way, so the three fields are filled here rather than at each call site.

Parameters

caps	Capabilities to fill in.
mi	The active scheme's component/diagnostic map.
qstate_moist_size	Conserved components in the moist window (Microphysics::Get_Qstate_Moist_Size()).
qstate_size	All conserved components the microphysics adds, moist window plus non-water species (Microphysics::Get_Qstate_Size()).

{
    caps.moisture_indices     = mi;
    caps.moist_state_size     = qstate_moist_size;
    caps.conserved_state_size = NDRY + NSCALARS + qstate_size;
}

Referenced by ERF::canonicalizePlot3DVariables(), and ERF::setSubVolVariables().

Here is the caller graph for this function:

radiation_heating_storage_available()

bool erf_plotfile::radiation_heating_storage_available ( RadiationType  rad_model )

inline

Whether the SW/LW heating-rate storage (qsrc_sw, qsrc_lw) exists: every erf.radiation_model other than None (RRTMGP, Simple, TwoStream) allocates the same qheating_rates array.

{
    return rad_model != RadiationType::None;
}

Referenced by ERF::canonicalizePlot3DVariables().

Here is the caller graph for this function: