openswmm::TreatmentData Struct Reference

#include <QualityData.hpp>

Collaboration diagram for openswmm::TreatmentData:

Public Member Functions
void	resize (int nn, int npoll)
	Resize node-major treatment storage and reset authored expressions/workspaces.
void	shrink_to_fit ()
	Request capacity reduction for authored and compiled expression vectors.
bool	hasAny () const
	Test whether any authored treatment expression is nonempty.

Public Attributes
std::vector< std::string >	expressions
	Index: [node * n_pollutants + pollutant].
int	n_nodes = 0
int	n_pollutants = 0
std::vector< openswmm::treatment::TreatExpr >	compiled
	Compiled treatment expressions (same indexing as expressions[])
std::vector< bool >	has_treatment
	Per-node flag: true if any pollutant has a treatment expression.
std::vector< double >	cin
	Per-node inflow concentrations (size = n_pollutants, reused each timestep)
std::vector< double >	removal

Member Function Documentation

hasAny()

bool openswmm::TreatmentData::hasAny ( ) const

inline

Test whether any authored treatment expression is nonempty.

Does not inspect compiled validity or has_treatment flags.

Returns

True if any expressions string has bytes; whitespace alone counts.

Here is the caller graph for this function:

resize()

void openswmm::TreatmentData::resize ( int nn, int npoll )

inline

Resize node-major treatment storage and reset authored expressions/workspaces.

Empties every authored expression, resets has_treatment=false, inflow workspace zero and removal=-1. Compiled expressions use resize, retaining any existing prefix rather than clearing it; caller recompiles or otherwise synchronizes them. Counts change before allocations; no rollback on failure.

Parameters

[in]	nn	Nonnegative node count.
[in]	npoll	Nonnegative pollutants per node; nn*npoll must fit signed int before conversion to size_t.

Here is the caller graph for this function:

shrink_to_fit()

void openswmm::TreatmentData::shrink_to_fit ( )

inline

Request capacity reduction for authored and compiled expression vectors.

Does not compact has_treatment, cin or removal. Values persist; vector relocation can invalidate references and allocation can throw.

Member Data Documentation

cin

std::vector<double> openswmm::TreatmentData::cin

Per-node inflow concentrations (size = n_pollutants, reused each timestep)

compiled

std::vector<openswmm::treatment::TreatExpr> openswmm::TreatmentData::compiled

Compiled treatment expressions (same indexing as expressions[])

expressions

std::vector<std::string> openswmm::TreatmentData::expressions

Index: [node * n_pollutants + pollutant].

e.g. "R = 0.5 * exp(-0.1 * DT)"

has_treatment

std::vector<bool> openswmm::TreatmentData::has_treatment

Per-node flag: true if any pollutant has a treatment expression.

n_nodes

int openswmm::TreatmentData::n_nodes = 0

n_pollutants

int openswmm::TreatmentData::n_pollutants = 0

removal

std::vector<double> openswmm::TreatmentData::removal

Per-node removal fractions (size = n_pollutants, reused each timestep) -1.0 = not computed, 0-1 = computed, > 1.0 = currently being evaluated (cycle detect)

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/data/QualityData.hpp