HydroLangBMI

new HydroLangBMI(configfile)

BMI implementation of the functions of HydroLang.js Creates and updates forcings and data following the models from configuration files and makes calls from other modules. If no link is added into the configuration, then an error will be raised. All instances of HydroLang will be accessible through the BMI configuration file.

Parameters:
NameTypeDescription
configfileString
Source

Extends

Methods

(static) dataTypes() → {String}

Returns the data types found within JS and used throughout a specific model run.

Source
Returns:

type of value passed to the function

Type: 
String

(static) finalize() → {void}

Finalizes the requirements of a specific function.

Source
Returns:

alert about model simulation being finalized.

Type: 
void

(static) generateOutputs() → {Object}

Creates an output file downloaded to local machine with the outputs of the model results.

Source
To Do
  • Finilize implementation
Returns:

creates a memory reporter for all the values and actions taken for the model run

Type: 
Object

(static) get_component_name() → {String}

Gives back a model name defined by the configuration file

Parameters:
TypeDescription
void
Source
Returns:

model and modelcode as a full name

Type: 
String

(static) get_current_time() → {Number}

Current time of the model

Source
Returns:
  • The current model time.
Type: 
Number

(static) get_end_time() → {Number}

End time of the model.

Source
Returns:

end time specified.

Type: 
Number

(static) get_grid_edge_count(grid) → {Number}

Get the number of edges in the grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

total number of grid edges

Type: 
Number

(static) get_grid_edge_nodes(grid) → {Array.<Object>}

Get the edge-node connectivity.

Parameters:
NameTypeDescription
gridNumber

A grid identifier

Source
Returns:

number array of (2 x n-nodes) shape to place the edge-node connectivity. For each edge, connectivity is given as node at edge tail, followed by node at edge head.

Type: 
Array.<Object>

(static) get_grid_face_count(grid) → {Number}

Get the number of faces in the grid.

Parameters:
NameTypeDescription
gridNumber

A grid identifier

Source
Returns:

The total number of grid faces.

Type: 
Number

(static) get_grid_face_nodes(grid) → {Array.<Object>}

Returns the face-edge connectivity.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

number array to place face-edge connectivity

Type: 
Array.<Object>

(static) get_grid_face_nodes(grid) → {Array.<Object>}

Returns the face-node connectivity for a grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

number array to place face-node connectivity

Type: 
Array.<Object>

(static) get_grid_node_count(grid) → {Number}

Get the number of nodes in the grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

total number of grid nodes

Type: 
Number

(static) get_grid_nodes_per_face(grid) → {Array.<Object>}

Returns the number of nodes per face of grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

A number Array of (n-faces)shape to place the number of nodes per face.

Type: 
Array.<Object>

(static) get_grid_origin(grid) → {Array.<Object>}

Get the origin of a grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

coordinates of the origin of a specific grid

Type: 
Array.<Object>

(static) get_grid_shape(grid, shape)

Get dimensions of the computational grid

Parameters:
NameTypeDescription
gridNumber

grid identifier

shapeArray.<Object>

A Number Array of n-dim shape into which to place the shape of the grid.

Source

(static) get_grid_size(grid-) → {Number}

Get the dimensions of a computational grid.

Parameters:
NameTypeDescription
grid-Number

grid identifier

Source
Returns:

Grid rank

Type: 
Number

(static) get_grid_size(grid) → {Number}

Get the dimensions of a computational grid.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

Grid size

Type: 
Number

(static) get_grid_spacing(grid) → {Array.<Object>}

Get the spacing between grid nodes.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

spacing of computational grid

Type: 
Array.<Object>

(static) get_grid_type(grid) → {String}

Get the grid type as a string.

Parameters:
NameTypeDescription
gridNumber

A grid identifier

Source
Returns:

Type of grid as a string.

Type: 
String

(static) get_grid_x(grid) → {Array.<Object>}

Get the locations of a grid’s nodes in dimension x.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

array containing n-rows holding x-coordinates

Type: 
Array.<Object>

(static) get_grid_y(grid) → {Array.<Object>}

Get the locations of a grid’s nodes in dimension y.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

array containing n-rows holding y-coordinates

Type: 
Array.<Object>

(static) get_grid_z(grid) → {Array.<Object>}

Get the locations of a grid’s nodes in dimension z.

Parameters:
NameTypeDescription
gridNumber

grid identifier

Source
Returns:

array containing n-rows holding z-coordinates

Type: 
Array.<Object>

(static) get_input_item_count() → {Object}

Lets other models see the available variables included within the model

Parameters:
TypeDescription
void
Source
Returns:

array with names as strings

Type: 
Object

(static) get_time_step() → {Number}

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

Source
Returns:

default time step

Type: 
Number

(static) get_time_units() → {String}

Time units of the model

Source
Returns:

unit of time. If not specified in config file, the unit used throughout HydroLang is hour

Type: 
String

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

Parameters:
NameTypeDescription
var_nameString

name of input variable

destArray.<Object>

array destiny for the results

indsArray.<Object>

array containing the indices

Source
Returns:

destiny array with objects

Type: 
Array.<Object>

(static) get_value_ptr(var_name, array) → {Error}

Get a reference to the values of a given variable. Tailored towards the final implementation of the

Parameters:
NameTypeDescription
var_nameString

name of input or output variable

arrayArray.<Object>

array object holding result

Source
Returns:

no implementation for HydroLangBMI/JavaScript.

Type: 
Error

(static) get_var_type(name) → {String}

Returns the data type of the given variable.

Parameters:
NameTypeDescription
nameString

input or output variable name, a CSDMS Standard Name

Source
Returns:

Variable nme depending on the type of variable.

Type: 
String

(static) handleConfig() → {void}

Configuration object that creates a result based on the passed configurations to the HydroLang instance requirement. It saves any results on a result variable that is attached into the class after its called. The method runs once the HydroLangBMI class is called.

Source
Returns:
  • creates a result variable attached to the class.
Type: 
void

(static) initialize(configfile) → {void}

Parameters:
NameTypeDescription
configfileString

configuration file that contains minimum the following: model name, component name, module name, model code, function name, arguments, parameters.

Source
Returns:

sets the variables from above to the this object.

Type: 
void

(static) set_value(var_name, array)

Sets a value for an exisiting variable from an array.

Parameters:
NameTypeDescription
var_nameString

name of the input variable

arrayArray.<Object>

array with values to be copied

Source

(static) set_value_at_indices(var_name, inds, dest)

Sets values at particular indices

Parameters:
NameTypeDescription
var_nameString

name of input variable

indsArray.<Object>

array containing the indices

destArray.<Object>

array contaiing the results

Source

(static) update()

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

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

(static) visualizer(type, data) → {Object}

Parameters:
NameTypeDescription
typeString

either column or line chart

dataArray.<Object>

n-d array containing the data to render

Source
Returns:

creates a div on screen that renders the graph using HydroLang's visualize module.

Type: 
Object