doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc

   1 /*!
   2
   3 \page cut_mesh_by_plane_page Cut a tetrahedron mesh by a plane
   4
   5 \n MeshCut works only on Med files and produces Med files, and is a standalone program.
   6 It can be used either directly on a shell command outside SALOME, or with a GUI interface in SMESH,
   7 provided in a python plugin that needs to be installed in your SALOME application.
   8
   9 \n MeshCut allows to cut a mesh constituted of linear tetrahedrons by a plane.
  10 \n The tetrahedrons intersected by the plane are cut and replaced by elements of various types,
  11 (tetrahedron, pyramid, pentahedron).
  12
  13 <br>
  14 \anchor meshcut_standalone
  15 <h2>Using MeshCut as a standalone program, outside SALOME</h2>
  16
  17 \n MeshCut is a standalone program, reading and producing med files.
  18 \n
  19 \n Syntax:
  20 \code
  21 MeshCut input.med output.med resuMeshName aboveGroup belowGroup nx ny nz px py pz T
  22 \endcode
  23
  24 \n
  25 \n where:
  26 \n  input.med    = name of the original mesh file in med format
  27 \n  output.med   = name of the result mesh file in med format
  28 \n  resuMeshName = name of the result mesh
  29 \n  aboveGroup   = name of the group of volumes above the cut plane
  30 \n  belowGroups  = name of the group of volumes below the cut plane
  31 \n  nx ny nz     = vector normal to the cut plane
  32 \n  px py pz     = a point of the cut plane
  33 \n  T            = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to
  34 \n                 the cut plane if their distance to the plane is inferior to L*T
  35 \n                 where L is the mean edge size of the tetrahedron
  36
  37 <br>
  38 \anchor meshcut_plugin
  39 <h2>Using MeshCut inside SALOME</h2>
  40
  41 When the MeshCut plugin is installed, you will find it in the Mesh menu, sub-menu SMESH_plugins.
  42 \n If the plugin is not installed, look for a file named meshcut_plugin.py in your SMESH installation.
  43 The file is normally in the subdirectory bin/salome/meshcut_plugin.py.
  44
  45 \n If you already have plugins defined in a smesh_plugins.py file, add this file at the end.
  46  if not, copy this file as ${HOME}/Plugins/smesh_plugins.py or ${APPLI}/Plugins/smesh_plugins.py
  47  or in your ${PLUGINPATH} Directory.
  48
  49 <li>From the Mesh menu, sub-menu SMESH_plugins, choose "MeshCut" item
  50 The following dialog box will appear:
  51 \image html meshcut_plugin.png "MeshCut Plugin dialog box"
  52 </li>
  53
  54 See above for the meaning of the parameters.
  55 */