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(*args, **kwds)

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

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


   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.


   .. 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(*args, **kwds)

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


   .. py:attribute:: QX


   .. py:attribute:: QY


   .. py:attribute:: NONE


   .. py:attribute:: HMOD


   .. py:attribute:: FROUDE_NORMAL


.. py:class:: BCType_2D(*args, **kwds)

   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


   .. py:attribute:: QX


   .. py:attribute:: QY


   .. py:attribute:: NONE


   .. py:attribute:: QBX


   .. py:attribute:: QBY


   .. py:attribute:: HMOD


   .. py:attribute:: FROUDE_NORMAL


   .. py:attribute:: ALT1


   .. py:attribute:: ALT2


   .. py:attribute:: ALT3


   .. py:attribute:: DOMAINE_BAS_GAUCHE


   .. py:attribute:: DOMAINE_DROITE_HAUT


   .. py:attribute:: SPEED_X


   .. py:attribute:: SPEED_Y


   .. py:attribute:: FROUDE_ABSOLUTE


.. py:class:: BCType_2D_OO(*args, **kwds)

   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


   .. py:attribute:: WATER_LEVEL


   .. py:attribute:: FROUDE_NORMAL


   .. py:attribute:: FREE_NONE


   .. py:attribute:: CONCENTRATION


   .. py:attribute:: IMPERVIOUS


   .. py:attribute:: NORMAL_DISCHARGE


   .. py:attribute:: TANGENT_DISCHARGE


   .. py:attribute:: MOBILE_DAM_POWER_LAW


   .. py:attribute:: CLOSE_CONDUIT_QNORMAL


   .. py:attribute:: CLOSE_CONDUIT_QTANGET


   .. py:attribute:: CLOSE_CONDUIT_H_FOR_SPEED


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