X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcreating_pipetshape.doc;h=3ca9baac7dd622e7e3aaeca25705c077a1df94af;hb=97d9c2c6b1eb1b8c37b74e9409ebdb89c42c8c27;hp=44124f52eadee7cd3fef650b953a6ed99cd5190f;hpb=4ab178242861f911fded8a5e8f16b209682f30a1;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/creating_pipetshape.doc b/doc/salome/gui/GEOM/input/creating_pipetshape.doc
index 44124f52e..3ca9baac7 100644
--- a/doc/salome/gui/GEOM/input/creating_pipetshape.doc
+++ b/doc/salome/gui/GEOM/input/creating_pipetshape.doc
@@ -4,75 +4,83 @@
To create a \b PipeTShape in the Main Menu select New Entity -> Primitives -> PipeTShape
-Specify the parameters of the PipeTShape object in the opened dialog
-box and press "Apply" or "Apply & Close" button.
-The result of the operation will be a GEOM_Object.
+The dialog for definition of PipeTShape parameters and options is split into three tabs.
\n Main parameters:
-\image html pipetshape_dlg.png
+\image html pipetshape1.png
-\n Position parameters:
+
+- Main pipe - 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.
+- Incident pipe - 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.
+- \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.
+- \b Fillet - allows creating a fillet at the junction of the main and the incident pipes by defining the fillet \b Radius.
+- \b HexMesh - checkbox allows splitting the shape into blocks suitable for hexahedral mesh.
+
-\image html pipetshape_pos_dlg.png
+\image html pipetshape2.png
-\n Advanced options \ref preview_anchor "Preview"
+\n Thickness reduction
-TUI Command: geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None)
+\image html pipetshape3.png
-Arguments:
-- \b R1 - Radius of the main T-shape pipe.
-- \b W1 - Thickness of the main T-shape pipe.
-- \b L1 - Length of the main T-shape pipe.
-- \b R2 - Radius of the incident T-shape pipe.
-- \b W2 - Thickness of the incident T-shape pipe.
-- \b L2 - Length of the incident T-shape pipe.
-- \b HexMesh - If True, the shape is splitted into blocks (suitable for hexaedral mesh).
+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:
-Position arguments:
-- \b P1 - First junction point of the main pipe (GEOM Vertex).
-- \b P2 - Second junction point of the main pipe (GEOM Vertex).
-- \b P3 - Junction point of the incident pipe (GEOM Vertex).
-
-Example:
-
-\image html pipetshape.png
+
+- \b Radius - is the radius of the reduced pipe.
+- \b Width - is the width of the reduced pipe.
+- Transition length - is the length of transition between the pipe and the reduced pipe.
+- Thin part length is the length of the reduced pipe.
+
-A Pipe T-Shape can be created with a chamfer at the junction of the main and the incident pipes:
+\image html pipetshape4.png
-TUI Command: geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None)
+\n Position
-The arguments are the same as of the normal Pipe T-Shape plus:
-- \b H - Height of the chamfer along the incident pipe.
-- \b W - Width of the chamfer along the main pipe.
+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.
-Example:
+\image html pipetshape5.png
-\image html pipetshapechamfer.png
+
+- Junction P1 and Junction P2 - are the end points of the main pipe (lying on its central axis).
+- Junction P3 - is the end point of the incident pipe.
-A Pipe T-Shape can be created with a fillet at the junction of the main and the incident pipes:
+\n The New L1 and New L2 values are calculated automatically, but should be confirmed by clicking the corresponding "Arrow" button.
+- New L1 - is the \b Half-length of the main pipe.
+- New L2 - is the length of the incident pipe.
+The \b Radius and \b Width of pipes are taken from the Main parameters tab.
+
-TUI Command: geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None)
+Advanced options: \ref preview_anchor "Preview" - displays the resulting shape in the viewer before \b Apply command.
-The arguments are the same as of the normal Pipe T-Shape plus:
-- \b RF - Radius of the fillet.
+Specify the parameters of the PipeTShape object in the opened dialog box and press "Apply" or "Apply & Close" button.
+The result of the operation will be a GEOM_Object.
-Example:
+\n TUI Commands:
-\image html pipetshapefillet.png
+There are three different TUI commands for PipeTShape creation:
-All three types of T-Shape (basic, with chamfer and with fillet) can
-have thickness reductions at its open ends (two ends of the main pipe
-and one end of the incident pipe):
+
+- geompy.MakePipeTShape - creates a standard PipeTShape.
+- geompy.MakePipeTShapeChamfer - creates a PipeTShape with a chamfer at the junction.
+- geompy.MakePipeTShapeFillet - creates a PipeTShape with a fillet at the junction.
+
-\image html pipetshape_thr_dlg.png
-TUI Commands:
-\ngeompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0)
-\ngeompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0)
-\ngeompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0)
-
-The additional arguments are:
+The following arguments can be used with these commands:
+- \b R1 - Radius of the main pipe.
+- \b W1 - Thickness of the main pipe.
+- \b L1 - Length of the main pipe.
+- \b R2 - Radius of the incident pipe.
+- \b W2 - Thickness of the incident pipe.
+- \b L2 - Length of the incident pipe.
+- \b HexMesh - If True, the shape is split into blocks (suitable for hexahedral mesh).
+- \b P1 - First junction point of the main pipe (GEOM Vertex).
+- \b P2 - Second junction point of the main pipe (GEOM Vertex).
+- \b P3 - Junction point of the incident pipe (GEOM Vertex).
+- \b H - Height of the chamfer along the incident pipe (used only with geompy.MakePipeTShapeChamfer command).
+- \b W - Width of the chamfer along the main pipe (used only with geompy.MakePipeTShapeChamfer command).
+- \b RF - Radius of the fillet (used only with geompy.MakePipeTShapeFillet command).
- \b theRL - Internal radius of left thickness reduction.
- \b theWL - Width of left thickness reduction.
- \b theLtransL - Length of left transition part.
@@ -86,9 +94,6 @@ and one end of the incident pipe):
- \b theLtransI - Length of incident transition part.
- \b theLthinI - Length of incident thin part.
-Example:
-
-\image html pipetshapethr.png
Our TUI Scripts provide you with useful examples of creation of
\ref tui_creation_pipetshape "Advanced objects".