wolfgpu.simplesimu.boundary_conditions

Module Contents

class wolfgpu.simplesimu.boundary_conditions.BoundaryConditionsTypes(*args, **kwds)

Bases: enum.Enum

The boundary conditions types.

Note: The values match the numbers in Wolf’s simulations parameters.

H = 1

Weak boundary condition over \(h+b\), the water free surface height (that is, height of water plus bathymetry level).

QX = 2

Weak boundary condition over \(q_x\), the discharge over the x-axis.

QY = 3

Weak boundary condition over \(q_y\), the discharge over the x-axis.

NONE = 4

This is used to represent the absence of boundary condition.

QBX = 5

Not used.

QBY = 6

Not used.

HMOD = 7

Weak boundary condition over \(h\), the water free surface height.

FROUDE_NORMAL = 8

Weak boundary condition for Froude limited height. Water height becomes \(\min(h, \frac{u^2}{g \times \text{Fr}^2})\) where \(\text{Fr}\) is given.

class wolfgpu.simplesimu.boundary_conditions.Direction(*args, **kwds)

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

>>> Color.RED
<Color.RED: 1>

• value lookup:

>>> Color(1)
<Color.RED: 1>

• name lookup:

>>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

LEFT = 1

BOTTOM = 2

X = 1

Y = 2

class wolfgpu.simplesimu.boundary_conditions.BoundaryConditionIndices(*args, **kwds)

Bases: enum.Enum

The column indices of each supported boundary conditions in the boundary conditions table. This also covers cell parameters.

IMPORTANT: These values are tied to data representation in the shader. Don’t change them!

These are separate from the BoundaryConditionsTypes because they don’t serve the same purpose. These are for data representation in wolfgpu whereas BoundaryConditionsTypes are for CPU Wolf compatibility.

BoundaryConditionsTypes and CellParameterType must all be converted to this enum when loading the sim in the gpu.

BC_TABLE_INDEX_FOR_H_ON_LEFT = 1

BC_TABLE_INDEX_FOR_HMOD_ON_LEFT = 2

BC_TABLE_INDEX_FOR_QX_ON_LEFT = 0

BC_TABLE_INDEX_FOR_QY_ON_LEFT = 3

BC_TABLE_INDEX_FOR_FROUDE_NORMAL_ON_LEFT = 8

BC_TABLE_INDEX_FOR_H_ON_BOTTOM = 4

BC_TABLE_INDEX_FOR_HMOD_ON_BOTTOM = 5

BC_TABLE_INDEX_FOR_QX_ON_BOTTOM = 6

BC_TABLE_INDEX_FOR_QY_ON_BOTTOM = 7

BC_TABLE_INDEX_FOR_FROUDE_NORMAL_ON_BOTTOM = 9

BC_TABLE_INDEX_FOR_BRIDGE_DECK_ELEVATION = 10

BC_TABLE_INDEX_FOR_BRIDGE_ROOF_ELEVATION = 11

classmethod index_for_bc_type(param_type: BoundaryConditionsTypes, direction: Direction) → BoundaryConditionIndices

Find the column index in the BC table for a given BC type and direction. :param param_type: The type of parameter to set. See

BoundaryConditionIndices enum for possible values.

Parameters:

direction – The direction of the boundary condition.

Returns:

The column index in the BC table.

wolfgpu.simplesimu.boundary_conditions.BC_ON_LEFT

wolfgpu.simplesimu.boundary_conditions.BC_ON_BOTTOM

class wolfgpu.simplesimu.boundary_conditions.boundary_condition_2D(i: int, j: int, ntype: BoundaryConditionsTypes, val: float, direction: Direction)

Type des CL générales, faibles et fortes @author Pierre Archambeau

i

j

ntype

val

direction

to_dict()

classmethod from_dict(js)

wolfgpu.simplesimu.boundary_conditions.BC_BLANK_VALUE

wolfgpu.simplesimu.boundary_conditions.NB_BC_TYPES