modules

modules#

Module: fridom.framework.modules

Submodules

animation

Modules for creating animated output of the model

advection

Advection modules for 1D, 2D, and 3D fluid simulations.

closures

Closure modules. E.g. diffusion, hyperdiffusion, etc.

forcings

Forcing modules. E.g. relaxation

Classes, Functions, and Variables

Module()

Base class for all modules.

module_method(method)

Decorator for the start, update and stop method of a module.

ModuleContainer([name, module_list])

A module container that can hold multiple modules.

ProgressBar()

A progress bar module to display the progress of the simulation.

RestartModule([realtime_interval, ...])

NetCDFWriter(write_interval[, filename, ...])

Writing model output to NetCDF files.

ResetTendency()

A module that resets the tendency of a model state.

FigureSaver(filename, model_time, plotter[, dpi])

Saves a figure created by a Plotter module to a file.

Base classes and functions for creating modules in the model.