InterpolationModule

class fridom.framework.grid.InterpolationModule

Bases: Module

The base class for interpolation methods.

Description

An interpolation module is a class that interpolates a field from one position to another. For example, from the cell face to the cell center.

__init__() → None

Methods

__init__()
disable()	Enabling the module means that it will be executed at each time step.
enable()	Enabling the module means that it will be executed at each time step.
interpolate(f, destination)	Interpolate the field to the destination position.
is_enabled()	Return whether the module is enabled or not.
reset()	Stop and start the module.
setup(mset)	Start the module
start()	Start the module
stop()	Stop the module
update(mz)	Update the module

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.
mset	The model settings
name
required_halo

name = 'Interpolation Module'

abstract interpolate(f: FieldVariable, destination: Position) → FieldVariable

Interpolate the field to the destination position.

Parameters

ffr.FieldVariable

The field to interpolate.

destinationfr.grid.Position

The position to interpolate to.

Returns

fr.FieldVariable

The interpolated field.