Global Conveyance System Node Methods

Global conveyance system node methods. More...

Collaboration diagram for Global Conveyance System Node Methods:

Functions
int	node_readParams (int nodeIndex, int type, int subIndex, char *tok[], int ntoks)
	Reads node properties from a tokenized line of input.
void	node_validate (int nodeIndex)
	Validates a node's properties.
void	node_initState (int nodeIndex)
	Initializes a node's state variables at start of simulation.
void	node_initFlows (int nodeIndex, double tStep)
	Initializes a node's inflow/outflow/overflow at start of time step.
void	node_setOldHydState (int nodeIndex)
	Replaces a node's old hydraulic state values with new ones.
void	node_setOldQualState (int nodeIndex)
	Replaces a node's old water quality state values with new ones.
void	node_setOutletDepth (int nodeIndex, double yNorm, double yCrit, double z)
	Sets water depth at a node that serves as an outlet point.
double	node_getSurfArea (int nodeIndex, double depth)
	Computes surface area of water stored at a node from water depth.
double	node_getDepth (int nodeIndex, double volume)
	Computes a node's water depth from its volume.
double	node_getVolume (int nodeIndex, double depth)
	Computes volume stored at a node from its water depth.
double	node_getPondedArea (int nodeIndex, double depth)
	Computes surface area of water at a node based on depth.
double	node_getOutflow (int nodeIndex, int linkIndex)
	Computes outflow from node available for inflow into a link.
double	node_getLosses (int nodeIndex, double tStep)
	Computes the rates of evaporation and infiltration over a given time step for a node.
double	node_getMaxOutflow (int nodeIndex, double q, double tStep)
	Limits outflow rate from a node with storage volume.
double	node_getSystemOutflow (int nodeIndex, int *isFlooded)
	Computes flow rate at outfalls and flooded nodes.
void	node_getResults (int nodeIndex, double wt, float x[])
	Computes weighted average of old and new results at a node.

Detailed Description

Global conveyance system node methods.

Function Documentation

node_getDepth()

double node_getDepth	(	int	nodeIndex,
		double	v
	)

Computes a node's water depth from its volume.

Parameters

[in]	nodeIndex	Node index
[in]	volume	Volume of water stored at node (ft3)

Returns

Returns water depth at node (ft)

node_getLosses()

double node_getLosses	(	int	nodeIndex,
		double	tStep
	)

Computes the rates of evaporation and infiltration over a given time step for a node.

Parameters

[in]	nodeIndex	Node index
[in]	tStep	Time step (sec)

Returns

Returns water loss rate at node (ft3)

node_getMaxOutflow()

double node_getMaxOutflow	(	int	nodeIndex,
		double	q,
		double	tStep
	)

Limits outflow rate from a node with storage volume.

Parameters

[in]	nodeIndex	Node index
[in]	q	Flow rate leaving node (cfs)
[in]	tStep	Time step (sec)

Returns

Returns modified flow rate (cfs)

node_getOutflow()

double node_getOutflow	(	int	nodeIndex,
		int	linkIndex
	)

Computes outflow from node available for inflow into a link.

Parameters

[in]	nodeIndex	Node index
[in]	linkIndex	Link index

Returns

Returns flow rate leaving node (cfs)

Here is the caller graph for this function:

node_getPondedArea()

double node_getPondedArea	(	int	nodeIndex,
		double	depth
	)

Computes surface area of water at a node based on depth.

Parameters

[in]	nodeIndex	Node index
[in]	depth	Water depth at node (ft)

Returns

Returns surface area of water at node (ft2)

Here is the call graph for this function:

node_getResults()

void node_getResults	(	int	nodeIndex,
		double	wt,
		float	x[]
	)

Computes weighted average of old and new results at a node.

Parameters

[in]	nodeIndex	Node index
[in]	wt	Weighting factor
[out]	x	Array of node results

Here is the call graph for this function:

Here is the caller graph for this function:

node_getSurfArea()

double node_getSurfArea	(	int	j,
		double	d
	)

Computes surface area of water stored at a node from water depth.

Parameters

[in]	nodeIndex	Node index
[in]	depth	Water depth (ft)

Returns

Returns surface area of water stored at node (ft2)

Here is the caller graph for this function:

node_getSystemOutflow()

double node_getSystemOutflow	(	int	nodeIndex,
		int *	isFlooded
	)

Computes flow rate at outfalls and flooded nodes.

Parameters

[in]	nodeIndex	Node index
[out]	isFlooded	TRUE if node is flooded

Returns

Returns flow rate lost from system (cfs)

node_getVolume()

double node_getVolume	(	int	nodeIndex,
		double	depth
	)

Computes volume stored at a node from its water depth.

Parameters

[in]	nodeIndex	Node index
[in]	depth	Water depth at node (ft)

Returns

Returns volume of water stored at node (ft3)

Here is the caller graph for this function:

node_initFlows()

void node_initFlows	(	int	nodeIndex,
		double	tStep
	)

Initializes a node's inflow/outflow/overflow at start of time step.

Parameters

[in]	nodeIndex	Node index
[in]	tStep	Time step (sec)

node_initState()

void node_initState

(

int

nodeIndex

)

Initializes a node's state variables at start of simulation.

Parameters

[in]

nodeIndex

Node index

Here is the call graph for this function:

Here is the caller graph for this function:

node_readParams()

int node_readParams	(	int	nodeIndex,
		int	type,
		int	k,
		char *	tok[],
		int	ntoks
	)

Reads node properties from a tokenized line of input.

Parameters

[in]	nodeIndex	Node index
[in]	type	Node type code
[in]	subIndex	Node sub-type code
[in]	tok	Array of string tokens
[in]	ntoks	Number of tokens

Returns

Error code

node_setOldHydState()

void node_setOldHydState

(

int

nodeIndex

)

Replaces a node's old hydraulic state values with new ones.

Parameters

[in]

nodeIndex

Node index

node_setOldQualState()

void node_setOldQualState

(

int

nodeIndex

)

Replaces a node's old water quality state values with new ones.

Parameters

[in]

nodeIndex

Node index

node_setOutletDepth()

void node_setOutletDepth	(	int	j,
		double	yNorm,
		double	yCrit,
		double	z
	)

Sets water depth at a node that serves as an outlet point.

Parameters

[in]	nodeIndex	Node index
[in]	yNorm	Normal flow depth (ft)
[in]	yCrit	Critical flow depth (ft)
[in]	z	Offset of connecting outfall link from node invert (ft)

Here is the caller graph for this function:

node_validate()

void node_validate

(

int

nodeIndex

)

Validates a node's properties.

Parameters

[in]

nodeIndex

Node index

Here is the call graph for this function:

Here is the caller graph for this function: