Mantis issue 0021703: [CEA 577] Boolean operations on groups.

[modules/geom.git] / doc / salome / gui / GEOM / input / creating_dividedcylinder.doc

diff --git a/doc/salome/gui/GEOM/input/creating_dividedcylinder.doc b/doc/salome/gui/GEOM/input/creating_dividedcylinder.doc
index e0d7f08456b8cec75a7a2e5dfc34497beab4ddb7..169666a390136a36b7d7f23e6e31b47e996bcc31 100644 (file)
--- a/doc/salome/gui/GEOM/input/creating_dividedcylinder.doc
+++ b/doc/salome/gui/GEOM/input/creating_dividedcylinder.doc
@@ -2,6 +2,15 @@
 
 \page create_dividedcylinder_page DividedCylinder
 
+The <b>Divided cylinder</b> object is a cylinder divided into \b blocks for easy hexaedral meshing.Two division patterns are available :
+
+<ul>
+<li> A square pattern which is frequently used </li>
+<li> An hexagonal pattern which ensures a better mesh quality and especially less acute or obtuse angles </li>
+</ul>
+
+\image html dividedcylinder.png
+
 To create a \b DividedCylinder in the <b>Main Menu</b> select <b>New Entity - >
 Advanced - > DividedCylinder </b>
 
@@ -9,18 +18,15 @@ Specify the parameters of the DividedCylinder object creation in the opened dial
 box and press "Apply" or "Apply & Close" button.
 Result of each operation will be a GEOM_Object.
 
-<b>TUI Command:</b> <em>geompy.MakeDividedCylinder(R, H)</em>
+<b>TUI Command:</b> <em>geompy.MakeDividedCylinder(R, H, Pattern)</em>
 
 <b>Arguments:</b>
 - \b R - Radius of the cylinder
 - \b H - Height of the cylinder
+- \b Pattern - Division pattern
 
 \image html dividedcylinder_dlg.png
 
-Example:
-
-\image html dividedcylinder.png
-
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_dividedcylinder "Advanced objects".