Salome HOME
Merge branch 'spns/19079'
[modules/smesh.git] / src / Tools / TopIIVolMeshPlug / doc / TopIIVolMesh.rst
1 Introduction
2 ============
3
4 **topIIvol** meshing tool provides sequential/parallel tools for creating volumetric tetrahedral meshes from a given topology (point-cloud `*.xyz`). 
5
6 Running topIIvol Plug-in
7 ========================
8
9 **topIIVolMesh** plug-in can be invoked via SMESH Plugin item in Mesh menu bar 
10
11 .. image:: images/callTopIIVolMesh.png
12    :align: center
13
14
15 **topIIVolMesh** Options
16 ========================
17
18
19 Sequential mode
20 ---------------
21 If the number of processors is set to 1, **topIIvol_Mesher** sequential tool is called for creating volumetric tetrahedral meshes from a given topology. The volumetric mesh can be displayed in SALOME by ticking the "Display mesh" check-box.
22
23 The list of input parameters are:
24
25 - DEM input file: input point cloud file;
26 - Number of X points present in the input point cloud;
27 - Number of Y points present in the input point cloud;
28 - Number of Z points intended in the z direction;
29 - Depth of the mesh needed;
30 - temporary directory for calculation.
31
32 Parallel mode
33 ---------------
34 If the number of processors is greater than one, **topIIvol_ParMesher** parallel computing tool is called for creating volumetric tetrahedral meshes from a given topology. The volumetric mesh can be displayed in SALOME by ticking the "Display mesh" check-box.
35
36 The list of input parameters are:
37
38 - DEM input file: input point cloud file;
39 - Number of X points present in the input point cloud;
40 - Number of Y points present in the input point cloud;
41 - Number of Z points intended in the z direction;
42 - Depth of the mesh needed;
43 - Number of MPI ranks
44 - temporary directory for calculation.
45
46
47 Distributed mode
48 -----------------
49 If the check-box **Distributed** is ticked,  **topIIvol_DistMesher** computing tool is called for creating embarassingly parallel distributed meshes from a given topology.
50
51 The list of input parameters are:
52
53 - DEM input file: input point cloud file;
54 - Number of X points present in the input point cloud;
55 - Number of Y points present in the input point cloud;
56 - Number of Z points intended in the z direction;
57 - Number of partitions in X direction;
58 - Number of partitions in Y direction;
59 - Number of partitions in Z direction;
60 - Depth of the mesh needed;
61 - Number of MPI ranks
62 - temporary directory for calculation.
63