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.
flux_functions	Flux functions module.
forcings	Forcing modules. E.g. relaxation.

Classes, Functions, and Variables

Counter([clock_trigger])

A counting module for debugging purposes.

Module()	Base class for all modules.
module_method(method)	Decorate 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.

Ramper(start_time, ramp_period, ...)

A module for ramping up and down parameters during a simulation.

RestartModule([realtime_interval, ...])

Automatically restart the job at a given interval.

NaNChecker([clock_trigger])

Check if a state vector contains NaN values.

NetCDFWriter([write_trigger, ...])

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.