Salome HOME
Update of CheckDone
[modules/smesh.git] / src / Tools / TopIIVolMeshPlug / doc / TopIIVolMesh.rst
1 Introduction
2 ============
3
4 **topIIvol** meshing tool provides sequential and parallel tools for creating volumetric tetrahedral meshes from a given terrain topology via digital elevation model (DEM point-cloud `*.xyz`). Via this plugin one could produce distributed meshes suitable for domain-decomposition based solvers or simply non distributed meshes (single mesh) suitable for a sequential/parallel solver.
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 Users have option of performing meshing via:
19
20 - *Sequential* mode: mesh computation in sequential and outputs a single mesh.
21 - *Parallel* mode: mesh computation in parallel and outputs a single mesh. 
22 - *Parallel distributed* mode: mesh computation in parallel and outputs partitioned meshes.
23
24 Sequential mode
25 ---------------
26 By default sequential meshing mode is activated. **topIIvol_Mesher** sequential tool is called for creating volumetric tetrahedral mesh for the given DEM point-cloud. The volumetric mesh can be displayed in SALOME by ticking the "Display mesh" check-box.
27
28 The list of input parameters are:
29
30 - DEM input file: input point cloud file in .xyz format;
31 - Number of X points present in the input point cloud;
32 - Number of Y points present in the input point cloud;
33 - Number of Z points intended in the Z direction;
34 - Depth of the mesh needed;
35 - temporary directory for calculation.
36
37 Parallel mode
38 ---------------
39 For larger meshes the parallel meshing mode can be activated via the check-box **Parallel**. Additionally, this requires the user to provide the number of processors to be used for parallel meshing. Then, **topIIvol_ParMesher** parallel computing tool is called for creating volumetric tetrahedral mesh for the given DEM point-cloud. The volumetric mesh can be displayed in SALOME by ticking the "Display mesh" check-box.
40
41 The list of input parameters are:
42
43 - DEM input file: input point cloud file in .xyz format;
44 - Number of X points present in the input point cloud;
45 - Number of Y points present in the input point cloud;
46 - Number of Z points intended in the Z direction;
47 - Depth of the mesh needed;
48 - Number of MPI ranks
49 - temporary directory for calculation.
50
51
52 Parallel distributed mode
53 -----------------
54 For larger meshes suitable for distributed-memory solvers (domain-decomposition) the distributed parallel meshing mode can be activated via the check-box **Parallel distributed**. This requires the user to provide the number of processors to be used for parallel meshing and how to partition the mesh in each direction (X, Y, Z). Then,  **topIIvol_DistMesher** computing tool is called for creating embarassingly parallel distributed meshes for the given DEM point-cloud. These volumetric mesh partitions can be displayed in SALOME by ticking the "Display mesh" check-box.
55
56 The list of input parameters are:
57
58 - DEM input file: input point cloud file in .xyz format;
59 - Number of X points present in the input point cloud;
60 - Number of Y points present in the input point cloud;
61 - Number of Z points intended in the Z direction;
62 - Depth of the mesh needed;
63 - Number of partitions in X direction;
64 - Number of partitions in Y direction;
65 - Number of partitions in Z direction;
66 - Number of MPI ranks
67 - temporary directory for calculation.
68