openswmm::iface::InterfaceManager Class Reference

#include <InterfaceFile.hpp>

Collaboration diagram for openswmm::iface::InterfaceManager:

Public Member Functions
void	init (SimulationContext &ctx)
int	openFiles (const std::string &infile_path, const std::string &outfile_path)
	Open routing interface files for reading/writing.
int	readFileHeader (SimulationContext &ctx)
void	writeFileHeader (const SimulationContext &ctx)
	Write the outflows file header. Called from SWMMEngine::start().
void	readInflows (SimulationContext &ctx, double current_time)
	Read next set of inflow values from upstream interface file.
void	writeOutfallResults (const SimulationContext &ctx, double current_time)
	Write current outfall results to downstream interface file.
void	closeFiles ()
	Close all interface files.
double	getFlow (int node_idx, double frac) const
	Get interpolated interface flow for a node.
double	getQuality (int node_idx, int pollut_idx, double frac) const
	Get interpolated interface quality for a node and pollutant.
int	getNumIfaceNodes () const
	Get number of interface nodes currently active.
int	getIfaceNode (int index) const
	Get the node index for a given interface file entry.
double	getFrac () const
	Get the interpolation fraction (set during readInflows)

Member Function Documentation

closeFiles()

void openswmm::iface::InterfaceManager::closeFiles

(

)

Close all interface files.

Here is the caller graph for this function:

getFlow()

double openswmm::iface::InterfaceManager::getFlow	(	int	node_idx,
		double	frac ) const

Get interpolated interface flow for a node.

Here is the caller graph for this function:

getFrac()

double openswmm::iface::InterfaceManager::getFrac ( ) const

inline

Get the interpolation fraction (set during readInflows)

getIfaceNode()

int openswmm::iface::InterfaceManager::getIfaceNode

(

int

index

)

const

Get the node index for a given interface file entry.

getNumIfaceNodes()

int openswmm::iface::InterfaceManager::getNumIfaceNodes ( ) const

inline

Get number of interface nodes currently active.

getQuality()

double openswmm::iface::InterfaceManager::getQuality	(	int	node_idx,
		int	pollut_idx,
		double	frac ) const

Get interpolated interface quality for a node and pollutant.

Here is the caller graph for this function:

init()

void openswmm::iface::InterfaceManager::init

(

SimulationContext &

ctx

)

Here is the call graph for this function:

openFiles()

int openswmm::iface::InterfaceManager::openFiles	(	const std::string &	infile_path,
		const std::string &	outfile_path )

Open routing interface files for reading/writing.

readFileHeader()

int openswmm::iface::InterfaceManager::readFileHeader

(

SimulationContext &

ctx

)

Read the inflows file header (flow units, pollutants, nodes). Called eagerly from SWMMEngine::start() after openFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

readInflows()

void openswmm::iface::InterfaceManager::readInflows	(	SimulationContext &	ctx,
		double	current_time )

Read next set of inflow values from upstream interface file.

Here is the call graph for this function:

writeFileHeader()

void openswmm::iface::InterfaceManager::writeFileHeader

(

const SimulationContext &

ctx

)

Write the outflows file header. Called from SWMMEngine::start().

Here is the call graph for this function:

writeOutfallResults()

void openswmm::iface::InterfaceManager::writeOutfallResults	(	const SimulationContext &	ctx,
		double	current_time )

Write current outfall results to downstream interface file.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/InterfaceFile.hpp
• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/InterfaceFile.cpp