doc/tui_hemisphere_rind.rst

   1 :tocdepth: 3
   2
   3 .. _tuihemisphere:
   4
   5 ============================
   6 Hemisphere Grid Construction
   7 ============================
   8
   9 .. _tuisphere:
  10
  11 Sphere
  12 ======
  13
  14 .. _tuispheresimple:
  15
  16 Simple Sphere
  17 -------------
  18
  19 To create a Simple Sphere Grid in python mode, you need the following arguments:
  20
  21 - *nbR*  : number of hexahedra on radial.
  22 - *nbA*  : number of hexahedra along the perimeter of the sphere.
  23 - *nbH*  : number of hexahedra along the axis of the sphere.
  24
  25 Use the function **makeSphereTop**::
  26
  27         elts = doc.makeSphereTop(nbR, nbA, nbH)
  28
  29 GUI command: :ref:`guisphereandrindsimple`
  30
  31
  32 .. _tuisphereuniform:
  33
  34 Uniform Sphere
  35 --------------
  36
  37 The following data are required:
  38
  39 - *center*: center coordinates of the sphere (a vertex).
  40 - *vx*    : the base of the sphere (a vector).
  41 - *vz*    : the axis of the hole (a vector).
  42 - *rtrou* : the radius of the hole in the sphere.
  43 - *rext*  : the radius of the sphere.
  44 - *angle* : angle of the sphere around the Z axis.
  45 - *vplan* : the vertex along the vertical axis where the rind will be cut.
  46 - *nr*    : number of hexahedra on radial.
  47 - *na*    : number of hexahedra along the perimeter of the sphere.
  48 - *nh*    : number of hexahedra along the axis of the sphere.
  49
  50 Use the function **makeSphereUni** to make a uniform sphere grid::
  51
  52         elts = doc.makeSphereUni (center, vx, vz, rtrou, rext, angle, vplan, nr, na, nh)
  53
  54 GUI command: :ref:`guisphereuniform`
  55
  56 .. _tuispherecustom:
  57
  58 Custom Sphere
  59 -------------
  60
  61 The following data are required:
  62
  63 - *center*: center coordinates of the sphere (a vertex).
  64 - *vx*    : the base of the sphere (a vector).
  65 - *vz*    : the axis of the sphere (a vector).
  66 - *trad*  : a list of radiuses in ascendant order.
  67 - *tang*  : a list of angles in ascendant order.
  68 - *tphi*  : a list of heights in ascendant order.
  69
  70 Use the function **makeSphere** to make a custom sphere::
  71
  72         elts = doc.makeSphere(center, vx, vz, trad, tang, tphi)
  73
  74 GUI command: :ref:`guispherecustom`
  75
  76 Operations on *elts*: :ref:`tuielements2`
  77
  78
  79 Example
  80 -------
  81
  82 .. literalinclude:: test_doc/hemisphere/sphere.py
  83    :linenos:
  84
  85
  86
  87 .. _tuirind:
  88
  89 Rind
  90 ====
  91
  92 .. _tuirindsimple:
  93
  94 Simple Rind
  95 -----------
  96
  97 To create a Simple Rind Grid in python mode, you need the following arguments:
  98
  99 - *nbR*  : number of hexahedra on radial.
 100 - *nbA*  : number of hexahedra along the perimeter of the rind.
 101 - *nbH*  : number of hexahedra along the axis of the rind.
 102
 103 Use the function **makeRindTop**::
 104
 105         elts = doc.makeRindTop(nbR, nbA, nbH)
 106
 107 GUI command: :ref:`guisphereandrindsimple`
 108
 109
 110 .. _tuirinduniform:
 111
 112 Uniform Rind
 113 ------------
 114
 115 The following data are required:
 116
 117 - *center*: center coordinates of the rind (a vertex).
 118 - *vx*    : the base of the rind (a vector).
 119 - *vz*    : the axis of the hole (a vector).
 120 - *rtrou* : the radius of the hole in the rind.
 121 - *rint*  : the internal radius.
 122 - *rext*  : the radius of the rind.
 123 - *angle* : angle of the rind around the Z axis.
 124 - *vplan* : the vertex along the vertical axis where the rind will be cut.
 125 - *nr*    : number of hexahedra on radial.
 126 - *na*    : number of hexahedra along the perimeter of the rind.
 127 - *nh*    : number of hexahedra along the axis of the rind.
 128
 129 Use the function **makeRindUni** to make a uniform rind grid::
 130
 131         elts = doc.makeRindUni(center, vx, vz, rtrou, rint, rext, angle, vplan, nr, na, nh)
 132
 133 GUI command: :ref:`guirinduniform`
 134
 135 .. _tuirindcustom:
 136
 137 Custom Rind
 138 -----------
 139
 140 The following data are required:
 141
 142 - *center*: center coordinates of the rind grid (a vertex).
 143 - *vx*    : the base of the rind grid (a vector).
 144 - *vz*    : the axis of the rind (a vector).
 145 - *trad*  : a list of radiuses in ascendant order.
 146 - *tang*  : a list of angles in ascendant order.
 147 - *tphi*  : a list of heights in ascendant order.
 148
 149 Use the function **makeRind** to make a custom rind grid::
 150
 151         elts = doc.makeRind(center, vx, vz, trad, tang, tphi)
 152
 153 GUI command: :ref:`guirindcustom`
 154
 155 Operations on *elts*: :ref:`tuielements2`
 156
 157
 158 Example
 159 -------
 160
 161 .. literalinclude:: test_doc/hemisphere/rind.py
 162    :linenos:
 163
 164
 165
 166 .. _tuiconcentric:
 167
 168 Concentric (Spherical) Grid
 169 ===========================
 170
 171 .. _tuiconcentricsimple:
 172
 173 Simple Concentric
 174 -----------------
 175
 176 To create a Simple Concentric Grid in python mode, you need the following arguments:
 177
 178 - *nbLayers*: the number of nested hexahedra.
 179 - *crit*    : the criteria.
 180
 181 Use the function **makeSphericalTop**::
 182
 183         elts = doc.makeSphericalTop(nbLayers, crit)
 184
 185 GUI command: :ref:`guiconcentricsimple`
 186
 187
 188 .. _tuiconcentricuniform:
 189
 190 Uniform Concentric
 191 ------------------
 192
 193 The following data are required:
 194
 195 - *center*  : center coordinates of the concentric.
 196 - *vx*      : the base of the concentric (a vector).
 197 - *vz*      : the axis of the concentric (a vector).
 198 - *rayon*   : the radius.
 199 - *nbLayers*: the number of nested hexahedra.
 200 - *crit*    : the criteria.
 201
 202 Use the function **makeSphericalUni** to make a uniform concentric::
 203
 204         elts = doc.makeSphericalUni(center, vx, vz, rayon, nbLayers, crit)
 205
 206 GUI command: :ref:`guiconcentricuniform`
 207
 208 .. _tuiconcentriccustom:
 209
 210 Custom Concentric
 211 -----------------
 212
 213 The following data are required:
 214
 215 - *center*  : center coordinates of the concentric.
 216 - *vx*      : the base of the concentric (a vector).
 217 - *vz*      : the axis of the concentric (a vector).
 218 - *tr*      : a list of radiuses in ascendant order.
 219 - *crit*    : the criteria.
 220
 221 Use the function **makeSpherical** to make a custom concentric grid::
 222
 223         elts = doc.makeSpherical (center, vx, vz, tr, crit)
 224
 225 GUI command: :ref:`guiconcentriccustom`
 226
 227 Operations on *elts*: :ref:`tuielements2`
 228
 229
 230 Example
 231 -------
 232
 233 .. literalinclude:: test_doc/hemisphere/concentric.py
 234    :linenos: