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

#include <ERF_PlotfileSelection.H>

Collaboration diagram for erf_plotfile::Plot3DSelectionCapabilities:

[legend]

Public Attributes
int	conserved_state_size = 0

int	moist_state_size = NMOIST_max

MoistureComponentIndices	moisture_indices
	The active moisture scheme's component/diagnostic map. More...

bool	time_average_storage = false

bool	interval_mean_storage = false

bool	radiation_heating_storage = false

bool	eddy_diffusivity_storage = false

bool	dissipation_storage = false

bool	wall_distance_storage = false

Detailed Description

What the active run can supply to a 3D plotfile.

Availability of the moist components is not described here: it comes from the active scheme's MoistureComponentIndices, which is the single source of truth for which moisture variables exist (see the class comment on that struct). What remains in this struct is the conserved-state layout – needed to know where the moist window ends and the non-water species begin – and the optional non-moisture storage, which a plot variable can only be selected against if it was actually allocated.

Member Data Documentation

◆ conserved_state_size

int erf_plotfile::Plot3DSelectionCapabilities::conserved_state_size = 0

Width of the allocated conserved state, i.e. NDRY + NSCALARS plus every component the microphysics interface adds. This bounds the dry components and the non-water species some schemes carry above the moist window; it is deliberately not what gates the moist components.

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

◆ dissipation_storage

bool erf_plotfile::Plot3DSelectionCapabilities::dissipation_storage = false

Referenced by erf_plotfile::plot3d_fixed_variable_available(), and ERF::setPlotVariables().

◆ eddy_diffusivity_storage

bool erf_plotfile::Plot3DSelectionCapabilities::eddy_diffusivity_storage = false

Referenced by erf_plotfile::plot3d_fixed_variable_available(), and ERF::setPlotVariables().

◆ interval_mean_storage

bool erf_plotfile::Plot3DSelectionCapabilities::interval_mean_storage = false

Referenced by erf_plotfile::plot3d_fixed_variable_available(), and ERF::setPlotVariables().

◆ moist_state_size

int erf_plotfile::Plot3DSelectionCapabilities::moist_state_size = NMOIST_max

Number of conserved components in the moist window that starts at RhoQ1_comp. Inside that window a component is gated by moisture_indices rather than by allocation, because several schemes allocate moist slots they never integrate. Above the window sit the non-water species a scheme may add (SuperDroplets), which are allocated and integrated and so are gated by conserved_state_size like the dry components.

The default is the full RhoQ1..RhoQ11 window, i.e. "let the moisture map decide about every rhoQn slot", which is the conservative answer for a caller that does not know the scheme's width.

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