Diagnostics#

class fridom.nonhydro.modules.diagnostics.Diagnostics(interval=50, energy_info=True, cfl_info=True)[source]#

Bases: Module

__init__(interval=50, energy_info=True, cfl_info=True)[source]#

Methods

__init__([interval, energy_info, cfl_info])

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)

Print diagnostic information.

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 = 'Diagnostics'#
update(mz: ModelState) ModelState[source]#

Print diagnostic information.