Global Groundwater Methods

Global groundwater methods. More...

Collaboration diagram for Global Groundwater Methods:

Functions
int	gwater_readAquiferParams (int aquiferIndex, char *tok[], int ntoks)
	Reads aquifer parameter values from line of input data.
int	gwater_readGroundwaterParams (char *tok[], int ntoks)
	Reads groundwater inflow parameters for a subcatchment from a line of input data.
int	gwater_readFlowExpression (char *tok[], int ntoks)
	Reads mathematical expression for lateral or deep groundwater flow for a subcatchment from a line of input data.
void	gwater_deleteFlowExpression (int subcatchIndex)
	Veletes a subcatchment's custom groundwater flow expressions.
void	gwater_validateAquifer (int aquiferIndex)
	Validates groundwater aquifer properties.
void	gwater_validate (int subcatchIndex)
	Validates groundwater parameters for a subcatchment.
void	gwater_initState (int subcatchIndex)
	Initializes state of subcatchment's groundwater.
void	gwater_getState (int subcatchIndex, double x[])
	Retrieves state of subcatchment's groundwater.
void	gwater_setState (int subcatchIndex, double x[])
	Assigns values to a subcatchment's groundwater state.
void	gwater_getGroundwater (int subcatchIndex, double evap, double infil, double tStep)
	Computes groundwater flow for a subcatchment.
double	gwater_getVolume (int subcatchIndex)
	Finds volume of groundwater stored in upper & lower zones.

Detailed Description

Global groundwater methods.

Function Documentation

gwater_deleteFlowExpression()

void gwater_deleteFlowExpression

(

int

subcatchIndex

)

Veletes a subcatchment's custom groundwater flow expressions.

Parameters

[in]

subcatchIndex

Subcatchment index

Here is the call graph for this function:

gwater_getGroundwater()

void gwater_getGroundwater	(	int	subcatchIndex,
		double	evap,
		double	infil,
		double	tStep
	)

Computes groundwater flow for a subcatchment.

Parameters

[in]	subcatchIndex	Subcatchment index
[in]	evap	Pervious surface evaporation volume consumed (ft3)
[in]	infil	Surface infiltration volume (ft3)
[in]	tStep	Time step (sec)

Here is the call graph for this function:

Here is the caller graph for this function:

gwater_getState()

void gwater_getState	(	int	subcatchIndex,
		double	x[]
	)

Retrieves state of subcatchment's groundwater.

Parameters

[in]	subcatchIndex	Subcatchment index
[out]	x	Array of groundwater state variables

gwater_getVolume()

double gwater_getVolume

(

int

subcatchIndex

)

Finds volume of groundwater stored in upper & lower zones.

Parameters

[in]

subcatchIndex

Subcatchment index

Returns

Total volume of groundwater in ft/ft2

Here is the caller graph for this function:

gwater_initState()

void gwater_initState

(

int

subcatchIndex

)

Initializes state of subcatchment's groundwater.

Parameters

[in]

subcatchIndex

Subcatchment index

Here is the call graph for this function:

Here is the caller graph for this function:

gwater_readAquiferParams()

int gwater_readAquiferParams	(	int	aquiferIndex,
		char *	tok[],
		int	ntoks
	)

Reads aquifer parameter values from line of input data.

Parameters

[in]	aquiferIndex	Index of aquifer
[in]	tok	Array of string tokens
[in]	ntoks	Number of tokens

Returns

Error code

Data line contains following parameters: ID, porosity, wiltingPoint, fieldCapacity, conductivity, conductSlope, tensionSlope, upperEvapFraction, lowerEvapDepth, gwRecession, bottomElev, waterTableElev, upperMoisture (evapPattern)

Here is the call graph for this function:

gwater_readFlowExpression()

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

Reads mathematical expression for lateral or deep groundwater flow for a subcatchment from a line of input data.

Parameters

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

Returns

Error code

Format is: subcatch LATERAL/DEEP <expr> where subcatch is the ID of the subcatchment, LATERAL is for lateral GW flow, DEEP is for deep GW flow and <expr> is any well-formed math expression.

Here is the call graph for this function:

gwater_readGroundwaterParams()

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

Reads groundwater inflow parameters for a subcatchment from a line of input data.

Parameters

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

Returns

Error code

Data format is: subcatch aquifer node surfElev a1 b1 a2 b2 a3 fixedDepth + (nodeElev bottomElev waterTableElev upperMoisture )

Here is the call graph for this function:

gwater_setState()

void gwater_setState	(	int	subcatchIndex,
		double	x[]
	)

Assigns values to a subcatchment's groundwater state.

Parameters

[in]	subcatchIndex	Subcatchment index
[in]	x	Array of groundwater state variables

gwater_validate()

void gwater_validate

(

int

subcatchIndex

)

Validates groundwater parameters for a subcatchment.

Parameters

[in]

subcatchIndex

Subcatchment index

Here is the call graph for this function:

Here is the caller graph for this function:

gwater_validateAquifer()

void gwater_validateAquifer

(

int

aquiferIndex

)

Validates groundwater aquifer properties.

Parameters

[in]

aquiferIndex

Index of aquifer

Here is the call graph for this function:

Here is the caller graph for this function: