From: prascle <prascle>
Date: Thu, 12 May 2011 14:06:02 +0000 (+0000)
Subject: PR: missing documentation
X-Git-Tag: V6_3_0b2~15
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=97f942863fd308102e433ad70516b93045ec55b7;p=modules%2Fsmesh.git

PR: missing documentation
---

diff --git a/doc/salome/gui/SMESH/images/meshcut_plugin.png b/doc/salome/gui/SMESH/images/meshcut_plugin.png
new file mode 100644
index 000000000..305e920d0
Binary files /dev/null and b/doc/salome/gui/SMESH/images/meshcut_plugin.png differ
diff --git a/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc b/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc
new file mode 100644
index 000000000..d08914498
--- /dev/null
+++ b/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc
@@ -0,0 +1,55 @@
+/*!
+
+\page cut_mesh_by_plane_page Cut a tetrahedron mesh by a plane
+
+\n MeshCut works only on Med files and produces Med files, and is a standalone program.
+It can be used either directly on a shell command outside SALOME, or with a GUI interface in SMESH,
+provided in a python plugin that needs to be installed in your SALOME application.
+
+\n MeshCut allows to cut a mesh constituted of linear tetrahedrons by a plane.
+\n The tetrahedrons intersected by the plane are cut and replaced by elements of various types,
+(tetrahedron, pyramid, pentahedron).
+
+<br>
+\anchor meshcut_standalone
+<h2>Using MeshCut as a standalone program, outside SALOME</h2>
+
+\n MeshCut is a standalone program, reading and producing med files.                
+\n                 
+\n Syntax:
+\code
+MeshCut input.med output.med resuMeshName aboveGroup belowGroup nx ny nz px py pz T
+\endcode
+
+\n                 
+\n where:
+\n  input.med    = name of the original mesh file in med format
+\n  output.med   = name of the result mesh file in med format
+\n  resuMeshName = name of the result mesh
+\n  aboveGroup   = name of the group of volumes above the cut plane
+\n  belowGroups  = name of the group of volumes below the cut plane
+\n  nx ny nz     = vector normal to the cut plane
+\n  px py pz     = a point of the cut plane
+\n  T            = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to
+\n                 the cut plane if their distance to the plane is inferior to L*T
+\n                 where L is the mean edge size of the tetrahedron
+
+<br>
+\anchor meshcut_plugin
+<h2>Using MeshCut inside SALOME</h2>
+
+When the MeshCut plugin is installed, you will find it in the Mesh menu, sub-menu SMESH_plugins.
+\n If the plugin is not installed, look for a file named meshcut_plugin.py in your SMESH installation.
+The file is normally in the subdirectory bin/salome/meshcut_plugin.py.
+
+\n If you already have plugins defined in a smesh_plugins.py file, add this file at the end.
+ if not, copy this file as ${HOME}/Plugins/smesh_plugins.py or ${APPLI}/Plugins/smesh_plugins.py
+ or in your ${PLUGINPATH} Directory.
+ 
+<li>From the Mesh menu, sub-menu SMESH_plugins, choose "MeshCut" item
+The following dialog box will appear:
+\image html meshcut_plugin.png "MeshCut Plugin dialog box"
+</li>
+
+See above for the meaning of the parameters. 
+*/
diff --git a/doc/salome/gui/SMESH/input/modifying_meshes.doc b/doc/salome/gui/SMESH/input/modifying_meshes.doc
index 78faaac4b..6a8801f3e 100644
--- a/doc/salome/gui/SMESH/input/modifying_meshes.doc
+++ b/doc/salome/gui/SMESH/input/modifying_meshes.doc
@@ -49,6 +49,7 @@ of the selected node or edge.</li>
 or vice versa.</li>
 <li>\subpage make_2dmesh_from_3d_page "Generate boundary elements".</li>
 <li>\subpage generate_flat_elements_page "Generate flat elements on group boundaries or on faces".</li>
+<li>\subpage cut_mesh_by_plane_page "Cut a tetrahedron mesh by a plane".</li>
 </ul>
 
 \note It is possible to use the variables defined in the SALOME \b NoteBook