Salome HOME
Generating of documentation: add missing examples.
[modules/geom.git] / 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 - >
6 Advanced - > PipeTShape </b>
7
8 Specify the parameters of the PipeTShape object in the opened dialog
9 box and press "Apply" or "Apply & Close" button.
10 The <b>result</b> of the operation will be a <b>GEOM_Object</b>.
11
12 <b>TUI Command:</b> <em>geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None)</em>
13
14 <b>Arguments:</b>
15 - \b R1 - Radius of the main T-shape pipe.
16 - \b W1 - Thickness of the main T-shape pipe.
17 - \b L1 - Length of the main T-shape pipe.
18 - \b R2 - Radius of the incident T-shape pipe.
19 - \b W2 - Thickness of the incident T-shape pipe.
20 - \b L2 - Length of the incident T-shape pipe.
21 - \b HexMesh - If True, the shape is splitted into blocks (suitable for hexaedral mesh).
22 - \b P1 - First junction point of the main pipe (GEOM Vertex).
23 - \b P2 - Second junction point of the main pipe (GEOM Vertex).
24 - \b P3 - Junction point of the incident pipe (GEOM Vertex).
25
26 \n <b>Advanced options</b> \ref preview_anchor "Preview"
27
28 \image html pipetshape_dlg.png
29
30 Example:
31
32 \image html pipetshape.png
33
34 A Pipe T-Shape can be created with a chamfer at the junction of the main and the incident pipes:
35
36 <b>TUI Command:</b> <em>geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None)</em>
37
38 <b>The arguments are the same as of the normal Pipe T-Shape plus:</b>
39 - \b H - Height of the chamfer along the incident pipe.
40 - \b W - Width of the chamfer along the main pipe.
41
42 Example:
43
44 \image html pipetshapechamfer.png
45
46 A Pipe T-Shape can be created with a fillet at the junction of the main and the incident pipes:
47
48 <b>TUI Command:</b> <em>geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None)</em>
49
50 <b>The arguments are the same as of the normal Pipe T-Shape plus:</b>
51 - \b RF - Radius of the fillet.
52
53 Example:
54
55 \image html pipetshapefillet.png
56
57 Our <b>TUI Scripts</b> provide you with useful examples of creation of
58 \ref tui_creation_pipetshape "Advanced objects".
59
60 */