OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches

Exfil file functions. More...

Collaboration diagram for Exfil File Functions:

Functions

int exfil_readStorageParams (int k, char *tok[], int ntoks, int n)
 Reads exfiltration parameters from a line of input data.
 
void exfil_initState (int k)
 Initializes exfiltration parameters.
 
double exfil_getLoss (TExfil *exfil, double tStep, double depth, double area)
 Gets exfiltration loss rate.
 

Detailed Description

Exfil file functions.

Function Documentation

◆ exfil_getLoss()

double exfil_getLoss ( TExfil * exfil,
double tStep,
double depth,
double area )

Gets exfiltration loss rate.

Parameters
exfilPointer to exfiltration object
tStepTime step
depthDepth of water above exfiltration layer
areaArea of exfiltration layer
Returns
Exfiltration loss rate

Gets exfiltration loss rate.

Implementation arguments
  • exfil (borrowed/value): Ptr. to a storage exfiltration object.
  • tStep (in): Time step (sec).
  • depth (in): Water depth (ft).
  • area (in): Surface area (ft2).
Returns
Exfiltration rate out of storage unit (cfs).
Here is the call graph for this function:

◆ exfil_initState()

void exfil_initState ( int k)

Initializes exfiltration parameters.

Parameters
kIndex of exfiltration object in project's object list

Initializes exfiltration parameters.

Implementation arguments
  • k (in): Storage unit index.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ exfil_readStorageParams()

int exfil_readStorageParams ( int k,
char * tok[],
int ntoks,
int n )

Reads exfiltration parameters from a line of input data.

Parameters
kIndex of line's keyword in project's keyword list
tokArray of string tokens
ntoksNumber of tokens
nNumber of exfiltration parameters
Returns
Error code

Reads exfiltration parameters from a line of input data.

Implementation arguments
  • k (in): Storage unit index.
  • tok (borrowed/value): Array of string tokens.
  • ntoks (in): Number of tokens.
  • n (in): Last token processed.
Returns
An error code.
Here is the call graph for this function: