Global Treatment Methods

Global treatment methods. More...

Collaboration diagram for Global Treatment Methods:

Functions
int	treatmnt_open (void)
	Allocates memory for computing pollutant removals by treatment.
void	treatmnt_close (void)
	Frees memory used for computing pollutant removals by treatment.
int	treatmnt_readExpression (char *tok[], int ntoks)
	Reads a treatment expression from a tokenized line of input.
void	treatmnt_delete (int nodeIndex)
	Deletes the treatment objects for each pollutant at a node.
void	treatmnt_treat (int j, double q, double v, double tStep)
	Updates pollutant concentrations at a node after treatment.
void	treatmnt_setInflow (double qIn, double wIn[])
	Computes and saves array of inflow concentrations to a node.

Detailed Description

Global treatment methods.

Function Documentation

treatmnt_close()

void treatmnt_close

(

void

)

Frees memory used for computing pollutant removals by treatment.

Here is the caller graph for this function:

treatmnt_delete()

void treatmnt_delete

(

int

nodeIndex

)

Deletes the treatment objects for each pollutant at a node.

Parameters

[in]

nodeIndex

Node index

Deletes the treatment objects for each pollutant at a node.

Implementation arguments

• nodeIndex (in): Valid node index whose treatment storage is exclusively owned.

Postcondition

Deletes expression lists, frees the optional array and resets the node treatment pointer to NULL; repeated calls on a cleaned node do nothing.

Here is the call graph for this function:

treatmnt_open()

int treatmnt_open

(

void

)

Allocates memory for computing pollutant removals by treatment.

Returns

Returns True if successful, False if not

Here is the call graph for this function:

Here is the caller graph for this function:

treatmnt_readExpression()

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

Reads a treatment expression from a tokenized line of input.

Parameters

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

Returns

Error code

Implementation arguments

• tok (in): Array of string tokens

• ntoks (in): Number of tokens

  Returns

  Error code

Here is the call graph for this function:

treatmnt_setInflow()

void treatmnt_setInflow	(	double	qIn,
		double	wIn[] )

Computes and saves array of inflow concentrations to a node.

Parameters

[in]	qIn	Flow inflow rate (cfs)
[in]	wIn	Pollutant mass inflow rates (mass/sec)

Implementation arguments

• qIn (in): Flow inflow rate (cfs)

• wIn (in): Pollutant mass inflow rates (mass/sec)

Here is the caller graph for this function:

treatmnt_treat()

void treatmnt_treat	(	int	j,
		double	q,
		double	v,
		double	tStep )

Updates pollutant concentrations at a node after treatment.

Parameters

[in]	j	Node index
[in]	q	Inflow to node (cfs)
[in]	v	Volume of node (ft3)
[in]	tStep	Routing time step (sec)

Implementation arguments

• j (in): Node index

• q (in): Inflow to node (cfs)
• v (in): Volume of node (ft3)
• tStep (in): Routing time step (sec)

Here is the call graph for this function:

Here is the caller graph for this function: