OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
Global Land Use Methods

Global RDII methods. More...

Collaboration diagram for Global Land Use Methods:

Functions

int landuse_readParams (int landuseIndex, char *tok[], int ntoks)
 Reads landuse parameters from a tokenized line of input.
 
int landuse_readPollutParams (int pollutIndex, char *tok[], int ntoks)
 Reads pollutant parameters from a tokenized line of input.
 
int landuse_readBuildupParams (char *tok[], int ntoks)
 Reads pollutant buildup parameters from a tokenized line of input.
 
int landuse_readWashoffParams (char *tok[], int ntoks)
 Reads pollutant washoff parameters from a tokenized line of input.
 
void landuse_getInitBuildup (TLandFactor *landFactor, double *initBuildup, double area, double curb)
 Determines the initial buildup of each pollutant on each land use for a given subcatchment.
 
double landuse_getBuildup (int landuseIndex, int pollutIndex, double area, double curb, double buildup, double tStep)
 Computes new pollutant buildup on a landuse after a time increment.
 
double landuse_getWashoffLoad (int landuse, int p, double area, TLandFactor landFactor[], double runoff, double vOutflow)
 Computes pollutant load generated by a land use over a time step.
 
double landuse_getAvgBmpEffic (int subcatchIndex, int pollutIndex)
 Finds the overall average BMP removal achieved for pollutant pollutIndex treated in subcatchment j.
 
double landuse_getCoPollutLoad (int p, double washoff[])
 Finds washoff mass added by a co-pollutant of a given pollutant.
 

Detailed Description

Global RDII methods.

Function Documentation

◆ landuse_getAvgBmpEffic()

double landuse_getAvgBmpEffic ( int  subcatchIndex,
int  pollutIndex 
)

Finds the overall average BMP removal achieved for pollutant pollutIndex treated in subcatchment j.

Parameters
[in]subcatchIndexSubcatchment index
[in]pollutIndexPollutant index
Returns
Returns a BMP removal fraction for a pollutant pollutIndex

◆ landuse_getBuildup()

double landuse_getBuildup ( int  landuseIndex,
int  pollutIndex,
double  area,
double  curb,
double  buildup,
double  tStep 
)

Computes new pollutant buildup on a landuse after a time increment.

Parameters
[in]landuseIndexLand use index
[in]pollutIndexPollutant index
[in]areaArea of subcatchment (ac or ha)
[in]curbLand use curb length (users units)
[in]buildupCurrent pollutant buildup (lbs or kg)
[in]tStepTime increment for buildup (sec)
Returns
Returns new pollutant buildup (lbs or kg)
Here is the caller graph for this function:

◆ landuse_getCoPollutLoad()

double landuse_getCoPollutLoad ( int  p,
double  washoff[] 
)

Finds washoff mass added by a co-pollutant of a given pollutant.

Parameters
[in]pPollutant index
[in]washoffArray of washoff mass for each pollutant
Returns
Returns washoff mass added by co-pollutant relation (mass)
Here is the call graph for this function:

◆ landuse_getInitBuildup()

void landuse_getInitBuildup ( TLandFactor landFactor,
double *  initBuildup,
double  area,
double  curb 
)

Determines the initial buildup of each pollutant on each land use for a given subcatchment.

Parameters
[in]landFactorLand use factor
[out]initBuildupInitial buildup of each pollutant
[in]areaArea of subcatchment (ft2)
[in]curbSubcatchment's curb length (users units)

Contributions from co-pollutants to initial buildup are not included since the co-pollutant mechanism only applies to washoff.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ landuse_getWashoffLoad()

double landuse_getWashoffLoad ( int  landuse,
int  p,
double  area,
TLandFactor  landFactor[],
double  runoff,
double  vOutflow 
)

Computes pollutant load generated by a land use over a time step.

Parameters
[in]landuseIndexLand use index
[in]pollutIndexPollutant index
[in]areaArea of subcatchment (ft2)
[in]landFactorArray of land use data for subcatchment
[in]runoffRunoff flow generated by subcatchment (ft/sec)
[in]vOutflowRunoff volume leaving subcatchment (ft3)
Returns
Returns pollutant load generated by a land use over a time step.
Here is the call graph for this function:

◆ landuse_readBuildupParams()

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

Reads pollutant buildup parameters from a tokenized line of input.

Parameters
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code

Data format is: landuseID pollutID buildupType c1 c2 c3 normalizerType

Here is the call graph for this function:

◆ landuse_readParams()

int landuse_readParams ( int  landuseIndex,
char *  tok[],
int  ntoks 
)

Reads landuse parameters from a tokenized line of input.

Parameters
[in]landuseIndexLand use index
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code

Data format is: landuseID (sweepInterval sweepRemoval sweepDays0)

Here is the call graph for this function:

◆ landuse_readPollutParams()

int landuse_readPollutParams ( int  pollutIndex,
char *  tok[],
int  ntoks 
)

Reads pollutant parameters from a tokenized line of input.

Parameters
[in]pollutIndexPollutant index
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code

Data format is: ID Units cRain cGW cRDII kDecay (snowOnly coPollut coFrac cDWF cInit)

Here is the call graph for this function:

◆ landuse_readWashoffParams()

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

Reads pollutant washoff parameters from a tokenized line of input.

Parameters
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code

Data format is: landuseID pollutID washoffType c1 c2 sweepEffic bmpRemoval

Here is the call graph for this function: