MainTendency#

class fridom.nonhydro.modules.main_tendency.MainTendency[source]#

Bases: ModuleContainer

__init__()[source]#

Methods

__init__()

add_module(module)

Add a module to the end of the module list.

disable()

Enabling the module means that it will be executed at each time step.

enable()

Enabling the module means that it will be executed at each time step.

get(name)

Get a module by name.

is_enabled()

Return whether the module is enabled or not.

reset()

Reset all modules.

setup(mset)

Setup all modules.

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.

linear_tendency

The core linear momentum tendency module.

mpi_available

Whether all modules are available in MPI mode.

mset

The model settings

name

pressure_gradient_tendency

The pressure gradient tendency module.

pressure_solver

The pressure solver module.

required_halo

The maximum required halo points of all modules.

tendency_divergence

The divergence of the momentum tendency, for the pressure solver

name = 'Main Tendencies: Nonhydrostatic Model'#
add_module(module)[source]#

Add a module to the end of the module list.

Parameters#

moduleModule

The module to be added to the list.

property linear_tendency#

The core linear momentum tendency module.

property advection#

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

property tendency_divergence#

The divergence of the momentum tendency, for the pressure solver

property pressure_solver#

The pressure solver module.

property pressure_gradient_tendency#

The pressure gradient tendency module.