openswmm::ForcingData Struct Reference

#include <ForcingData.hpp>

Collaboration diagram for openswmm::ForcingData:

Public Member Functions
void	resize (int n_nodes, int n_links, int n_subcatches, int n_gages, int n_pollutants)
	Allocate all arrays and initialise to NONE / 0 / RESET.
void	clear_all ()
	Reset ALL forcing modes to NONE (called on simulation restart).
void	clear_reset_entries ()
	Clear only RESET-persistence entries (called at end of each step).

Public Attributes
std::vector< ForcingMode >	node_lat_inflow_mode
std::vector< double >	node_lat_inflow_value
std::vector< ForcingPersist >	node_lat_inflow_persist
std::vector< ForcingMode >	node_head_boundary_mode
std::vector< double >	node_head_boundary_value
std::vector< ForcingPersist >	node_head_boundary_persist
std::vector< ForcingMode >	node_quality_mode
std::vector< double >	node_quality_value
	mass rate (mass/sec)
std::vector< ForcingPersist >	node_quality_persist
std::vector< ForcingMode >	link_flow_mode
std::vector< double >	link_flow_value
std::vector< ForcingPersist >	link_flow_persist
std::vector< ForcingMode >	link_setting_mode
std::vector< double >	link_setting_value
	0.0–1.0 for pump/orifice/weir
std::vector< ForcingPersist >	link_setting_persist
std::vector< ForcingMode >	subcatch_rainfall_mode
std::vector< double >	subcatch_rainfall_value
	user units (in/hr or mm/hr)
std::vector< ForcingPersist >	subcatch_rainfall_persist
std::vector< ForcingMode >	subcatch_evap_mode
std::vector< double >	subcatch_evap_value
	ft/sec (internal units)
std::vector< ForcingPersist >	subcatch_evap_persist
std::vector< ForcingMode >	gage_rainfall_mode
std::vector< double >	gage_rainfall_value
	user units (in/hr or mm/hr)
std::vector< ForcingPersist >	gage_rainfall_persist
int	n_nodes_ = 0
int	n_links_ = 0
int	n_subcatches_ = 0
int	n_gages_ = 0
int	n_pollutants_ = 0

Member Function Documentation

clear_all()

void openswmm::ForcingData::clear_all ( )

inline

Reset ALL forcing modes to NONE (called on simulation restart).

clear_reset_entries()

void openswmm::ForcingData::clear_reset_entries ( )

inline

Clear only RESET-persistence entries (called at end of each step).

After the forcing has been applied for this timestep, entries with RESET persistence are set back to NONE so they do not carry forward to the next step. PERSIST entries are untouched.

resize()

void openswmm::ForcingData::resize ( int  n_nodes, int  n_links, int  n_subcatches, int  n_gages, int  n_pollutants  )

inline

Allocate all arrays and initialise to NONE / 0 / RESET.

Member Data Documentation

gage_rainfall_mode

std::vector<ForcingMode> openswmm::ForcingData::gage_rainfall_mode

gage_rainfall_persist

std::vector<ForcingPersist> openswmm::ForcingData::gage_rainfall_persist

gage_rainfall_value

std::vector<double> openswmm::ForcingData::gage_rainfall_value

user units (in/hr or mm/hr)

link_flow_mode

std::vector<ForcingMode> openswmm::ForcingData::link_flow_mode

link_flow_persist

std::vector<ForcingPersist> openswmm::ForcingData::link_flow_persist

link_flow_value

std::vector<double> openswmm::ForcingData::link_flow_value

link_setting_mode

std::vector<ForcingMode> openswmm::ForcingData::link_setting_mode

link_setting_persist

std::vector<ForcingPersist> openswmm::ForcingData::link_setting_persist

link_setting_value

std::vector<double> openswmm::ForcingData::link_setting_value

0.0–1.0 for pump/orifice/weir

n_gages_

int openswmm::ForcingData::n_gages_ = 0

n_links_

int openswmm::ForcingData::n_links_ = 0

n_nodes_

int openswmm::ForcingData::n_nodes_ = 0

n_pollutants_

int openswmm::ForcingData::n_pollutants_ = 0

n_subcatches_

int openswmm::ForcingData::n_subcatches_ = 0

node_head_boundary_mode

std::vector<ForcingMode> openswmm::ForcingData::node_head_boundary_mode

node_head_boundary_persist

std::vector<ForcingPersist> openswmm::ForcingData::node_head_boundary_persist

node_head_boundary_value

std::vector<double> openswmm::ForcingData::node_head_boundary_value

node_lat_inflow_mode

std::vector<ForcingMode> openswmm::ForcingData::node_lat_inflow_mode

node_lat_inflow_persist

std::vector<ForcingPersist> openswmm::ForcingData::node_lat_inflow_persist

node_lat_inflow_value

std::vector<double> openswmm::ForcingData::node_lat_inflow_value

node_quality_mode

std::vector<ForcingMode> openswmm::ForcingData::node_quality_mode

node_quality_persist

std::vector<ForcingPersist> openswmm::ForcingData::node_quality_persist

node_quality_value

std::vector<double> openswmm::ForcingData::node_quality_value

mass rate (mass/sec)

subcatch_evap_mode

std::vector<ForcingMode> openswmm::ForcingData::subcatch_evap_mode

subcatch_evap_persist

std::vector<ForcingPersist> openswmm::ForcingData::subcatch_evap_persist

subcatch_evap_value

std::vector<double> openswmm::ForcingData::subcatch_evap_value

ft/sec (internal units)

subcatch_rainfall_mode

std::vector<ForcingMode> openswmm::ForcingData::subcatch_rainfall_mode

subcatch_rainfall_persist

std::vector<ForcingPersist> openswmm::ForcingData::subcatch_rainfall_persist

subcatch_rainfall_value

std::vector<double> openswmm::ForcingData::subcatch_rainfall_value

user units (in/hr or mm/hr)

---

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

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