Salome HOME
bos #29171 Refactor testing procedure
[modules/smesh.git] / doc / gui / input / cut_mesh_by_plane.rst
1 .. _cut_mesh_by_plane_page:
2
3 *********************************
4 Cut a tetrahedron mesh by a plane
5 *********************************
6
7 MeshCut works only with MED files and produces MED files, and is a standalone program. It can be used either directly from a command shell outside SALOME, or with a GUI interface in SMESH, provided in a python plugin that needs to be installed in your SALOME application.
8
9 MeshCut allows to cut a mesh constituted of linear tetrahedrons by a plane.
10 The tetrahedrons intersected by the plane are cut and replaced by elements of various types, (tetrahedron, pyramid, pentahedron).
11
12
13 .. _meshcut_standalone:
14
15 Using MeshCut as a standalone program, outside SALOME
16 #####################################################
17
18 MeshCut is a standalone program, reading and producing med files.                
19
20 Syntax::
21
22         MeshCut input.med output.med resuMeshName aboveGroup belowGroup nx ny nz px py pz T
23
24 where:
25
26 * **input.med** = name of the original mesh file in med format
27 * **output.med** = name of the result mesh file in med format 
28 * **resuMeshName** = name of the result mesh                    
29 * **aboveGroup** = name of the group of volumes above the cut plane 
30 * **belowGroups** = name of the group of volumes below the cut plane 
31 * **nx ny nz** = vector normal to the cut plane                       
32 * **px py pz** = a point of the cut plane                              
33 * **T** = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to the cut plane if their distance from the plane is inferior to L*T, where L is the mean edge size of the tetrahedron   
34
35
36 .. _meshcut_plugin:
37
38 Using MeshCut inside SALOME
39 ###########################
40
41 When the MeshCut plugin is installed, it can be found in the Mesh menu, sub-menu SMESH_plugins.
42 If the plugin is not installed, the file meshcut_plugin.py is in SMESH installation in  subdirectory 
43 *bin/salome/meshcut_plugin.py*.
44
45 If there are already plugins defined in a smesh_plugins.py file, this file should be added at the end. If not, copied as 
46 *${HOME}/Plugins/smesh_plugins.py* or *${APPLI}/Plugins/smesh_plugins.py* or in *${PLUGINPATH}* directory.
47  
48 From the Mesh menu, sub-menu SMESH_plugins, choose **"MeshCut"** item
49 The following dialog box will appear:
50
51 .. image:: ../images/meshcut_plugin.png 
52         :align: center
53
54 .. centered::
55         MeshCut Plugin dialog box
56
57 See above for the meaning of the parameters. 
58