Salome HOME
Mantis issue 0021703: [CEA 577] Boolean operations on groups.
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_divideddisk.doc
index 0854039ed0839af44985510bf18c3e2f86540071..2d471e6a1840e36c735f6e2255cac66df19ec8fb 100644 (file)
@@ -2,29 +2,55 @@
 
 \page create_divideddisk_page DividedDisk
 
-The <b>Divided disk</b> object is a disk divided into \b blocks. It means that it's a shape ready to be meshed with ruled hexaedra.
-Moreover this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path operation" in order to obtain any tube shape prepared for hexaedral mesh 
-(see example below). 
+The <b>Divided disk</b> object is a disk divided into \b blocks. It means that it's a shape <b>prepared for hexaedral meshing</b>. 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>
+
+
+\n Moreover this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path" operation in order to obtain any <b>tube shape</b> prepared for hexaedral meshing 
+(see example below). (Another alternative is to create a 2D mesh on the divided disk and create a 3D mesh by extrusion in the SMESH module.)
+
 
 Example:
 
 \image html divided_disk.png
 
-To create a \b DividedDisk in the <b>Main Menu</b> select <b>New Entity - >
+To create a <b> Divided Disk </b> in the <b>Main Menu</b> select <b>New Entity - >
 Advanced - > DividedDisk </b>
 
+\n Then there are 2 ways to create a <b> Divided Disk</b> in 3D space. 
+\n For both operations : 
 Specify the parameters of the DividedDisk object creation in the opened dialog
 box and press "Apply" or "Apply & Close" button.
-Result of each operation will be a GEOM_Object.
+The result of each operation will be a GEOM_Object.
+
+\n First way : by radius and orientation (plane "OXY", "OYZ" or "OZX"). The resulting disk is located at the origin of coordinates
 
-<b>TUI Command:</b> <em>geompy.MakeDividedDisk(R, Orientation)</em>
+<b>TUI Command:</b> <em>geompy.MakeDividedDisk(Radius, Orientation, Pattern)</em>
 
 <b>Arguments:</b>
-- \b R - Radius of the disk
+- \b Radius - Radius of the disk
 - \b Orientation - Plane on wich the disk will be built
+- \b Pattern - Division pattern
 
 \image html divided_disk_dlg.png
 
+\n Second way : by giving its center, normal and radius.
+
+<b>TUI Command:</b> <em>geompy.MakeDividedDiskPntVecR(Center, Vector,
+Radius, Pattern)</em>
+
+<b>Arguments:</b>
+- \b Center - Center of the disk
+- \b Vector - Normal to the plane of the disk
+- \b Radius - Radius of the disk
+- \b Pattern - Division pattern
+
+\image html divided_disk_PntVecR_dlg.png
+
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_divideddisk "Advanced objects".