Salome HOME
Merge remote branch 'origin/V8_5_asterstudy'
[modules/smesh.git] / doc / salome / gui / SMESH / input / index.rst
1 .. SMESH documentation master file, created by
2    sphinx-quickstart on Tue Nov 21 15:18:10 2017.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 ***************************
7 Introduction to Mesh module
8 ***************************
9
10 .. image:: ../images/a-viewgeneral.png
11         :align: center
12
13 **Mesh** module of SALOME is destined for:
14
15 * :ref:`creating meshes <about_meshes_page>` in different ways:
16
17   * by meshing geometrical models previously created or imported by the Geometry component; 
18   * bottom-up, using :ref:`mesh edition <modifying_meshes_page>`, especially :ref:`extrusion <extrusion_page>` and :ref:`revolution <revolution_page>`;
19   * by generation of the 3D mesh from the 2D mesh not based on the geometry (:ref:`imported <importing_exporting_meshes_page>` for example); 
20  
21 * :ref:`importing and exporting meshes <importing_exporting_meshes_page>` in various formats;
22 * :ref:`modifying meshes <modifying_meshes_page>` with a vast array of dedicated operations; 
23 * :ref:`creating groups <grouping_elements_page>` of mesh elements;
24 * filtering mesh entities (nodes or elements) using :ref:`Filters <filters_page>` functionality for :ref:`creating groups <grouping_elements_page>` and applying :ref:`mesh modifications <modifying_meshes_page>`;
25 * :ref:`viewing meshes <viewing_meshes_overview_page>` in the VTK viewer and :ref:`getting info <mesh_infos_page>` on mesh and its sub-objects;
26 * applying to meshes :ref:`Quality Controls <quality_page>`, allowing to highlight important elements;
27 * taking various :ref:`measurements <measurements_page>` of the mesh objects.
28
29 There is a set of :ref:`tools <tools_page>` plugged-in the module to extend the basic functionality listed above.
30
31 Almost all mesh module functionalities are accessible via :ref:`smeshpy_interface_page`.
32
33 It is possible to use the variables predefined in :ref:`Salome notebook <using_notebook_mesh_page>` to set parameters of operations.
34
35 Mesh module preferences are described in the :ref:`mesh_preferences_page` section of SALOME Mesh Help.
36
37 .. image:: ../images/image7.jpg
38         :align: center 
39
40 .. centered::
41         Example of MESH module usage for engineering tasks
42
43
44 **Table of Contents**
45
46 .. toctree::
47    :titlesonly:
48    :maxdepth: 3
49
50    about_meshes
51    modifying_meshes
52    grouping_elements
53    about_filters
54    about_quality_controls
55    measurements
56    viewing_meshes_overview
57    smeshpy_interface
58    tools        
59    mesh_preferences
60    using_notebook_smesh_page