Global Simulation Statistics Methods

Global simulation statistics methods. More...

Collaboration diagram for Global Simulation Statistics Methods:

Functions
int	stats_open (void)
	Opens the simulation statistics system.
void	stats_close (void)
	Closes the simulation statistics system.
void	stats_report (void)
	Reports simulation statistics.
void	stats_updateCriticalTimeCount (int nodeIndex, int linkIndex)
	Updates count of times a node or link was time step-critical.
void	stats_updateFlowStats (double tStep, DateTime aDate)
	Updates various flow routing statistics at current time period.
void	stats_updateTimeStepStats (double tStep, int trialsCount, int steadyState)
	Updates flow routing time step statistics.
void	stats_updateSubcatchStats (int subcatchIndex, double rainVol, double runonVol, double evapVol, double infilVol, double impervVol, double pervVol, double runoffVol, double runoff)
	Updates totals of runoff components for a specific subcatchment.
void	stats_updateGwaterStats (int subcatchIndex, double infil, double evap, double latFlow, double deepFlow, double theta, double waterTable, double tStep)
	Updates groundwater statistics for a specific subcatchment.
void	stats_updateMaxRunoff (void)
	Updates value of maximum system runoff rate.
void	stats_updateMaxNodeDepth (int nodeIndex, double depth)
	Updates a node's maximum depth recorded at reporting times.
void	stats_updateConvergenceStats (int nodeIndex, int converged)
	Updates convergence statistics node.

Detailed Description

Global simulation statistics methods.

Function Documentation

stats_close()

void stats_close

(

void

)

Closes the simulation statistics system.

stats_open()

int stats_open

(

void

)

Opens the simulation statistics system.

Returns

Error code

Here is the call graph for this function:

stats_report()

void stats_report

(

void

)

Reports simulation statistics.

Here is the call graph for this function:

stats_updateConvergenceStats()

void stats_updateConvergenceStats	(	int	node,
		int	converged
	)

Updates convergence statistics node.

Parameters

[in]	nodeIndex	Node index
[in]	converged	TRUE if node has converged

stats_updateCriticalTimeCount()

void stats_updateCriticalTimeCount	(	int	nodeIndex,
		int	linkIndex
	)

Updates count of times a node or link was time step-critical.

Parameters

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

stats_updateFlowStats()

void stats_updateFlowStats	(	double	tStep,
		DateTime	aDate
	)

Updates various flow routing statistics at current time period.

Parameters

[in]	tStep	Routing time step (sec)
[in]	aDate	Current date/time

Here is the caller graph for this function:

stats_updateGwaterStats()

void stats_updateGwaterStats	(	int	subcatchIndex,
		double	infil,
		double	evap,
		double	latFlow,
		double	deepFlow,
		double	theta,
		double	waterTable,
		double	tStep
	)

Updates groundwater statistics for a specific subcatchment.

Parameters

[in]	subcatchIndex	Subcatchment index
[in]	infil	Infiltration volume (ft3)
[in]	evap	Evaporation volume (ft3)
[in]	latFlow	Lateral flow volume (ft3)
[in]	deepFlow	Deep flow volume (ft3)
[in]	theta	Soil moisture content
[in]	waterTable	Depth to water table (ft)
[in]	tStep	Time step (sec)

Here is the caller graph for this function:

stats_updateMaxNodeDepth()

void stats_updateMaxNodeDepth	(	int	j,
		double	depth
	)

Updates a node's maximum depth recorded at reporting times.

Parameters

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

stats_updateMaxRunoff()

void stats_updateMaxRunoff

(

void

)

Updates value of maximum system runoff rate.

Note

Updates global variable MaxRunoffFlow

Here is the caller graph for this function:

stats_updateSubcatchStats()

void stats_updateSubcatchStats	(	int	subcatchIndex,
		double	rainVol,
		double	runonVol,
		double	evapVol,
		double	infilVol,
		double	impervVol,
		double	pervVol,
		double	runoffVol,
		double	runoff
	)

Updates totals of runoff components for a specific subcatchment.

Parameters

[in]	subcatchIndex	Subcatchment index
[in]	rainVol	Rainfall + snowfall volume (ft3)
[in]	runonVol	Runon volume from other subcatchments (ft3)
[in]	evapVol	Evaporation volume (ft3)
[in]	infilVol	Infiltration volume (ft3)
[in]	impervVol	Impervious runoff volume (ft3)
[in]	pervVol	Pervious runoff volume (ft3)
[in]	runoffVol	Total runoff volume (ft3)
[in]	runoff	Runoff rate (cfs)

Here is the caller graph for this function:

stats_updateTimeStepStats()

void stats_updateTimeStepStats	(	double	tStep,
		int	trialsCount,
		int	steadyState
	)

Updates flow routing time step statistics.

Parameters

[in]	tStep	Current flow routing time step (sec)
[in]	trialsCount	Number of trials used to solve routing
[in]	steadyState	TRUE if steady flow conditions exist

Here is the caller graph for this function: