:py:mod:`wolfhece.mesh2d.cst_2D_boundary_conditions`
====================================================

.. py:module:: wolfhece.mesh2d.cst_2D_boundary_conditions

.. autoapi-nested-parse::

   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
---------------

.. py:data:: _

   

.. py:class:: Direction


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.mesh2d.cst_2D_boundary_conditions.Direction
      :parts: 1
      :private-bases:

   Generic enumeration.

   Derive from this class to define new enumerations.

   .. py:attribute:: LEFT
      :value: 1

      

   .. py:attribute:: BOTTOM
      :value: 2

      

   .. py:attribute:: X
      :value: 1

      

   .. py:attribute:: Y
      :value: 2

      


.. py:class:: BCType_2D_GPU


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_GPU
      :parts: 1
      :private-bases:

   Boundary conditions for 2D simulations with wolfgpu

   .. py:attribute:: QX
      :value: (2,)

      

   .. py:attribute:: QY
      :value: (3,)

      

   .. py:attribute:: NONE
      :value: (4,)

      

   .. py:attribute:: HMOD
      :value: (7,)

      

   .. py:attribute:: FROUDE_NORMAL
      :value: (8,)

      


.. py:class:: BCType_2D


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D
      :parts: 1
      :private-bases:

   Boundary conditions for 2D simulations

   .. py:attribute:: H
      :value: (1,)

      

   .. py:attribute:: QX
      :value: (2,)

      

   .. py:attribute:: QY
      :value: (3,)

      

   .. py:attribute:: NONE
      :value: (4,)

      

   .. py:attribute:: QBX
      :value: (5,)

      

   .. py:attribute:: QBY
      :value: (6,)

      

   .. py:attribute:: HMOD
      :value: (7,)

      

   .. py:attribute:: FROUDE_NORMAL
      :value: (8,)

      

   .. py:attribute:: ALT1
      :value: (9,)

      

   .. py:attribute:: ALT2
      :value: (10,)

      

   .. py:attribute:: ALT3
      :value: (11,)

      

   .. py:attribute:: DOMAINE_BAS_GAUCHE
      :value: (12,)

      

   .. py:attribute:: DOMAINE_DROITE_HAUT
      :value: (13,)

      

   .. py:attribute:: SPEED_X
      :value: (14,)

      

   .. py:attribute:: SPEED_Y
      :value: (15,)

      

   .. py:attribute:: FROUDE_ABSOLUTE
      :value: (16,)

      


.. py:class:: BCType_2D_OO


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_OO
      :parts: 1
      :private-bases:

   Boundary conditions for 2D simulations with Object-Oriented approach

   .. py:attribute:: WATER_DEPTH
      :value: (1,)

      

   .. py:attribute:: WATER_LEVEL
      :value: (2,)

      

   .. py:attribute:: FROUDE_NORMAL
      :value: (4,)

      

   .. py:attribute:: FREE_NONE
      :value: (5,)

      

   .. py:attribute:: CONCENTRATION
      :value: (7,)

      

   .. py:attribute:: IMPERVIOUS
      :value: (99,)

      

   .. py:attribute:: NORMAL_DISCHARGE
      :value: (31,)

      

   .. py:attribute:: TANGENT_DISCHARGE
      :value: (32,)

      

   .. py:attribute:: MOBILE_DAM_POWER_LAW
      :value: (127,)

      

   .. py:attribute:: CLOSE_CONDUIT_QNORMAL
      :value: (61,)

      

   .. py:attribute:: CLOSE_CONDUIT_QTANGET
      :value: (62,)

      

   .. py:attribute:: CLOSE_CONDUIT_H_FOR_SPEED
      :value: (63,)

      


.. py:function:: BCType_2D_To_BCType_2D_GPU(bc_type: BCType_2D) -> BCType_2D_GPU


.. py:function:: revert_bc_type(bc_type: Union[BCType_2D, BCType_2D_OO, BCType_2D_GPU], val: int)

   Return the BCType corresponding to the given value

   Useful for GUI or scripts


.. py:function:: choose_bc_type(version: Literal[1, 2, 3, prev, oo, gpu] = 1)

   Choose the version of the boundary conditions to use

   Useful for GUI


.. py:data:: ColorsNb