ProgressBar

class fridom.framework.modules.progress_bar.ProgressBar

Bases: Module

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

Description

The progress bar class is a wrapper around the tqdm progress bar. It has a custom format and handles the output to the stdout when the stdout is a file.

Parameters

disablebool

Whether to disable the progress bar.

__init__() → None

Methods

__init__()
disable()	Disable the module.
enable()	Enable the module.
is_enabled()	Whether the module is enabled or not.
reset()	Stop and start the module.
set_options(main_loop_type, ...)
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.

name = 'Progress Bar'

start() → None

Start the module.

Description

This method is called at the beginning of the model run. Child classes that require a start method (for example to start an output writer) should overwrite this method. Make sure to decorate the method with the @module_method decorator.

stop() → None

Stop the module.

Description

This method is called by the model at the end of the model run or when the model is reset. Child classes that require a stop method (for example to close an output file) should overwrite this method. Make sure to decorate the method with the @module_method decorator.

set_options(main_loop_type: str, datetime_formatting: bool, start_value: float, final_value: float)

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.