Global Conveyance System Inflow Methods

Global conveyance system inflow methods. More...

Collaboration diagram for Global Conveyance System Inflow Methods:

Functions
int	inflow_readExtInflow (char *tok[], int ntoks)
	Reads parameters of a direct external inflow from a line of input.
int	inflow_readDwfInflow (char *tok[], int ntoks)
	Reads dry weather inflow parameters from line of input data.
int	inflow_readDwfPattern (char *tok[], int ntoks)
	Reads values of a time pattern from a line of input data.
int	inflow_setExtInflow (int nodeIndex, int param, int type, int tSeries, int basePat, double cf, double baseline, double sf)
	This function assigns property values to the inflow object.
void	inflow_initDwfInflow (TDwfInflow *inflow)
	Initialzes a dry weather inflow by ordering its time patterns.
void	inflow_initDwfPattern (int patternIndex)
	Initialzes a dry weather inflow time pattern.
double	inflow_getExtInflow (TExtInflow *inflow, DateTime aDate)
	Retrieves the value of an external inflow at a specific date and time.
double	inflow_getDwfInflow (TDwfInflow *inflow, int m, int d, int h)
	Computes dry weather inflow value at a specific point in time.
void	inflow_deleteExtInflows (int nodeIndex)
	Deletes all time series inflow data for a node.
void	inflow_deleteDwfInflows (int nodeIndex)
	Deletes all dry weather inflow data for a node.

Detailed Description

Global conveyance system inflow methods.

Function Documentation

inflow_deleteDwfInflows()

void inflow_deleteDwfInflows

(

int

nodeIndex

)

Deletes all dry weather inflow data for a node.

Parameters

[in]

nodeIndex

Node index

inflow_deleteExtInflows()

void inflow_deleteExtInflows

(

int

nodeIndex

)

Deletes all time series inflow data for a node.

Parameters

[in]

nodeIndex

Node index

inflow_getDwfInflow()

double inflow_getDwfInflow	(	TDwfInflow *	inflow,
		int	m,
		int	d,
		int	h
	)

Computes dry weather inflow value at a specific point in time.

Parameters

[in]	inflow	Dry weather inflow data structure
[in]	m	Current month of year for the simulation
[in]	d	Current day of month for the simulation
[in]	h	Current hour of day for the simulation

Returns

Returns dry weather inflow value

Here is the call graph for this function:

inflow_getExtInflow()

double inflow_getExtInflow	(	TExtInflow *	inflow,
		DateTime	aDate
	)

Retrieves the value of an external inflow at a specific date and time.

Parameters

[in]	inflow	External inflow data structure
[in]	aDate	Current simulation date/time

Returns

Returns current value of external inflow parameter

Here is the call graph for this function:

inflow_initDwfInflow()

void inflow_initDwfInflow

(

TDwfInflow *

inflow

)

Initialzes a dry weather inflow by ordering its time patterns.

Parameters

[in]

inflow

Dry weather inflow object

This function sorts the user-supplied time patterns for a dry weather inflow in the order of the PatternType enumeration (monthly, daily, weekday hourly, weekend hourly) to help speed up pattern processing.

Here is the caller graph for this function:

inflow_initDwfPattern()

void inflow_initDwfPattern

(

int

patternIndex

)

Initialzes a dry weather inflow time pattern.

Parameters

[in]

patternIndex

Time pattern index

inflow_readDwfInflow()

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

Reads dry weather inflow parameters from line of input data.

Parameters

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

Returns

Error code

Format of data line is: nodeID FLOW/pollutID avgValue (pattern1 pattern2 ... pattern4)

Here is the call graph for this function:

inflow_readDwfPattern()

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

Reads values of a time pattern from a line of input data.

Parameters

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

Returns

Error code

Format of data line is: patternID patternType value(1) value(2) ... patternID value(n) value(n+1) .... (for continuation lines)

Here is the call graph for this function:

inflow_readExtInflow()

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

Reads parameters of a direct external inflow from a line of input.

Parameters

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

Returns

Error code

Data formats of data line are: nodeID FLOW tSeriesID (FLOW 1.0 scaleFactor baseline basePat) nodeID pollutID tSeriesID (CONCEN/MASS unitsFactor scaleFactor baseline basePat)

Here is the call graph for this function:

inflow_setExtInflow()

int inflow_setExtInflow	(	int	nodeIndex,
		int	param,
		int	type,
		int	tseries,
		int	basePat,
		double	cf,
		double	baseline,
		double	sf
	)

This function assigns property values to the inflow object.

Parameters

[in]	nodeIndex	Node index
[in]	param	Parameter code
[in]	type	Inflow type code
[in]	tSeries	Time series index
[in]	basePat	Base pattern index
[in]	cf	Conversion factor
[in]	baseline	Baseline value
[in]	sf	Scale factor

Returns

Error code

Here is the call graph for this function:

Here is the caller graph for this function: