Salome HOME
IMP: SMESH/Yams plug-in: Update to use Meshgems-SurfOpt 1.1 (new name of Yams)
[modules/smesh.git] / src / Tools / YamsPlug / doc / Mandatory_params.rst
1 Simple Remeshing Options
2 =========================
3
4 simple case 
5 -----------
6
7    All options, but the input mesh, have default values. however, **you have to specified these
8    simple options in order to drive yams and control remeshing parameters**. 
9
10    You can access Distene documentation by clicking on Help button.
11
12
13 .. image:: images/Simple.png
14    :align: center
15
16
17 - **Original Mesh**
18
19    You have to select a Mesh Object from Salome Object Browser or choose a .GMF file.
20
21
22 Optimisation
23 ------------
24     
25 This is the main remeshing Option.  Yams always does quality improvement. It is done by point smooting and edge swapping.  It can produce a regular mesh for finite element computation (initial mesh is a a geometrical mesh). In this case, the given surface trianglation is modified in accordance to a size map : an intrinsic size map is computed automatically. it is based on the surface proporties.  Yams is also able to  produce a geometrical mesh (initial mesh is a a mesh for finite element computation). In both case, It can coarsen or enrich the mesh.     
26
27    - **Quality improvement** 
28
29      If you activitate this option, Yams does only quality improvement.  
30
31      It is equivalent to Yams's batch option 0.
32
33    - **Pure Geometry Enrichement**
34
35      The given surface triangulation is enriched (no coarsening at all) in such away that the distance between the elements in the final mesh and those of the initial one is bounded by auser specified tolerance value. One should use this option, to enrich the mesh where purely geometrical features may be insuficiently fine, i.e. the resulting mesh will be least as fine as the input. Mesh and the geometric features will be refined if needed as specified by the other program parameters. The meshes obtained with those settings may not be suitable for computation.
36
37      It is equivalent to Yams's batch option G.
38
39    -  **Uniform subdivision**
40
41      A uniform subdivision of the given surface triangulation is performed : each triangle of the given surface triangulation is considered at and is divided into identical triangles.
42
43      It is equivalent to Yams's batch option U.
44
45    - **Smoothing**
46
47      A surface sandpapering without shrinkage of the given surface triangulation is performed, i.e., the high curvature variations of the given surface will be smoothed out without shrinking the volume in doing so. If ridges are defined, they will be kept as they are in the resulting mesh. It could modify the geometry.
48      It is equivalent to Yams's batch option S.
49
50    - **Geometrical Mesh : Coarsening** 
51
52      The given surface triangulation is modified in such a way that the distance between the elements in the final mesh and those of the initial one is bounded by a user specfied tolerance value.One should use this option, to coarsen when a purely geometrical mesh is needed. (a mesh that keeps and obeys its geometric features only.) The meshes obtained with this option are usually not suitable for computation because anisotropic elements may be generated
53
54      It is equivalent to Yams's batch option -2.
55
56    - **Geometrical Mesh : Coarsening and Enrichment** 
57
58      Yams coarses and enrichs meshes to obtain a purely geometrical mesh. The method is the same as above.
59
60      It is equivalent to Yams's batch option 2.
61
62    - **Mesh for finite element computation : Coarsening** 
63
64      The given surface triangulation is modified in accordance to a size map. The latter is the intrinsic size map (computed automatically and based on the surface properties, i.e. the local curvatures). One should use this option to coarsen  the mesh, when a regular mesh  for computation purposes is desired, i.e. a mesh with good aspect ratios or good quality elements.
65
66      It is equivalent to Yams's batch option -1.
67
68    - **Mesh for finite element computation : Coarsening and Enrichment**
69
70      One should use this option to coarsen  and enrich the mesh, when a regular mesh for computation purposes is desired, i.e. a mesh with good aspect ratios or good quality elements. The method is the same as above.
71
72      It is equivalent to Yams's batch option 1.
73    
74
75 Units parameter
76 ---------------
77
78 It indicates what reference is used for the values corresponding to size or distance specifications:
79 If the Units parameter is absolute, values are relative to the bounding box,otherwise the tolerance parameter is expressed in model units. The bounding box size is defined as the length of the diagonal (lower left back icorner to upper right front corner).
80
81
82
83 Chordal deviation tolerance parameter
84 -------------------------------------
85
86 This field enables the user to bound the maximal chordal deviation allowed, that is, the maximal distance allowed between the detected curve and the plane of the corresponding mesh face. It avoids having faces too far away from the curve they represent.
87
88 .. image:: images/Tolerance.png
89    :align: center
90
91
92 This parameter enables the user to specify the maximal chordal deviation epsilon max.
93
94 it can be :
95   - relative : the maximal chordal deviation - epsilon max -is set to 0.001 x the parameter. by default, the parameter is set to 0.1 and the maximum deviation is also 0.1 x 1/1000 * the size of the bounding box,  which is equivalent to say that, for a bouding box of 1 meter, the maximal deviation is 0.1 mm.
96   - absolute : the maximal chordal deviation is the parameter itself. eg if the parameter equals 2, the maximal chordal deviation will be 2 (mm if the point coordonates are given in mm).
97
98 Following that criterion:
99   - if the chordal deviation epsilon is smaller than epsilon max, it is acceptable to remove the considered point.
100   - if the chordal deviation epsilon is greater than epsilon max, the considered mesh face should be redifined by adding a point on the curve.
101