openswmm::twoD::SubsurfaceConfig Struct Reference

Everything the parser fills, before resolution onto cells. More...

#include <SubsurfaceData.hpp>

Collaboration diagram for openswmm::twoD::SubsurfaceConfig:

Public Member Functions
bool	empty () const noexcept
	< Explicit SUBCATCH UNIFORM records; not aquifer activation.
void	clear ()
	Replace authored groundwater configuration with its default-constructed state.

Public Attributes
GwOptions	options
std::vector< GwAquiferRow >	rows
std::vector< GwNodeBed >	node_beds
std::vector< GwBoundaryRow >	boundaries
std::vector< GwLinkRow >	link_rows
	G-X4: [2D_AQUIFER_LINKS].
std::vector< SurfaceOwnerRecord >	surface_owners

Detailed Description

Everything the parser fills, before resolution onto cells.

Member Function Documentation

clear()

void openswmm::twoD::SubsurfaceConfig::clear ( )

inline

Replace authored groundwater configuration with its default-constructed state.

Note

Clears all row containers including surface_owners, resets options, and invalidates references to their elements. Does not touch a separately initialized SubsurfaceState.

empty()

bool openswmm::twoD::SubsurfaceConfig::empty ( ) const

inlinenoexcept

< Explicit SUBCATCH UNIFORM records; not aquifer activation.

Test whether aquifer authorship or hydraulic coupling rows require activation.

Returns

True only when options.authored is false and aquifer, node-bed, link and boundary rows are empty. Explicit surface_owners records alone do not make this configuration nonempty.

Here is the caller graph for this function:

Member Data Documentation

boundaries

std::vector<GwBoundaryRow> openswmm::twoD::SubsurfaceConfig::boundaries

link_rows

std::vector<GwLinkRow> openswmm::twoD::SubsurfaceConfig::link_rows

G-X4: [2D_AQUIFER_LINKS].

node_beds

std::vector<GwNodeBed> openswmm::twoD::SubsurfaceConfig::node_beds

options

GwOptions openswmm::twoD::SubsurfaceConfig::options

rows

std::vector<GwAquiferRow> openswmm::twoD::SubsurfaceConfig::rows

surface_owners

std::vector<SurfaceOwnerRecord> openswmm::twoD::SubsurfaceConfig::surface_owners

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/2d/subsurface/SubsurfaceData.hpp