SWMM Global Interfacing Functions

SWMM global interfacing functions. More...

Collaboration diagram for SWMM Global Interfacing Functions:

Topics
	Global Project Methods
	Global methods associated with a SWMM project.
	Global Input Reader Methods
	Global input reader methods.
	Global Report Writer Methods
	Global report writer methods.
	Global Temperature/Evaporation Methods
	Global temperature/evaporation methods.
	Global Rainfall Processing Methods
	Global rainfall processing methods.
	Global Snowmelt Processing Methods
	Global snowmelt processing methods.
	Global Runoff Analyzer Methods
	Global runoff analyzer methods.
	Global Conveyance System Routing Methods
	Global conveyance system routing methods.
	Global Output File Methods
	Global output file methods.
	Global Groundwater Methods
	Global groundwater methods.
	Global RDII Methods
	Global RDII methods.
	Global Land Use Methods
	Global RDII methods.
	Global Flow/Quality Routing Methods
	Global flow/quality routing methods.
	Global Treatment Methods
	Global treatment methods.
	Global Mass Balance Methods
	Global mass balance methods.
	Global Simulation Statistics Methods
	Global simulation statistics methods.
	Global Raingage Methods
	Global raingage methods.
	Global Subcatchments Methods
	Global subcatchment methods.
	Global Surface Pollutant Buildup/Washoff Methods
	Global surface pollutant buildup/washoff methods.
	Global Conveyance System Node Methods
	Global conveyance system node methods.
	Global Conveyance System Inflow Methods
	Global conveyance system inflow methods.
	Global Control Rule Methods
	Global control rules methods.
	Global Utility Methods
	Global utility methods.

Functions
int	iface_readFileParams (char *tok[], int ntoks)
	Reads interface file information from a line of input data. Data format is: USE/SAVE FileType FileName.
void	iface_openRoutingFiles (void)
	Opens routing interface files.
void	iface_closeRoutingFiles (void)
	Closes routing interface files.
int	iface_getNumIfaceNodes (DateTime aDate)
	Reads inflow data from interface file at current date.
int	iface_getIfaceNode (int index)
	Finds index of project node associated with interface node index.
double	iface_getIfaceFlow (int index)
	Finds interface flow for particular node index.
double	iface_getIfaceQual (int index, int pollut)
	Finds interface concentration for particular node index & pollutant.
void	iface_saveOutletResults (DateTime reportDate, FILE *file)
	Saves system outflows to routing interface file.

Detailed Description

SWMM global interfacing functions.

Function Documentation

iface_closeRoutingFiles()

void iface_closeRoutingFiles

(

void

)

Closes routing interface files.

Here is the call graph for this function:

Here is the caller graph for this function:

iface_getIfaceFlow()

double iface_getIfaceFlow

(

int

index

)

Finds interface flow for particular node index.

Parameters

[in]

index

Interface file node index.

Returns

Inflow to node.

iface_getIfaceNode()

int iface_getIfaceNode

(

int

index

)

Finds index of project node associated with interface node index.

Parameters

[in]

index

Interface file node index.

Returns

Project node index.

iface_getIfaceQual()

double iface_getIfaceQual	(	int	index,
		int	pollut )

Finds interface concentration for particular node index & pollutant.

Parameters

[in]	index	Index of node on interface file.
[in]	pollut	Index of pollutant on interface file.

Returns

Inflow pollutant concentration.

iface_getNumIfaceNodes()

int iface_getNumIfaceNodes

(

DateTime

currentDate

)

Reads inflow data from interface file at current date.

Parameters

[in]

currentDate

Current date/time.

Returns

Number of interface nodes if data exists or 0 otherwise.

iface_openRoutingFiles()

void iface_openRoutingFiles

(

void

)

Opens routing interface files.

Here is the call graph for this function:

Here is the caller graph for this function:

iface_readFileParams()

int iface_readFileParams	(	char *	tok[],
		int	ntoks )

Reads interface file information from a line of input data. Data format is: USE/SAVE FileType FileName.

Parameters

	tok	Array of string tokens.
[in]	ntoks	Number of tokens.

Returns

An error code.

Here is the call graph for this function:

iface_saveOutletResults()

void iface_saveOutletResults	(	DateTime	reportDate,
		FILE *	file )

Saves system outflows to routing interface file.

Parameters

[in]	reportDate	Reporting date/time.
	file	Ptr. to interface file.

Here is the call graph for this function:

Here is the caller graph for this function: