doc/salome/gui/GEOM/input/creating_pipetshape.doc

   1 /*!
   2
   3 \page create_pipetshape_page PipeTShape
   4
   5 To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity -> Primitives -> PipeTShape</b>
   6
   7 The dialog for definition of PipeTShape parameters and options is split into three tabs.
   8
   9 \n <b>Main parameters</b>:
  10
  11 \image html pipetshape1.png
  12
  13 <ul>
  14 <li> <b>Main pipe</b> - allows defining the internal \b Radius, the \b Thickness and the \b Half-length (the distance between the end of the main pipe and the central axis of the incident pipe; the incident pipe is always located in the middle of the main pipe) for the main pipe.</li>
  15 <li> <b>Incident pipe</b> - allows defining the internal \b Radius, the \b Thickness and the \b Length (the distance between the end of incident pipe and the central axis of the main pipe) for the incident pipe.</li>
  16 <li> \b Chamfer - allows creating a chamfer at the junction of the main and the incident pipes. Its parameters are  \b Height along the incident pipe and \b Width along the main pipe.</li>
  17 <li> \b Fillet - allows creating a fillet at the junction of the main and the incident pipes by defining the fillet \b Radius. </li>
  18 <li> \b HexMesh - checkbox allows splitting the shape into blocks suitable for hexahedral mesh.</li>
  19 </ul>
  20
  21 \image html pipetshape2.png
  22
  23 \n <b>Thickness reduction</b>
  24
  25 \image html pipetshape3.png
  26
  27 This tab allows applying, if necessary, thickness reductions at the open ends of the T-shape pipe  (two ends of the main pipe and one end of the incident pipe). For each end it is possible to define:
  28
  29 <ul>
  30 <li> \b Radius - is the radius of the reduced pipe.</li>
  31 <li> \b Width - is the width of the reduced pipe.</li>
  32 <li> <b> Transition length </b> - is the length of transition between the pipe and the reduced pipe.</li>
  33 <li> <b> Thin part length </b> is the length of the reduced pipe.</li>
  34 </ul>
  35
  36 \image html pipetshape4.png
  37
  38 \n <b>Position</b>
  39
  40 By default the PipeTShape is created at the center of coordinates and oriented by XY (main pipe) and XZ (incident pipe) axes, but it is possible to define a custom \b Position.
  41
  42 \image html pipetshape5.png
  43
  44 <ul>
  45 <li> <b>Junction P1</b> and <b>Junction P2</b>  - are the end points of the main pipe (lying on its central axis).</li>
  46 <li> <b>Junction P3</b> - is the end point of the incident pipe.</li>
  47
  48 \n The  <b>New L1</b> and  <b>New L2</b> values are calculated automatically, but should be confirmed by clicking the corresponding "Arrow" button.
  49 <li> <b> New L1 </b> - is the \b Half-length of the main pipe.</li>
  50 <li> <b> New L2 </b> - is the length of the incident pipe.</li>
  51 The \b Radius and \b Width of pipes are taken from the <b>Main parameters</b> tab.
  52 </ul>
  53
  54 <b>Advanced options:</b> \ref preview_anchor "Preview" - displays the resulting shape in the viewer before \b Apply command.
  55
  56 Specify the parameters of the PipeTShape object in the opened dialog box and press "Apply" or "Apply & Close" button.
  57 The result of the operation will be a <b>GEOM_Object</b>.
  58
  59 \n <b>TUI Commands:</b>
  60
  61 There are three different TUI commands for PipeTShape creation:
  62
  63 <ul>
  64 <li><em>geompy.MakePipeTShape</em> - creates a standard PipeTShape.</li>
  65 <li><em>geompy.MakePipeTShapeChamfer</em> - creates a PipeTShape with a chamfer at the junction.</li>
  66 <li><em>geompy.MakePipeTShapeFillet</em> - creates a PipeTShape with a fillet at the junction.</li>
  67 </ul>
  68
  69
  70 The following arguments can be used with these commands:
  71 - \b R1 - Radius of the main pipe.
  72 - \b W1 - Thickness of the main pipe.
  73 - \b L1 - Length of the main pipe.
  74 - \b R2 - Radius of the incident pipe.
  75 - \b W2 - Thickness of the incident pipe.
  76 - \b L2 - Length of the incident pipe.
  77 - \b HexMesh - If True, the shape is split into blocks (suitable for hexahedral mesh).
  78 - \b P1 - First junction point of the main pipe (GEOM Vertex).
  79 - \b P2 - Second junction point of the main pipe (GEOM Vertex).
  80 - \b P3 - Junction point of the incident pipe (GEOM Vertex).
  81 - \b H - Height of the chamfer along the incident pipe (used only with <em>geompy.MakePipeTShapeChamfer</em> command).
  82 - \b W - Width of the chamfer along the main pipe (used only with <em>geompy.MakePipeTShapeChamfer</em> command).
  83 - \b RF - Radius of the fillet (used only with <em>geompy.MakePipeTShapeFillet</em> command).
  84 - \b theRL - Internal radius of left thickness reduction.
  85 - \b theWL - Width of left thickness reduction.
  86 - \b theLtransL - Length of left transition part.
  87 - \b theLthinL - Length of left thin part.
  88 - \b theRR - Internal radius of right thickness reduction.
  89 - \b theWR - Width of right thickness reduction.
  90 - \b theLtransR - Length of right transition part.
  91 - \b theLthinR - Length of right thin part.
  92 - \b theRI - Internal radius of incident thickness reduction.
  93 - \b theWI - Width of incident thickness reduction.
  94 - \b theLtransI - Length of incident transition part.
  95 - \b theLthinI - Length of incident thin part.
  96
  97
  98 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  99 \ref tui_creation_pipetshape "Advanced objects".
 100
 101 */