TendencyDivergence

class fridom.nonhydro.modules.tendency_divergence.TendencyDivergence

Bases: Module

This class computes the divergence of the tendency of the model. The divergence of the tendency is required for the pressure solver.

__init__() → None

Methods

__init__()
compute_divergence(dz)	Compute the divergence of the tendency.
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.
is_enabled()	Return whether the module is enabled or not.
reset()	Stop and start the module.
setup(mset)	Start the module
start()	Start the module
stop()	Stop the module
update(mz)	Update the module

Attributes

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.
mset	The model settings
name
required_halo

name = 'Tendency Divergence'

compute_divergence(dz: StateBase) → FieldVariable

Compute the divergence of the tendency.

update(mz: ModelState) → ModelState

Update the module

Description

This method is called by the model at each time step. Child classes should overwrite this method to update the module. Make sure to decorate the method with the @module_method decorator.

Parameters

mzfr.ModelState

The model state at the current time step.

Returns

fr.ModelState

The updated model state.