FluxFunctionBase

class fridom.framework.modules.flux_functions.flux_function_base.FluxFunctionBase

Bases: Module

Base class for flux functions.

Description

This class implements the base interface for flux functions.

__init__() → None

Methods

__init__()
compute(flux_left, flux_right, velocity)	Compute the flux function.
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.

name = 'Flux Function Base'

abstract compute(flux_left: ScalarField, flux_right: ScalarField, velocity: ScalarField) → ScalarField

Compute the flux function.

Parameters

flux_leftfr.ScalarField

The flux field which is biased to the left.

flux_rightfr.ScalarField

The flux field which is biased to the right.

velocityfr.ScalarField

The velocity field.

Returns

fr.ScalarField

The computed flux function.