FigureSaver

class fridom.framework.modules.figure_saver.FigureSaver(filename: str, model_time: float, plotter: ModelPlotter, dpi: int = 256)

Bases: Module

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

Description

This module saves a figure created by a Plotter module to a file at a specified model time. The figure is saved in the ‘figures’ directory, if it does not exist, it is created.

Parameters

thumbnail_pathstr

The path to the file where the figure should be saved.

model_timefloat

The model time at which the figure should be saved.

plotterModelPlotter

The Plotter module that creates the figure.

dpiint

The resolution of the figure in dots per inch.

__init__(filename: str, model_time: float, plotter: ModelPlotter, dpi: int = 256)

Methods

__init__(filename, model_time, plotter[, dpi])
disable()	Disable the module.
enable()	Enable the module.
is_enabled()	Whether the module is enabled or not.
reset()	Stop and start the module.
setup(mset[, setup_mode])	Set the module up.
start()	Start the module.
stop()	Stop the module.
update(mz)	Update the model state.

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.
is_setup	Whether the module is set up.
mset	The model settings.
name
required_halo	The required halo points for this module.

Examples using fridom.framework.modules.FigureSaver

Rayleigh-Bénard Convection

Rayleigh-Bénard Convection

Rayleigh-Taylor Instability

Rayleigh-Taylor Instability

Barotropic Instability.

Barotropic Instability.

Equatorial Waves.

Equatorial Waves.

update(mz: ModelState) → ModelState

Update the model state.

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.

log_level: str | int | None