Settings for one output domain (catchment or nexus). More...

#include <output.hpp>

Collaboration diagram for realization::config::OutputDomain:

Public Member Functions
	OutputDomain ()=default

	OutputDomain (const boost::property_tree::ptree &tree)

Public Attributes
bool	enable = true

OutputFormat	format = OutputFormat::csv

OutputGrouping	grouping = OutputGrouping::per_feature

bool	rank_subdir = false
	Place each MPI rank's files under a "rank_<N>/" subdirectory (the filesystem-layout axis, orthogonal to grouping).

Detailed Description

Settings for one output domain (catchment or nexus).

Constructor & Destructor Documentation

◆ OutputDomain() [1/2]

realization::config::OutputDomain::OutputDomain ( )

default

◆ OutputDomain() [2/2]

realization::config::OutputDomain::OutputDomain ( const boost::property_tree::ptree & tree )

inlineexplicit

References enable, format, grouping, realization::config::parse_output_format(), realization::config::parse_output_grouping(), and rank_subdir.

Member Data Documentation

◆ enable

bool realization::config::OutputDomain::enable = true

Referenced by OutputDomain(), and realization::config::Output::parse_legacy().

◆ format

OutputFormat realization::config::OutputDomain::format = OutputFormat::csv

Referenced by OutputDomain(), realization::Formulation_Manager::initialize_output_config(), realization::config::make_catchment_output_mgr(), realization::config::Output::parse_legacy(), and realization::Formulation_Manager::read().

◆ grouping

OutputGrouping realization::config::OutputDomain::grouping = OutputGrouping::per_feature

Referenced by OutputDomain(), realization::config::make_catchment_output_mgr(), and realization::config::rank_output_root().

◆ rank_subdir

bool realization::config::OutputDomain::rank_subdir = false

Place each MPI rank's files under a "rank_<N>/" subdirectory (the filesystem-layout axis, orthogonal to grouping).

Only affects distributed (multi-rank) runs; a no-op in serial. It is a free preference for per_feature; for per_formulation under MPI it is required (else ranks would collide on one aggregated file) and applied regardless.

See also: rank_output_root

Referenced by OutputDomain(), and realization::config::rank_output_root().

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

include/realizations/config/output.hpp

Public Member Functions

Public Attributes