wolfhece.mesh2d.cst_2D_boundary_conditions

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.mesh2d.cst_2D_boundary_conditions._[source]
class wolfhece.mesh2d.cst_2D_boundary_conditions.Direction(*args, **kwds)[source]

Bases: enum.Enum

Inheritance diagram of wolfhece.mesh2d.cst_2D_boundary_conditions.Direction

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[source]
BOTTOM = 2[source]
X = 1[source]
Y = 2[source]
class wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_GPU(*args, **kwds)[source]

Bases: enum.Enum

Inheritance diagram of wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_GPU

Boundary conditions for 2D simulations with wolfgpu

QX[source]
QY[source]
NONE[source]
HMOD[source]
FROUDE_NORMAL[source]
class wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D(*args, **kwds)[source]

Bases: enum.Enum

Inheritance diagram of wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D

Boundary conditions for 2D simulations

H[source]
QX[source]
QY[source]
NONE[source]
QBX[source]
QBY[source]
HMOD[source]
FROUDE_NORMAL[source]
ALT1[source]
ALT2[source]
ALT3[source]
DOMAINE_BAS_GAUCHE[source]
DOMAINE_DROITE_HAUT[source]
SPEED_X[source]
SPEED_Y[source]
FROUDE_ABSOLUTE[source]
class wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_OO(*args, **kwds)[source]

Bases: enum.Enum

Inheritance diagram of wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_OO

Boundary conditions for 2D simulations with Object-Oriented approach

WATER_DEPTH[source]
WATER_LEVEL[source]
FROUDE_NORMAL[source]
FREE_NONE[source]
CONCENTRATION[source]
IMPERVIOUS[source]
NORMAL_DISCHARGE[source]
TANGENT_DISCHARGE[source]
MOBILE_DAM_POWER_LAW[source]
CLOSE_CONDUIT_QNORMAL[source]
CLOSE_CONDUIT_QTANGET[source]
CLOSE_CONDUIT_H_FOR_SPEED[source]
wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_To_BCType_2D_GPU(bc_type: BCType_2D) → BCType_2D_GPU[source]
wolfhece.mesh2d.cst_2D_boundary_conditions.revert_bc_type(bc_type: BCType_2D | BCType_2D_OO | BCType_2D_GPU, val: int)[source]

Return the BCType corresponding to the given value

Useful for GUI or scripts

wolfhece.mesh2d.cst_2D_boundary_conditions.choose_bc_type(version: Literal[1, 2, 3, 'prev', 'oo', 'gpu'] = 1)[source]

Choose the version of the boundary conditions to use

Useful for GUI

wolfhece.mesh2d.cst_2D_boundary_conditions.ColorsNb[source]