MainTendency

class fridom.shallowwater.modules.main_tendency.MainTendency

Bases: ModuleContainer

Container for the main tendency modules of the shallow water model.

The main tendency of the shallow water model computes the tendency terms in the following order:

\[\partial_t \boldsymbol{u} = \text{Linear} + \text{Advection} + \text{Additional}\]

with the default modules being: - linear_tendency: LinearTendency - advection: SadournyAdvection

__init__() → None

Methods

__init__()
add_module(module)	Add a module to the end of the module list.
disable()	Disable the module.
enable()	Enable the module.
get(name)	Get a module by name.
is_enabled()	Whether the module is enabled or not.
reset()	Reset all modules.
setup(mset[, setup_mode])	Set all modules up.
start()	Start all modules.
stop()	Stop all modules.
update(mz)	Update all modules.

Attributes

advection	The advection module (nonlinear + linear by backgound state).
diff_module	The differentiation module to be used by this module.
grid	The grid of the model settings.
info	Return a dictionary with information about the time stepper.
interp_module	The interpolation module to be used by this module.
is_setup	Whether the module is set up.
linear_tendency	The core linear momentum tendency module.
mpi_available	Whether all modules are available in MPI mode.
mset	The model settings.
name
required_halo	The maximum required halo points of all modules.

name = 'Main Tendencies: Shallow Water Model'

add_module(module: Module) → None

Add a module to the end of the module list.

Parameters

moduleModule

The module to be added to the list.

property linear_tendency: LinearTendency

The core linear momentum tendency module.

property advection: AdvectionBase

The advection module (nonlinear + linear by backgound state).