multimodemodel.State

class multimodemodel.State(**kwargs)

State class.

Combines the prognostic variables into a single object.

The variables are passed as keyword arguments to __init__() and stored in the dict variables.

State objects can be added such that the individual variable objects are added. If an variable is missing in one state object, it is treated as zeros.

For convenience, it is also possible to access the variables directly as atttributes of the state object.

Parameters:

**kwargs (dict) – Variables are given by keyword arguments.

Raises:

ValueError – Raised if a argument is not of type Variable.

__init__(**kwargs)

Create State object.

Methods

__init__(**kwargs)	Create State object.
merge(others, merger)	Merge variables.
set_diagnostic_variable(**kwargs)	Set variables for diagnostic purposes.
split(splitter)	Split state.

Attributes

variables
diagnostic_variables