zoomy_core.model.models.sme

zoomy_core.model.models.sme#

Shallow Moment Equations (SME): the declaratively derived depth-resolved moment Model, for one or two horizontal directions. SystemModel.from_model(SME(level=2)) lifts it to the runtime system.

Module Contents#

Classes#

SME

Shallow Moment Equations of modal order level (level=2 gives h, q_0, q_1, q_2 plus the bed b), derived symbolically by Galerkin projection.

Data#

zeta

API#

zoomy_core.model.models.sme.zeta#

‘Symbol(…)’

class zoomy_core.model.models.sme.SME(init_functions=True, **params)#

Bases: zoomy_core.model.basemodel.Model

Shallow Moment Equations of modal order level (level=2 gives h, q_0, q_1, q_2 plus the bed b), derived symbolically by Galerkin projection.

Lifted to a SystemModel by SystemModel.from_model; stress closures are injected through closures.

References

  • Kowalski & Torrilhon 2019, https://doi.org/10.4208/cicp.OA-2017-0263

Initialization

Declare variables and parameters, run the derivation, and (unless _finalize_lazy) finalize for the SystemModel.

Args

  • init_functions: register the operator methods as symbolic functions during finalization.

level#

‘Integer(…)’

dimension#

‘Integer(…)’

small_slope#

‘Boolean(…)’

quadrature_order#

‘Integer(…)’

stress#

‘OptionParam(…)’

closures#

‘List(…)’

symbolic_spectrum#

‘Boolean(…)’

project_nz#

‘Integer(…)’

derive_model()#

Build the declarative SME model (h-equation, projected horizontal momenta, closures) and register the vertical reconstruction; called by the base __init__.

Contents