openmi.om.channelObject: The base class for executable equation based meta-model...

In HARPgroup/openmi-om: Implementation of the OpenMI Concepts for Building Object-oriented Meta-models

The base class for executable equation based meta-model components.

Description

The base class for executable equation based meta-model components.

The base class for executable equation based meta-model components.

Value

reference class of type openmi.om.channelObject

Super classes

openmi.om::openmi.om.base -> openmi.om::openmi.om.linkableComponent -> openmi.om.channelObject

Public fields

area

the drainage area to this channel (square miles)

length

the length of the channel segment (ft)

base

the channel bottom base in feet (used for trapezoidal or rectangular)

Z

side slope

slope

channel slope

n

Manning's roughness coefficient

substrateclass

substrate class (USGS hab model aram, A, B, C, D)

channeltype

channel shape (only trapezoidal channels, type=2 are currently supported)

storageinitialized

is the storage initialized on first exec?

pdepth

mean pool depth below channel bottom

tol

solution exactness tolerance to stop iterating.

Methods

Public methods

• openmi.om.channelObject$settable()

• openmi.om.channelObject$new()

• openmi.om.channelObject$init()

• openmi.om.channelObject$update()

• openmi.om.channelObject$evaluate()

• openmi.om.channelObject$evaluate_heat()

• openmi.om.channelObject$clone()

Inherited methods

• openmi.om::openmi.om.base$addComponent()

• openmi.om::openmi.om.base$addInput()

• openmi.om::openmi.om.base$add_component()

• openmi.om::openmi.om.base$asJSON()

• openmi.om::openmi.om.base$finish()

• openmi.om::openmi.om.base$getInputs()

• openmi.om::openmi.om.base$getValue()

• openmi.om::openmi.om.base$get_component_id()

• openmi.om::openmi.om.base$logState()

• openmi.om::openmi.om.base$log_debug()

• openmi.om::openmi.om.base$orderOperations()

• openmi.om::openmi.om.base$parse_class_specific()

• openmi.om::openmi.om.base$parse_openmi()

• openmi.om::openmi.om.base$prepare()

• openmi.om::openmi.om.base$set_prop()

• openmi.om::openmi.om.base$set_sub_prop()

• openmi.om::openmi.om.base$set_vars()

• openmi.om::openmi.om.base$step()

• openmi.om::openmi.om.base$stepChildren()

• openmi.om::openmi.om.base$validate()

---

Method settable()

settable returns properties that can be set at initialize()

Usage

openmi.om.channelObject$settable()

Returns

array c() of object property names

---

Method new()

create new instance of channel object

Usage

openmi.om.channelObject$new(elem_list = list(), format = "raw")

Arguments

elem_list

list of attributes to set on object

format

data format of elem_list

Returns

array c() of object property names

---

Method init()

init sets up stream for model run

Usage

openmi.om.channelObject$init()

Returns

NULL

---

Method update()

update executes the parsed equation, sets object value prop

Usage

openmi.om.channelObject$update()

Returns

NULL

---

Method evaluate()

evaluate is called by update, but can also be called if calling routine wants the value returned

Usage

openmi.om.channelObject$evaluate()

Returns

value the result of the equation

---

Method evaluate_heat()

evaluate is called by update, but can also be called if calling routine wants the value returned

Usage

openmi.om.channelObject$evaluate_heat()

Returns

value the result of the equation

---

Method clone()

The objects of this class are cloneable with this method.

Usage

openmi.om.channelObject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

NA

HARPgroup/openmi-om documentation built on March 4, 2023, 6:56 p.m.