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
  16 +----------------------------------------------------------------+
  17 +================================================================+
  18 | .. module:: CreateBoundary                                     |
  19 |                                                                |
  20 | **CreateBoundary(boundary_name, boundary_type)**               |
  21 |                                                                |
  22 |     - ``boundary_name`` : le nom de la zone                    |
  23 |     - ``boundary_type`` : entier précisant le type de frontière|
  24 |                                                                |
  25 |         * 1 : cylindre                                         |
  26 |         * 2 : sphère                                           |
  27 +----------------------------------------------------------------+
  28
  29 Méthodes de la classe boundary
  30 """"""""""""""""""""""""""""""
  31
  32 +---------------------------------------------------------------+
  33 +===============================================================+
  34 | .. module:: GetName                                           |
  35 |                                                               |
  36 | **GetName()**                                                 |
  37 |     Retourne le nom de la frontière                           |
  38 +---------------------------------------------------------------+
  39 | .. module:: GetBoundaryType                                   |
  40 |                                                               |
  41 | **GetBoundaryType()**                                         |
  42 |     Retourne le type de la frontière                          |
  43 +---------------------------------------------------------------+
  44 | .. module:: SetCylinder                                       |
  45 |                                                               |
  46 | **SetCylinder(Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)**        |
  47 |                                                               |
  48 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées d'un point   |
  49 |        sur l'axe du cylindre                                  |
  50 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe         |
  51 |     - ``R`` : rayon du cylindre                               |
  52 +---------------------------------------------------------------+
  53 | .. module:: SetSphere                                         |
  54 |                                                               |
  55 | **SetSphere(Xcen, Ycen, Zcen, R)**                            |
  56 |                                                               |
  57 |     - ``Xcen`` : X du centre                                  |
  58 |     - ``Ycen`` : Y du centre                                  |
  59 |     - ``Zcen`` : Z du centre                                  |
  60 |     - ``R`` : rayon de la sphère                              |
  61 +---------------------------------------------------------------+
  62
  63
  64 Exemple
  65 """""""
  66 Création d'une frontière sphérique, puis d'une frontière cylindrique : ::
  67
  68     fron_1 = homard.CreateBoundary("FRON_1", 2)
  69     fron_1.SetSphere(12.3, 3.4, .56, 6.5)
  70     fron_2 = homard.CreateBoundary('CYL_1', 1)
  71     fron_2.SetCylinder(0.0, 25., -25., 25., 50., 75., 100.)
  72
  73