doc/tui_blocks_for_cyl_pipe.rst

   1 :tocdepth: 3
   2
   3
   4 .. _tuiblockscylinderpipe:
   5
   6 ================================
   7 Cylinders and Pipes Construction
   8 ================================
   9
  10 .. _tuicylinder:
  11
  12 Cylinder
  13 ========
  14
  15 .. _tuicylindersimple:
  16
  17 Simple Cylinder
  18 ---------------
  19
  20 To make a simple cylinder grid in python mode, the following data are required:
  21
  22 - *nbR* : number of hexahedra on radial.
  23 - *nbA* : number of hexahedra along the perimeter of the cylinder.
  24 - *nbH* : number of hexahedra along the axis of the cylinder.
  25
  26 Use the function **makeCyinderTop**::
  27
  28         elts = doc.makeCylinderTop(nbR, nbA, nbH)
  29
  30 GUI command: :ref:`guicylindersimple`
  31
  32
  33 .. _tuicylinderuniform:
  34
  35 Uniform Cylinder
  36 ----------------
  37
  38 The following data are required:
  39
  40 - *origin* : origin's coordinates of the cylinder (select a vertex).
  41 - *vx*     : the base of the cylinder (select a vector).
  42 - *vz*     : the axis of the cylinder (select a vector).
  43 - *rint*   : the radius of the hole in the cylinder .
  44 - *rext*   : the radius of the cylinder.
  45 - *angle*  : angle of the cylinder around the Z axis.
  46 - *hauteur*: the height of the cylinder.
  47 - *nbR*    : number of hexahedra on radial.
  48 - *nbA*    : number of hexahedra along the perimeter of the cylinder.
  49 - *nbH*    : number of hexahedra along the axis of the cylinder.
  50
  51 Use the function **makeCylinderUni** to  make a uniform cylinder::
  52
  53         elts = doc.makeCylinderUni(origin, vx, vz, rint, rext, angle, hauteur, nbR, nbA, nbH)
  54
  55 GUI command: :ref:`guicylinderuniform`
  56
  57
  58 .. _tuicylindercustom:
  59
  60 Custom Cylinder
  61 ---------------
  62
  63 The following data are required:
  64
  65 - *origin* : origin's coordinates of the cylinder (select a vertex).
  66 - *vx*     : the base of the cylinder (select a vector).
  67 - *vz*     : the axis of the cylinder (select a vector).
  68 - *tr*     : a list of radiuses in ascendant order.
  69 - *ta*     : a list of angles in ascendant order.
  70 - *th*     : a list of heights in ascendant order.
  71
  72 Use the function **makeCylinder** to make a custom cylinder::
  73
  74         elts = doc.makeCylinder(origin, vx, vz, tr, ta, th)
  75
  76 GUI command: :ref:`guicylindercustom`
  77
  78 Operations on *elts*: :ref:`tuielements2`
  79
  80
  81 Example
  82 -------
  83
  84 .. literalinclude:: test_doc/cylinder/cylinder.py
  85    :linenos:
  86
  87
  88 .. _tuicylinders:
  89
  90 Make Cylinders
  91 ==============
  92
  93 To make **two cylinders in T shape** the following data are required for each cylinder:
  94
  95 - *orig* : the origin of the cylinder (select a vertex).
  96 - *vz*   : the axis of the cylinder (select a vector).
  97 - *rext* : the radius of the cylinder.
  98 - *h*    : the height of the cylinder.
  99
 100 *One of the two cylinders must be bigger than the other.*
 101
 102 Use the function **makeCylinders**::
 103
 104         elts = doc.makeCylinders (orig1, vz1, rext1, h1, orig2, vz2, rext2, h2)
 105
 106 GUI command: :ref:`guicylinders`
 107
 108 Operations on *elts*: :ref:`tuielements2`
 109
 110
 111 Example
 112 -------
 113
 114 .. literalinclude:: test_doc/cylinder/cylinders.py
 115    :linenos:
 116
 117
 118 .. _tuipipe:
 119
 120 Pipe
 121 ====
 122
 123 .. _tuipipesimple:
 124
 125 Simple Pipe
 126 -----------
 127
 128 To make a simple pipe grid in python mode, the following data are required:
 129
 130 - *nbR* : number of hexahedra on radial.
 131 - *nbA* : number of hexahedra along the perimeter of the pipe.
 132 - *nbH* : number of hexahedra along the axis of the pipe.
 133
 134 Use the function **makePipeTop**::
 135
 136         elts = doc.makePipeTop(nbR, nbA, nbH)
 137
 138 GUI command: :ref:`guipipesimple`
 139
 140
 141 .. _tuipipeuniform:
 142
 143 Uniform Pipe
 144 ------------
 145
 146 The following data are required:
 147
 148
 149 - *origin* : the origin's coordinates of the pipe (select a vertex).
 150 - *vx*     : the base of the pipe (select a vector).
 151 - *vz*     : the axis of the pipe (select a vector).
 152 - *rint*   : the radius of the hole in the pipe .
 153 - *rext*   : the radius of the pipe.
 154 - *angle*  : angle of the pipe around the Z axis.
 155 - *hauteur*: the height of the pipe.
 156 - *nbR*    : number of hexahedra on radial.
 157 - *nbA*    : number of hexahedra along the perimeter of the pipe.
 158 - *nbH*    : number of hexahedra along the axis of the pipe.
 159
 160 Use the function **makePipeUni** to  make a uniform pipe::
 161
 162         elts = doc.makePipeUni(origin, vx, vz, rint, rext, angle, hauteur, nbR, nbA, nbH)
 163
 164 GUI command: :ref:`guipipeuniform`
 165
 166
 167 .. _tuipipecustom:
 168
 169 Custom Pipe
 170 -----------
 171
 172 The following data are required:
 173
 174 - *origin* : origin's coordinates of the pipe (select a vertex).
 175 - *vx*     : the base of the pipe (select a vector).
 176 - *vz*     : the axis of the pipe (select a vector).
 177 - *tr*     : a list of radiuses in ascendant order.
 178 - *ta*     : a list of angles in ascendant order.
 179 - *th*     : a list of heights in ascendant order.
 180
 181 Use the function **makePipe** to make a custom pipe::
 182
 183         elts = doc.makePipe(origin, vx, vz, tr, ta, th)
 184
 185 GUI command: :ref:`guipipecustom`
 186
 187 Operations on *elts*: :ref:`tuielements2`
 188
 189
 190 Example
 191 -------
 192
 193 .. literalinclude:: test_doc/pipe/pipe.py
 194    :linenos:
 195
 196
 197
 198 .. _tuipipes:
 199
 200 Make Pipes
 201 ==========
 202
 203 To make **two pipes in T shape** the following data are required for each pipe:
 204
 205 - *orig* : the origin of the pipe (select a vertex).
 206 - *vz*   : the axis of the pipe (select a vector).
 207 - *rint* : the internal radius of the pipe.
 208 - *rext* : the radius of the pipe.
 209 - *h*    : the height of the pipe.
 210
 211 *One of the two pipes must be bigger than the other.*
 212
 213 Use the function **makepipes**::
 214
 215         elts = doc.makePipes(orig1, vz1, rint1, rext1, h1, orig2, vz2, rint2, rext2, h2)
 216
 217 GUI command: :ref:`guipipes`
 218
 219 Operations on *elts*: :ref:`tuielements2`
 220
 221
 222 Example
 223 -------
 224
 225 .. literalinclude:: test_doc/pipe/pipes.py
 226    :linenos: