ModelState

ModelState#

class fridom.framework.model_state.ModelState(mset: ModelSettingsBase, clock: Clock | None = None)[source]#

Bases: object

Stores the model state variables and the time information.

Description#

The base class for model states. It contains the state vector, the time step and the model time. Child classes may add more attributes as for example the diagnostic variables needed for the model. All model state variables should be stored in this class.

Parameters#

msetModelSettings: The model settings object.
clockClock, optional: The clock object to keep track of the model time.

__init__(mset: ModelSettingsBase, clock: Clock | None = None) → None[source]#

Methods

`__init__`(mset[, clock])
`reset`()	Reset the model state.

Attributes

`clock`	The clock of the model.
`dz`	The tendency vector.
`it`	The iteration number.
`panicked`	Flag to cancel the model run in case something goes wrong.
`xr`	Model State as xarray dataset
`xrs`	Model State of sliced domain as xarray dataset
`z`	The state vector.
`z_diag`	The diagnostic state vector.