HLclearCreek

new HLclearCreek(configfile)

Data module implementation for the Clear Creek HLM case study model Overrides some of the methods implemented in the BMI HydroLang implementation. Extends the HydroLang functional space by inheritance. The instance calls either a data request from EPA precipitation model API's or calls data from an preestablished model for the HLM-C implementation. Provides data from EPA using grided models on an hourly scale. Connects with the USGS gauging station for comparision purposes.

Parameters:
NameTypeDescription
configfileString
Source

Extends

Methods

(static) additionalData()

Run if EPA data is to be queried.

Source

(static) dataStep(i, j) → {Number}

Steps through an event given step size.

Parameters:
NameTypeDescription
iNumber

initial value

jNumber

i + 1 value

Source
Returns:

difference between the two

Type: 
Number

(static) get_time_step() → {Number}

Returns the current state of the model. For HLclearCreek is the default time step.

Source
Returns:

default time step

Type: 
Number

(static) get_value_at_indices(var_name, dest, indices) → {Array.<Object>}

Obtains the rainfall values at a specific index in the results array, when an index array is passed.

Parameters:
NameTypeDescription
var_nameString

name of the variable used for the calculations

destArray.<Object>

array destiny required for the results

indicesArray.<Object>

array with the values of the links

Source
Returns:

rainfall values perr order of link given.

Type: 
Array.<Object>

(static) retrieveData(arrayCont)

Method for downloading data from the provided calls for the EPA API. Calls the

Parameters:
NameTypeDescription
arrayContArray.<Object>

array with all the lat-lon coordinates for each link.

Source

(static) retrieveGauge()

Downloads data from the USGS site

Source

(static) spreadGauge()

Spreads the results downloaded from the USGS service to a global variable called gauge

Source

(static) spreadResults() → {Void}

Grabs the downloaded object to create the links object and parse the dates for each link so they can be in unixtime. Overrides the values of the time used depending on the type of unit used

Source
Returns:

sets the results to be access later by HLM

Type: 
Void

(static) update()

Update the model until a required time, Depending on the module and function required.

Parameters:
TypeDescription
void
Source

(static) update_until(time) → {void}

Updates a model and function call depending on the requirements of the function and module called.

Parameters:
NameTypeDescription
timeNumber

default time to be updated depending on the model

Source
Returns:

updates the current variable to the required timestep.

Type: 
void

rainID() → {Number}

Checks for storm events given dates.

Source
To Do
  • finish implementation.
Returns:

identification of storm event

Type: 
Number