OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
Global Temperature/Evaporation Methods

Global temperature/evaporation methods. More...

Collaboration diagram for Global Temperature/Evaporation Methods:

Functions

int climate_readParams (char *tok[], int ntoks)
 Reads climate/temperature parameters from input line of data.
 
int climate_readEvapParams (char *tok[], int ntoks)
 Reads evaporation parameters from input line of data.
 
int climate_readAdjustments (char *tok[], int ntoks)
 Reads adjustments to monthly evaporation or rainfall from input line of data.
 
void climate_validate (void)
 Validates climatological variables.
 
void climate_openFile (void)
 Opens a climate file and reads in first set of values.
 
void climate_initState (void)
 Initializes climate state variables.
 
void climate_setState (DateTime theDate)
 Sets climate variables for current date.
 
DateTime climate_getNextEvapDate (void)
 Gets the next date when evaporation rate changes.
 

Detailed Description

Global temperature/evaporation methods.

Function Documentation

◆ climate_getNextEvapDate()

DateTime climate_getNextEvapDate ( void )

Gets the next date when evaporation rate changes.

Returns
The current value of NextEvapDate
See also
Declaration contract for climate_getNextEvapDate().

◆ climate_initState()

void climate_initState ( void )

Initializes climate state variables.

See also
Declaration contract for climate_initState().
Here is the call graph for this function:
Here is the caller graph for this function:

◆ climate_openFile()

void climate_openFile ( void )

Opens a climate file and reads in first set of values.

See also
Declaration contract for climate_openFile().
Here is the call graph for this function:
Here is the caller graph for this function:

◆ climate_readAdjustments()

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

Reads adjustments to monthly evaporation or rainfall from input line of data.

Parameters
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code
  • Data formats are:
    • TEMPERATURE v1 ... v12
    • EVAPORATION v1 ... v12
    • RAINFALL v1 ... v12
    • CONDUCTIVITY v1 ... v12
    • N-PERV subcatchID patternID
    • DSTORE subcatchID patternID
    • INFIL subcatchID patternID
See also
Declaration contract for climate_readAdjustments().
Here is the call graph for this function:

◆ climate_readEvapParams()

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

Reads evaporation parameters from input line of data.

Parameters
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code
  • Data formats are:
    • CONSTANT value
    • MONTHLY v1 ... v12
    • TIMESERIES name
    • TEMPERATURE
    • FILE (v1 ... v12)
    • RECOVERY name
    • DRY_ONLY YES/NO
See also
Declaration contract for climate_readEvapParams().
Here is the call graph for this function:

◆ climate_readParams()

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

Reads climate/temperature parameters from input line of data.

Parameters
[in]tokArray of string tokens
[in]ntoksNumber of tokens
Returns
Error code
  • Format of data can be:
    • TIMESERIES name
    • FILE name (start) (units)
    • WINDSPEED MONTHLY v1 v2 ... v12
    • WINDSPEED FILE
    • SNOWMELT v1 v2 ... v6
    • ADC IMPERV/PERV v1 v2 ... v10
See also
Declaration contract for climate_readParams().
Here is the call graph for this function:

◆ climate_setState()

void climate_setState ( DateTime theDate)

Sets climate variables for current date.

Parameters
[in]theDateSimulation date
See also
Declaration contract for climate_setState().
Here is the call graph for this function:
Here is the caller graph for this function:

◆ climate_validate()

void climate_validate ( void )

Validates climatological variables.

See also
Declaration contract for climate_validate().
Here is the call graph for this function:
Here is the caller graph for this function: