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 / Advanced_params.rst
index 3c83be1d65de67c99787105b99eacb96bc2b9874..f76a749ddb2714847eecf2eadec1d0f98ca4c27d 100644 (file)
@@ -4,11 +4,11 @@ Advanced Remeshing Options
 ** be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when yams compute a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. read DISTENE documentation **
 
   - **Ridge detection**
-if not set (ridge detection disabled ), Yams will not try to detect any new ridge edge by its own mechanism : 
+if not set (ridge detection disabled ), MeshGems-SurfOpt will not try to detect any new ridge edge by its own mechanism : 
 it will consider as ridge only the ridges given in the mesh.  All non-ridge edges that would have been detected as ridge by the Ridge angle paramaeter (see below split edge)  will be considered as part of the same continuous patch.  This option should not be checked when all the known ridges of the mesh are given and when all other possible ridges are not geometric ridges to take into account.
 
   - **Point smoothing**
-When not set (point smoothing is disabled), Yams will not try to move the initial given vertices (along an edge, a ridge or onto the surface), hence Yams will only swap edges, remove vertices or add vertices (refines) to change the mesh.
+When not set (point smoothing is disabled), MeshGems-SurfOpt will not try to move the initial given vertices (along an edge, a ridge or onto the surface), hence MeshGems-SurfOpt will only swap edges, remove vertices or add vertices (refines) to change the mesh.
 
   - **Geometrical  approximation**
 this field as well as the Chordal deviation tolerance parameter,enables the user to bound the maximal chordal deviation allowed. it avoids having sharp angles. , 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.
@@ -31,12 +31,12 @@ These two parameters allow the user to prescribe a Maximal/Minimal size for the
 
 
   - **Mesh gradation**
-This paramater P controls the element size variation : Yams will avoid having two adjacent egdes which sizes vary more than th given gradation. a size correction is applied to the size map : if two adjacent edges are respectively e1 and e2 long and e2 > Pxe1, then, the new size for the second edge will be set to P x e1.
+This paramater P controls the element size variation : MeshGems-SurfOpt will avoid having two adjacent egdes which sizes vary more than th given gradation. a size correction is applied to the size map : if two adjacent edges are respectively e1 and e2 long and e2 > Pxe1, then, the new size for the second edge will be set to P x e1.
 **This procedure is desactived if P=-1***
 
 
 
   - **Split edge**
-If this option is activated, Yams creates new vertices placed on the curved surface and adds them to elements.
+If this option is activated, MeshGems-SurfOpt creates new vertices placed on the curved surface and adds them to elements.
 It may be used to obtain higher order elements.