From: nge <nge>
Date: Thu, 8 Oct 2009 16:01:26 +0000 (+0000)
Subject: Update documentation for enforced vertices in GHS3DPLUGIN (continue)
X-Git-Tag: V5_1_3rc1~8
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=62e4831c741da669404e9051e406e53875a3033f;p=modules%2Fsmesh.git

Update documentation for enforced vertices in GHS3DPLUGIN (continue)
---

diff --git a/doc/salome/gui/SMESH/images/ghs3d_enforced_vertices_screenshot.png b/doc/salome/gui/SMESH/images/ghs3d_enforced_vertices_screenshot.png
new file mode 100644
index 000000000..fc885700f
Binary files /dev/null and b/doc/salome/gui/SMESH/images/ghs3d_enforced_vertices_screenshot.png differ
diff --git a/doc/salome/gui/SMESH/input/ghs3d_hypo.doc b/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
index ace242baf..06fcf9318 100644
--- a/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
+++ b/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
@@ -93,4 +93,20 @@ for ghs3d. This allows the input of advanced options in a free from. </li>
 
 </ul>
 
+
+<h1>Enforced vertices</h1>
+
+\image html ghs3d_enforced_vertices.png
+
+GHS3D algorithm can locally raffine the mesh. It is possible to define enforced vertices in the volume where the mesh will be raffined. A node will be created at the enforced vertex coordinates. There is no need to create a vertex in the CAD.
+
+An enforced vertex is defines by:
+<ul>
+<li>The (x,y,z) cartesian coordinates</li>
+<li>A constant physical size</li>
+</ul>
+
+<br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices.
+
+
 */
\ No newline at end of file
diff --git a/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc b/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc
new file mode 100644
index 000000000..b014845bb
--- /dev/null
+++ b/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc
@@ -0,0 +1,45 @@
+/*!
+
+\page tui_defining_ghs3d_hypotheses_page Defining Hypotheses for Ghs3D Algorithm
+
+\anchor tui_ghs3d
+<h2>Construction of Mesh using Ghs3D algorithm</h2>
+
+\code
+import geompy
+import smesh
+import BLSURFPlugin
+import GHS3DPlugin
+
+# create a box
+box = geompy.MakeBoxDXDYDZ(200., 200., 200.)
+geompy.addToStudy(box, "box")
+
+# create a mesh on the box
+ghs3dMesh = smesh.Mesh(box,"box: Ghs3D and BLSurf mesh")
+
+# create a BLSurf algorithm for faces
+BLSURF = ghs3dMesh.Triangle(algo=smesh.BLSURF)
+
+# create a Ghs3D algorithm for volume
+GHS3D = Mesh_1.Tetrahedron(algo=smesh.GHS3D)
+
+# get Ghs3D algorithm hypothesis
+GHS3D_Parameters = GHS3D.Parameters())
+
+# define an enforced vertex at (50,50,100) with a physical size of 2
+GHS3D_Parameters.SetEnforcedVertex( 50, 50, 100, 2 )
+
+# define an enforced vertex at (150,150,100) with a physical size of 5
+GHS3D_Parameters.SetEnforcedVertex( 150, 150, 100, 5 )
+
+# compute the mesh
+ghs3dMesh.Compute()
+
+# End of script
+
+\endcode
+
+\image html ghs3d_enforced_vertices_screenshot.png
+
+*/
\ No newline at end of file