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

Global snowmelt processing methods. More...

Collaboration diagram for Global Snowmelt Processing Methods:

Functions

int snow_readMeltParams (char *tok[], int ntoks)
 Reads snowmelt parameters from a tokenized line of input data.
 
int snow_createSnowpack (int subcatchIndex, int snowIndex)
 Creates a snowpack object for a subcatchment.
 
void snow_validateSnowmelt (int snowIndex)
 Checks for valid values in a snowmelt parameter set.
 
void snow_initSnowpack (int subcatchIndex)
 Initializes state of a subcatchment's snowpack.
 
void snow_initSnowmelt (int snowIndex)
 Initializes values in a snowmelt parameter set.
 
void snow_getState (int subcatchIndex, int subAreaIndex, double x[])
 Retrieves the current state of a snowpack object.
 
void snow_setState (int subcatchIndex, int subAreaIndex, double x[])
 Sets the current state of a snowpack object.
 
void snow_setMeltCoeffs (int snowIndex, double season)
 Sets values of snowmelt coefficients for a particular time of year.
 
void snow_plowSnow (int subcatchIndex, double tStep)
 Adds new snow to subcatchment and plows it between sub-areas.
 
double snow_getSnowMelt (int subcatchIndex, double rainfall, double snowfall, double tStep, double netPrecip[])
 Modifies rainfall input to subcatchment's subareas based on possible snow melt and updates snow depth over entire subcatchment.
 
double snow_getSnowCover (int subcatchIndex)
 Computes volume of snow on a subcatchment.
 

Detailed Description

Global snowmelt processing methods.

Function Documentation

◆ snow_createSnowpack()

int snow_createSnowpack ( int  subcatchIndex,
int  snowIndex 
)

Creates a snowpack object for a subcatchment.

Parameters
[in]subcatchIndexSubcatchment index
[in]snowIndexSnowmelt parameter set index
Returns
TRUE if successful, FALSE if not
Here is the caller graph for this function:

◆ snow_getSnowCover()

double snow_getSnowCover ( int  subcatchIndex)

Computes volume of snow on a subcatchment.

Parameters
[in]subcatchIndexSubcatchment index
Returns
Volume of snow cover (ft3)
Here is the caller graph for this function:

◆ snow_getSnowMelt()

double snow_getSnowMelt ( int  subcatchIndex,
double  rainfall,
double  snowfall,
double  tStep,
double  netPrecip[] 
)

Modifies rainfall input to subcatchment's subareas based on possible snow melt and updates snow depth over entire subcatchment.

Parameters
[in]subcatchIndexSubcatchment index
[in]rainfallRainfall (ft/sec)
[in]snowfallSnowfall (ft/sec)
[in]tStepTime step (sec)
[out]netPrecipRainfall + snowmelt on each runoff sub-area (ft/sec)
Returns
New snow depth over subcatchment

◆ snow_getState()

void snow_getState ( int  i,
int  j,
double  x[] 
)

Retrieves the current state of a snowpack object.

Parameters
[in]subcatchIndexSubcatchment index
[in]subAreaIndexSnowpack sub-area index
[out]xArray of snowpack state variables
[in]subcatchSubcatchment index
[in]subAreaSnowpack sub-area index
[out]xArray of snowpack state variables

◆ snow_initSnowmelt()

void snow_initSnowmelt ( int  snowIndex)

Initializes values in a snowmelt parameter set.

Parameters
[in]snowIndexSnowmelt parameter set index

◆ snow_initSnowpack()

void snow_initSnowpack ( int  subcatchIndex)

Initializes state of a subcatchment's snowpack.

Parameters
[in]subcatchIndexSubcatchment index
Here is the caller graph for this function:

◆ snow_plowSnow()

void snow_plowSnow ( int  subcatchIndex,
double  tStep 
)

Adds new snow to subcatchment and plows it between sub-areas.

Parameters
[in]subcatchIndexSubcatchment index
[in]tStepTime step (sec)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ snow_readMeltParams()

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

Reads snowmelt parameters from a tokenized line of input data.

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

Format of data are:

  • Name SubArea Cmin Cmax Tbase FWF SD0 FW0 SNN0/SD100
  • Name REMOVAL SDplow Fout Fimperv Fperv Fimelt Fsubcatch (Subcatch)
Here is the call graph for this function:

◆ snow_setMeltCoeffs()

void snow_setMeltCoeffs ( int  snowIndex,
double  season 
)

Sets values of snowmelt coefficients for a particular time of year.

Parameters
[in]snowIndexSnowmelt parameter set index
[in]seasonSeason of the year

◆ snow_setState()

void snow_setState ( int  subcatchIndex,
int  subAreaIndex,
double  x[] 
)

Sets the current state of a snowpack object.

Parameters
[in]subcatchIndexSubcatchment index
[in]subAreaIndexSnowpack sub-area index
[in]xArray of snowpack state variables

◆ snow_validateSnowmelt()

void snow_validateSnowmelt ( int  snowIndex)

Checks for valid values in a snowmelt parameter set.

Parameters
[in]snowIndexSnowmelt parameter set index
Here is the call graph for this function:
Here is the caller graph for this function: