doc/en/tui_create_boundary.rst

   1 .. _tui_create_boundary:
   2
   3 The boundary
   4 ############
   5
   6 .. index:: single: boundary
   7 .. index:: single: cylinder
   8 .. index:: single: sphere
   9
  10 The variables are described in :ref:`gui_create_boundary`.
  11
  12 Methods of the class homard
  13 ***************************
  14 These methods returns an instance of the class boundary.
  15
  16 +----------------------------------------------------------------------------------------+
  17 +----------------------------------------------------------------------------------------+
  18 | .. module:: CreateBoundaryDi                                                           |
  19 |                                                                                        |
  20 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)**                              |
  21 |     Returns an instance of the class ``boundary``, type discrete after its creation    |
  22 |                                                                                        |
  23 |     - ``boundary_name``: the name of the discrete boundary                             |
  24 |     - ``mesh_name``: the name of the mesh of the boundary                              |
  25 |     - ``mesh_file``: the name of the file for this mesh                                |
  26 +----------------------------------------------------------------------------------------+
  27 | .. module:: CreateBoundaryCylinder                                                     |
  28 |                                                                                        |
  29 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)**       |
  30 |     Returns an instance of the class ``boundary`` analytical type cylindrical          |
  31 |     after its creation                                                                 |
  32 |                                                                                        |
  33 |     - ``boundary_name``: the name of the analytical boundary based on a cylinder       |
  34 |     - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of a point on the axis of the cylinder |
  35 |     - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis                                 |
  36 |     - ``R``: radius of the cylinder                                                    |
  37 +----------------------------------------------------------------------------------------+
  38 | .. module:: CreateBoundarySphere                                                       |
  39 |                                                                                        |
  40 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)**                           |
  41 |     Returns an instance of the class ``boundary`` analytical type spherical            |
  42 |     after its creation                                                                 |
  43 |                                                                                        |
  44 |     - ``boundary_name``: the name of the boundary analytique based on a sphere         |
  45 |     - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the sphere            |
  46 |     - ``R``: radius of the sphere                                                      |
  47 +----------------------------------------------------------------------------------------+
  48 | .. module:: CreateBoundaryConeA                                                        |
  49 |                                                                                        |
  50 | **CreateBoundaryConeA(boundary_name, Xaxe, Yaxe, Zaxe, Angle, Xcen, Ycen, Zcen)**      |
  51 |     Returns an instance of the class ``boundary`` analytical type conical              |
  52 |     after its creation                                                                 |
  53 |                                                                                        |
  54 |     - ``boundary_name``: the name of the boundary analytique based on a cone           |
  55 |     - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis                                 |
  56 |     - ``Angle``: opening angle of the cone in degree (between 0 and 90)                |
  57 |     - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the cone              |
  58 +----------------------------------------------------------------------------------------+
  59 | .. module:: CreateBoundaryConeR                                                        |
  60 |                                                                                        |
  61 | **CreateBoundaryConeR(boundary_name, Xc1, Yc1, Zc1, R1, Xc2, Yc2, Zc2, R2)**           |
  62 |     Returns an instance of the class ``boundary`` analytical type conical              |
  63 |     after its creation                                                                 |
  64 |                                                                                        |
  65 |     - ``boundary_name``: the name of the boundary analytique based on a cone           |
  66 |     - ``Xc1``, ``Yc1``, ``Zc1``: coordinates of the first centre of the cone           |
  67 |     - ``R1``: radius of the cone at the first centre of the cone                       |
  68 |     - ``Xc2``, ``Yc2``, ``Zc2``: coordinates of the second centre of the cone          |
  69 |     - ``R2``: radius of the cone at the second centre of the cone                      |
  70 +----------------------------------------------------------------------------------------+
  71 | .. module:: CreateBoundaryTorus                                                        |
  72 |                                                                                        |
  73 | **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
  74 |     Returns an instance of the class ``boundary`` analytical type torus                |
  75 |     after its creation                                                                 |
  76 |                                                                                        |
  77 |     - ``boundary_name``: the name of the analytical boundary based on a torus          |
  78 |     - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the torus             |
  79 |     - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis                                 |
  80 |     - ``RRev``: revolution radius of the torus                                         |
  81 |     - ``RPri``: primary radius of the torus                                            |
  82 +----------------------------------------------------------------------------------------+
  83
  84 +---------------------------------------------------------------+
  85 +---------------------------------------------------------------+
  86 | .. module:: GetBoundary                                       |
  87 |                                                               |
  88 | **GetBoundary(boundary_name)**                                |
  89 |     Returns the instance of the class classe ``boundary``     |
  90 |     known by its name                                         |
  91 |                                                               |
  92 |     - ``boundary_name``: the name of the boundary             |
  93 +---------------------------------------------------------------+
  94 | .. module:: GetAllBoundarysName                               |
  95 |                                                               |
  96 | **GetAllBoundarysName()**                                     |
  97 |     Returns the list of the names of all the existing         |
  98 |     boundaries                                                |
  99 |                                                               |
 100 +---------------------------------------------------------------+
 101
 102 Methods of the class cas
 103 ************************
 104 See also in :ref:`tui_create_case`.
 105
 106 +---------------------------------------------------------------+
 107 +---------------------------------------------------------------+
 108 | .. module:: AddBoundaryGroup                                  |
 109 |                                                               |
 110 | **AddBoundaryGroup(boundary, group)**                         |
 111 |     Add a boundary to the definition of a case                |
 112 |                                                               |
 113 |     - ``boundary``: name of the curved boundary               |
 114 |                                                               |
 115 |     Discrete boundary:                                        |
 116 |                                                               |
 117 |     . if all the curved lines are involved, the second        |
 118 |     argument is an empty string.                              |
 119 |                                                               |
 120 |     . if only some curved lines are involved, ``group`` is    |
 121 |     the name of the group of segments                         |
 122 |                                                               |
 123 |     Analytical boundary:                                      |
 124 |                                                               |
 125 |     - ``group``: name of the groupe of faces located on the   |
 126 |       boundary                                                |
 127 +---------------------------------------------------------------+
 128
 129 Methods of the class boundary
 130 *****************************
 131
 132 +---------------------------------------------------------------+
 133 +---------------------------------------------------------------+
 134 | .. module:: GetName                                           |
 135 |                                                               |
 136 | **GetName()**                                                 |
 137 |     Returns the name of the boundary                          |
 138 +---------------------------------------------------------------+
 139 | .. module:: GetType                                           |
 140 |                                                               |
 141 | **GetType()**                                                 |
 142 |     Returns the type of the boundary:                         |
 143 |                                                               |
 144 |         * 0: discrete                                         |
 145 |         * 1: cylinder                                         |
 146 |         * 2: sphere                                           |
 147 |         * 3: cone defined by an axis and an angle             |
 148 |         * 4: cone defined by 2 radius                         |
 149 |         * 5: torus                                            |
 150 +---------------------------------------------------------------+
 151 | .. module:: GetCoords                                         |
 152 |                                                               |
 153 | **GetCoords()**                                               |
 154 |     Returns the array of the coordinates of the boundary      |
 155 |     with the same order as in its definition with             |
 156 |     CreateBoundaryXXXX                                        |
 157 +---------------------------------------------------------------+
 158 | .. module:: Delete                                            |
 159 |                                                               |
 160 | **Delete()**                                                  |
 161 |     Deletes the boundary.                                     |
 162 |     If the boundary is discrete, the file of the mesh is kept.|
 163 |                                                               |
 164 |     Returns an integer:                                       |
 165 |         * 0: the destruction is done                          |
 166 |         * other value: problem                                |
 167 +---------------------------------------------------------------+
 168
 169
 170 Example
 171 *******
 172 Creation of a discrete boundary, a spherical boundary, and a cylindrical boundary:
 173 ::
 174
 175     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
 176     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
 177     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
 178
 179
 180 Similar graphical input
 181 ***********************
 182 Look at :ref:`gui_create_boundary`