GaPFlow.topography.Topography

class GaPFlow.topography.Topography(fc: Any, grid: dict, geo: dict, prop: dict)

Bases: object

Topography container.

Holds the rigid gap topography, and, in case of an elastic substrate, its deformation due to the fluid pressure field.

__init__(fc: Any, grid: dict, geo: dict, prop: dict) → None

Constructor

Parameters:

• fc (muGrid.GlobalFieldCollection) – The field collection object.

• grid (dict) – Parameters controlling spatial discretization.

• geo (dict) – Geometry settings.

• prop (dict) – Material properties.

Methods

__init__(fc, grid, geo, prop)	Constructor
update()	Updates the topography field in case of enabled elastic deformation.
update_gradients()	Updates gradient arrays using second-order central differences.

Attributes

deformation	Displacement field.
dh_dx	Height gradient field (∂h/∂x)
dh_dy	Height gradient field (∂h/∂y)
full	Return the full topography array (height, slopes, and displacement)
h	Height field.
x	Cell center x coordinates
y	Cell center y coordinates

property deformation: ndarray[tuple[Any, ...], dtype[floating]]

Displacement field.

property dh_dx: ndarray[tuple[Any, ...], dtype[floating]]

Height gradient field (∂h/∂x)

property dh_dy: ndarray[tuple[Any, ...], dtype[floating]]

Height gradient field (∂h/∂y)

property full: ndarray[tuple[Any, ...], dtype[floating]]

Return the full topography array (height, slopes, and displacement)

property h: ndarray[tuple[Any, ...], dtype[floating]]

Height field.

update() → None

Updates the topography field in case of enabled elastic deformation.

update_gradients() → None

Updates gradient arrays using second-order central differences.

property x

Cell center x coordinates

property y

Cell center y coordinates