Salome HOME
Update BLSURFPLUGIN and GHS3DPLUGIN documentations
[modules/smesh.git] / doc / salome / gui / SMESH / input / tui_defining_ghs3d_hypotheses.doc
index 0146e81e3ff7aa0e26fdc24e5b7852a983c65f21..5d9dff78c866be151b8359f23555df521be92068 100644 (file)
@@ -3,6 +3,14 @@
 \page tui_defining_ghs3d_hypotheses_page Defining Hypotheses for Ghs3D Algorithm
 
 \anchor tui_ghs3d
+
+<ol>
+<li>\ref tui_ghs3d_basic "Construction of Mesh using Ghs3D algorithm"</li>
+<li>\ref tui_ghs3d_enforced_vertices "Adding enforced vertices"</li>
+<li>\ref tui_ghs3d_enforced_meshes "Adding enforced mesh"</li>
+</ol>
+
+\anchor tui_ghs3d_basic
 <h2>Construction of Mesh using Ghs3D algorithm</h2>
 
 \code
@@ -30,6 +38,9 @@ ghs3dMesh.Compute()
 
 \image html ghs3d_screenshot.png Ghs3d mesh withtout hypothesis
 
+\ref tui_ghs3d "Back to top"
+
+\anchor tui_ghs3d_enforced_vertices
 <h2>Adding enforced vertices</h2>
 
 \code
@@ -38,11 +49,11 @@ ghs3dMesh.Compute()
 # - the coordinates x,y,z
 # - a GEOM vertex or compound (No geometry, TUI only)
 #
-# The enforced nodes created can also be stored in
+# The created enforced nodes can also be stored in
 # a group (No geometry, TUI only).
 
-# Ex1: Add 1 enforced vertices by coords at (50,50,100) 
-#      with a physical size of 2
+# Ex1: Add one enforced vertex with coordinates (50,50,100) 
+#      and physical size 2.
 
 import geompy
 import smesh
@@ -73,10 +84,10 @@ GHS3D_Parameters.SetEnforcedVertex( 50, 50, 100, 2) # no group
 ghs3dMesh.Compute()
 
 
-# Ex2: Add 1 enforced vertices by GEOM vertex at (50,50,100) 
-#      with a physical size of 5 and add it to a group called "My special nodes"
+# Ex2: Add one vertex enforced by a GEOM vertex at (50,50,100) 
+#      with physical size 5 and add it to a group called "My special nodes"
 
-# Create another GHS3D hypothesis and assign it to the mesh wo geometry
+# Create another GHS3D hypothesis and assign it to the mesh without geometry
 GHS3D_Parameters_wo_geometry = smesh.CreateHypothesis('GHS3D_Parameters', 'GHS3DEngine')
 ghs3dMesh_wo_geometry.AddHypothesis( GHS3D )
 ghs3dMesh_wo_geometry.AddHypothesis( GHS3D_Parameters_wo_geometry )
@@ -100,12 +111,15 @@ GHS3D_Parameters.ClearEnforcedVertices()
 \image html ghs3d_screenshot_enf1.png Ghs3d mesh with enforced vertex
 \image html ghs3d_screenshot_enf2.png Ghs3d mesh with enforced vertex from GEOM vertex
 
+\ref tui_ghs3d "Back to top"
+
+\anchor tui_ghs3d_enforced_meshes
 <h2>Adding enforced mesh</h2>
 
 \code
 
-# It is possible to constraint GHS3D with another mesh or group.
-# The constraint can be the nodes, edges or faces.
+# It is possible to constrain GHS3D with another mesh or group.
+# The constraint can refer to the nodes, edges or faces.
 # This feature is available only in TUI, on meshes without geometry.
 # The constraining elements are called enforced elements for the mesh.
 # They can be recovered using groups if necessary.
@@ -133,7 +147,7 @@ geompy.addToStudy( p1, "p1" )
 geompy.addToStudy( p2, "p2" )
 geompy.addToStudy( c, "c" )
 
-# Create the 2D algo and hypothesis
+# Create the 2D algorithm and hypothesis
 BLSURF = smesh.CreateHypothesis('BLSURF', 'BLSURFEngine')
 # For the box
 BLSURF_Parameters = smesh.CreateHypothesis('BLSURF_Parameters', 'BLSURFEngine')
@@ -143,7 +157,7 @@ BLSURF_Parameters.SetPhySize( 200 )
 BLSURF_Parameters2 = smesh.CreateHypothesis('BLSURF_Parameters', 'BLSURFEngine')
 BLSURF_Parameters2.SetGeometricMesh( 1 )
 
-# Create the 3D algo and hypothesis
+# Create the 3D algorithm and hypothesis
 GHS3D = smesh.CreateHypothesis('GHS3D_3D', 'GHS3DEngine')
 GHS3D_Parameters_node = smesh.CreateHypothesis('GHS3D_Parameters', 'GHS3DEngine')
 #GHS3D_Parameters_node.SetToMeshHoles( 1 )
@@ -156,40 +170,40 @@ GHS3D_Parameters_mesh.SetToMeshHoles( 1 ) # to mesh inside the cylinder
 
 # Create the mesh on the cylinder
 Mesh_cylindre = smesh.Mesh(cylindre)
-SetName(Mesh_cylindre,"Mesh_cylindre")
+smesh.SetName(Mesh_cylindre,"Mesh_cylindre")
 Mesh_cylindre.AddHypothesis( BLSURF )
 Mesh_cylindre.AddHypothesis( BLSURF_Parameters2 )
 # Create some groups
 face_cyl_faces = Mesh_cylindre.GroupOnGeom(face_cyl,'group_face_cyl', smesh.FACE)
 face_cyl_edges = Mesh_cylindre.GroupOnGeom(face_cyl,'group_edge_cyl', smesh.EDGE)
 face_cyl_nodes = Mesh_cylindre.GroupOnGeom(face_cyl,'group_node_cyl', smesh.NODE)
-Mesh_cyl_tri.Compute()
+Mesh_cylindre.Compute()
 
 # Create the mesh on the cylinder
 Mesh_box_tri = smesh.Mesh(box)
-SetName(Mesh_box_tri,"Mesh_box_tri")
+smesh.SetName(Mesh_box_tri,"Mesh_box_tri")
 Mesh_box_tri.AddHypothesis( BLSURF )
 Mesh_box_tri.AddHypothesis( BLSURF_Parameters )
 Mesh_box_tri.Compute()
 
 # Create 4 copies of the 2D mesh to test the 3 types of contraints (NODE, EDGE, FACE)
-# from a whole mesh and from groups of elements.
+# from the whole mesh and from groups of elements.
 # Then the 3D algo and hypothesis are assigned to them.
 
 mesh_mesh = smesh.CopyMesh( Mesh_box_tri, 'Enforced by faces of mesh', 0, 0)
-mesh_mesh.AddHypothesis( GHS3D_3D )
+mesh_mesh.AddHypothesis( GHS3D )
 mesh_mesh.AddHypothesis( GHS3D_Parameters_mesh)
 
 mesh_node = smesh.CopyMesh( Mesh_box_tri, 'Enforced by group of nodes', 0, 0)
-mesh_node.AddHypothesis( GHS3D_3D )
+mesh_node.AddHypothesis( GHS3D )
 mesh_node.AddHypothesis( GHS3D_Parameters_node)
 
 mesh_edge = smesh.CopyMesh( Mesh_box_tri, 'Enforced by group of edges', 0, 0)
-mesh_edge.AddHypothesis( GHS3D_3D )
+mesh_edge.AddHypothesis( GHS3D )
 mesh_edge.AddHypothesis( GHS3D_Parameters_edge)
 
 mesh_face = smesh.CopyMesh( Mesh_box_tri, 'Enforced by group of faces', 0, 0)
-mesh_face.AddHypothesis( GHS3D_3D )
+mesh_face.AddHypothesis( GHS3D )
 mesh_face.AddHypothesis( GHS3D_Parameters_face)
 
 # Add the enforced elements
@@ -213,4 +227,6 @@ mesh_mesh.Compute()
 \image html ghs3d_screenshot_enf5.png
 \image html ghs3d_screenshot_enf6.png
 
-*/
\ No newline at end of file
+\ref tui_ghs3d "Back to top"
+
+*/