doc/tui_create_boundary.rst

   1 .. _tui_create_boundary:
   2
   3 La frontière
   4 ============
   5
   6 .. index:: single: boundary
   7 .. index:: single: frontière
   8 .. index:: single: cylindre
   9 .. index:: single: sphere
  10
  11 Les variables sont décrites dans :ref:`gui_create_boundary`.
  12
  13 Méthodes de la classe homard
  14 """"""""""""""""""""""""""""
  15 Ces méthodes retournent une instance de la classe boundary.
  16
  17 +----------------------------------------------------------------------------------------+
  18 +----------------------------------------------------------------------------------------+
  19 | .. module:: CreateBoundaryDi                                                           |
  20 |                                                                                        |
  21 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)**                              |
  22 |                                                                                        |
  23 |     - ``boundary_name`` : le nom de la frontière discrète                              |
  24 |     - ``mesh_name`` : le nom du maillage de la frontière                               |
  25 |     - ``mesh_file`` : le nom du fichier contenant ce maillage                          |
  26 +----------------------------------------------------------------------------------------+
  27 | .. module:: CreateBoundaryCylinder                                                     |
  28 |                                                                                        |
  29 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)**       |
  30 |                                                                                        |
  31 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cylindre      |
  32 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées d'un point sur l'axe du cylindre      |
  33 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
  34 |     - ``R`` : rayon du cylindre                                                        |
  35 +----------------------------------------------------------------------------------------+
  36 | .. module:: CreateBoundarySphere                                                       |
  37 |                                                                                        |
  38 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)**                           |
  39 |                                                                                        |
  40 |     - ``boundary_name`` : le nom de la frontière analytique basée sur une sphere       |
  41 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère                |
  42 |     - ``R`` : rayon de la sphère                                                       |
  43 +----------------------------------------------------------------------------------------+
  44
  45 Méthodes de la classe boundary
  46 """"""""""""""""""""""""""""""
  47
  48 +-------------------------------------------------------------------+
  49 +-------------------------------------------------------------------+
  50 | .. module:: GetName                                               |
  51 |                                                                   |
  52 | **GetName()**                                                     |
  53 |     Retourne le nom de la frontière                               |
  54 +-------------------------------------------------------------------+
  55 | .. module:: GetBoundaryType                                       |
  56 |                                                                   |
  57 | **GetBoundaryType()**                                             |
  58 |     Retourne le type de la frontière :                            |
  59 |                                                                   |
  60 |         * 0 : discrète                                            |
  61 |         * 1 : cylindre                                            |
  62 |         * 2 : sphère                                              |
  63 +-------------------------------------------------------------------+
  64 | .. module:: GetCoords                                             |
  65 |                                                                   |
  66 | **GetCoords()**                                                   |
  67 |     Retourne un tableau contenant les coordonnées de la frontière |
  68 |     dans l'ordre d'entrée dans le CreateBoundaryXXXX associé      |
  69 +-------------------------------------------------------------------+
  70
  71
  72 Exemple
  73 """""""
  74 Création d'une frontière discrète, d'une frontière sphèrique, puis d'une frontière cylindrique : ::
  75
  76     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
  77     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
  78     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
  79
  80
  81 Saisie graphique correspondante
  82 """""""""""""""""""""""""""""""
  83 Consulter :ref:`gui_create_boundary`