Static properties for each pollutant species. More...

#include <PollutantData.hpp>

Collaboration diagram for openswmm::PollutantData:

Public Member Functions
int	n_pollutants () const noexcept

void	resize_pollutants (int n)
	Resize pollutant definition arrays to hold `n` pollutants.

void	shrink_to_fit ()
	Release excess vector capacity.

Public Attributes
std::vector< MassUnits >	units
	Concentration units for each pollutant.

std::vector< double >	mwt
	Molecular weight (g/mol). Used for unit conversions.

std::vector< double >	k_decay
	First-order decay coefficient (1/day).

std::vector< double >	c_rain
	Rain concentration (project mass/volume units).

std::vector< double >	c_gw
	Groundwater concentration.

std::vector< double >	c_rdii
	RDII concentration.

std::vector< double >	init_conc
	Initial concentration everywhere in the network.

std::vector< int >	co_pollut
	Co-pollutant index (-1 if none).

std::vector< double >	co_frac
	Co-fraction (fraction of co-pollutant concentration).

std::vector< bool >	snow_only
	True if the pollutant should be printed in output.

std::vector< std::string >	comments
	Object comment from the INP file (';'-prefixed lines immediately above this pollutant's data row), joined by literal "\\n". Empty string means no comment.

Detailed Description

Static properties for each pollutant species.

Holds definition-level information only. Concentration state at each node/link/subcatch is stored in NodeQuality, LinkQuality, SubcatchQuality (flat arrays in SimulationContext).

Member Function Documentation

◆ n_pollutants()

int openswmm::PollutantData::n_pollutants ( ) const

inlinenoexcept

◆ resize_pollutants()

void openswmm::PollutantData::resize_pollutants ( int n )

inline

Resize pollutant definition arrays to hold n pollutants.

Here is the caller graph for this function:

◆ shrink_to_fit()

void openswmm::PollutantData::shrink_to_fit ( )

inline

Release excess vector capacity.

Here is the caller graph for this function:

Member Data Documentation

◆ c_gw

std::vector<double> openswmm::PollutantData::c_gw

Groundwater concentration.

See also: Legacy: Pollut[i].cGW

◆ c_rain

std::vector<double> openswmm::PollutantData::c_rain

Rain concentration (project mass/volume units).

See also: Legacy: Pollut[i].cRain

◆ c_rdii

std::vector<double> openswmm::PollutantData::c_rdii

RDII concentration.

See also: Legacy: Pollut[i].cRDII

◆ co_frac

std::vector<double> openswmm::PollutantData::co_frac

Co-fraction (fraction of co-pollutant concentration).

See also: Legacy: Pollut[i].coFraction

◆ co_pollut

std::vector<int> openswmm::PollutantData::co_pollut

Co-pollutant index (-1 if none).

Used for co-fraction (fraction of co-pollutant).

See also: Legacy: Pollut[i].coPollut

◆ comments

std::vector<std::string> openswmm::PollutantData::comments

Object comment from the INP file (';'-prefixed lines immediately above this pollutant's data row), joined by literal "\\n". Empty string means no comment.

◆ init_conc

std::vector<double> openswmm::PollutantData::init_conc

Initial concentration everywhere in the network.

See also: Legacy: Pollut[i].initConc

◆ k_decay

std::vector<double> openswmm::PollutantData::k_decay

First-order decay coefficient (1/day).

See also: Legacy: Pollut[i].kDecay

◆ mwt

std::vector<double> openswmm::PollutantData::mwt

Molecular weight (g/mol). Used for unit conversions.

See also: Legacy: Pollut[i].mwt

◆ snow_only

std::vector<bool> openswmm::PollutantData::snow_only

True if the pollutant should be printed in output.

See also: Legacy: Pollut[i].snowOnly

◆ units

std::vector<MassUnits> openswmm::PollutantData::units

Concentration units for each pollutant.

See also: Legacy: Pollut[i].units

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

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/data/PollutantData.hpp

Public Member Functions

Public Attributes