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