]> SALOME platform Git repositories - plugins/blsurfplugin.git/blobdiff - doc/salome/gui/BLSURFPLUGIN/input/blsurf_hypo.doc
Salome HOME
Merge V8_3_BR branch.
[plugins/blsurfplugin.git] / doc / salome / gui / BLSURFPLUGIN / input / blsurf_hypo.doc
index 9bc028a9e148502123e7cfe691228d53f9dde338..ec7d33c7e5249a68324a7ac0001e1f645ba99f47 100644 (file)
 /*!
 
-\page blsurf_hypo_page BLSURF Parameters hypothesis
+\page blsurf_hypo_page MG-CADSurf Parameters hypothesis
 
 \anchor blsurf_top
-BLSURF Parameters hypothesis works only with \b DISTENE \b BLSurf 2d
-algorithm. This algorithm is a commercial software. To obtain a
-licence, visit http://www.distene.com/en/corp/eval-distene.html 
 
-\tableofcontents                                            
+\tableofcontents
 
 \section blsurf_general_parameters General parameters
 
 \image html blsurf_parameters.png
 
-- <b>Name</b> - allows defining the name of the hypothesis (BLSURF
+- <b>Name</b> - allows defining the name of the hypothesis (MG-CADSurf
 Parameters_n by default).
 
-- <b>Physical Mesh</b> - can be set to <em>None</em>, <em>Custom</em>
-  or <em>Size Map</em>
+- <b>Physical Size</b> group defines a \a physical sizemap.
 
-  - if set to <em>Custom</em>, allows user input in the in <b>User size</b>,
-  <b>Max Physical Size</b> and <b>Min Physical  Size</b> fields.
+- \b Type of the physical sizemap can be set to <em>None</em>, <em>Global size</em>
+  or <em>Local size</em>
 
-  - if set to <em>Size Map</em>, behaves like <em>Custom</em> mode and takes into
-  account the custom elements sizes given in the Size Map tab.
+  - if set to <em>Global size</em>, only the <b>User size</b>,
+  <b>Max Size</b> and <b>Min Size</b> fields are taken into account.
 
-- <b>User size</b> - defines the size of the generated mesh elements.
+  - if set to <em>Local size</em>, behaves like <em>Custom</em> mode and takes into
+  account the "Gradation" parameter and the custom elements sizes given in the
+  "Local size" tab.
 
-- <b>Max Physical Size</b> - defines the upper limit of mesh element size.
+- <b>Geometrical Size</b> group defines a \a geometrical sizemap.
 
-- <b>Min Physical Size</b> - defines the lower limit of mesh element size.
+- \b Type of the geometrical sizemap can be set to <em>None</em>, <em>Global size</em>
 
-- <b>Geometrical mesh</b> - if set to <em>Custom</em>, allows user input in
-<b>Angle Mesh S</b>, <b>Angle Mesh C</b> and <b>Gradation</b>
-fields. These fields control computation of the element size, so
-called <i>geometrical size</i>, conform to the surface geometry
-considering local curvatures. If both the <b>User size</b> and the
-<i>geometrical size</i> are defined, the  eventual element size
-corresponds to the least of the two.
+  - if set to <em>Global size</em>, allows user input in <b>Mesh angle</b>,
+  <b>Mesh distance</b> and <b>Gradation</b> fields. These fields control
+  computation of the element size, so called <i>geometrical size</i>, conform
+  to the surface geometry considering local curvatures. If both the <b>User size</b>
+  and the <i>geometrical parameters</i> are defined, the  eventual element size
+  corresponds to the least of the two.
 
-- <b>Angle Mesh S</b> - maximum angle between the mesh face and the
-tangent to the geometrical surface at each mesh node, in degrees.
+- <b>User size</b> - defines the size of the generated mesh elements. If "Relative value"
+is checked, the value is relative to the diagonal of the shape.
 
-- <b>Angle Mesh C</b> - maximum angle between the mesh edge and the
-tangent to the geometrical curve at each mesh node, in degrees.
+- <b>Max Size</b> - defines the upper limit of mesh element size. If "Relative value"
+is checked, the value is relative to the diagonal of the shape.
 
-- <b>Max Geometrical Size</b> - defines the upper limit of the
-  <i>geometrical size</i>.
+- <b>Min Size</b> - defines the lower limit of mesh element size. If "Relative value"
+is checked, the value is relative to the diagonal of the shape.
 
-- <b>Min Geometrical Size</b> - defines the lower limit of the
-  <i>geometrical size</i>.
+- <b>Mesh angle</b> - Limiting angle (in degree) between the plane of a triangle of the mesh and each of the tangent planes at the three vertices.
+The smaller this angle is, the closer the mesh is to the exact surface, and the denser the resulting mesh is.
 
-- <b>Gradation</b> - maximum ratio between the lengths of two adjacent
-  edges.
+- <b>Mesh distance</b> - Maximum desired distance between a triangle and its supporting CAD surface.
+The smaller this distance is, the closer the mesh is to the exact surface (only available in isotropic meshing).
 
-- <b>Allow Quadrangles</b> - if checked, allows the creation of
-  quadrilateral elements.
+- <b>Quadratic mesh</b> - if checked, quadratic elements will be generated.
 
-- <b>Patch independent</b> - if checked, geometrical edges are not
-respected and all geometrical faces are meshed as one hyper-face.
+- <b>Gradation</b> - maximum ratio between the lengths of two adjacent edges.
 
-\ref blsurf_top "Back to top"
+- <b>Mesh optimisation</b> - if checked, the mesh will be optimized in order to get better shaped elements.
 
-\section blsurf_advanced_parameters Advanced parameters
+- <b>Allow Quadrangles</b> - if checked, allows the creation of quadrilateral elements.
 
-The notion of <i>diag</i> used in the descriptions means the diagonal
-of the bounding box of the geometrical object to mesh.
-
-\image html blsurf_parameters_advanced.png
+- <b>Anisotropic</b> - if checked, this parameter defines the maximum anisotropic ratio of the metric governing the anisotropic meshing process.
+The default value (0) means that the metric (and thus the generated elements) can be arbitrarily stretched.
 
-- <b>Verbosity level</b> - defines the percentage of "verbosity" of
-BLSURF [0-100].
+- <b>Optimize tiny edges</b> - if checked, the tiny (nano) edges are
+  removed from the generated mesh during local mesh optimization. The
+  tiny edge will be removed only if the local quality is improved by
+  the deletion. The tiny edge value defines the minimal length under
+  which an edge is considered to be a tiny one.
 
-- <b>Topology</b> - allows creation of a conform mesh on a shell of
-not sewed faces. The following choices are allowed:
+- <b>Remove tiny edges</b> - if checked, the tiny (nano) edges are
+  removed from the generated mesh \a without taking into account the
+  local quality around the edge. The tiny edge value defines the
+  minimal length under which an edge is considered to be a tiny one.
 
-  - <em>"From CAD"</em> means that mesh conformity is assured by conformity
-  of a shape.
+- <b>Remove bad elements</b> - if checked, the bad elements (slivers) are removed from the generated mesh.
+The bad element value defines the aspect ratio triggering the "bad element” classification.
 
-  - <em>"Pre-process"</em> and <em>"Pre-process++"</em> allow the BLSURF software to
-  pre-process the geometrical model to eventually produce a conform
-  mesh.
+- <b>Correct surface intersections</b> - if checked, the mesher will try to prevent all surface intersections, which is useful for future volume mesh generation. The value defines the time that will be spent in the intersection prevention process. For example, the value 3 means that the time of the intersection removal process won't be more than 3 times the time required to mesh without processing the intersections.
 
-  - <em>"PreCAD"</em> is an auxiliary CAD pre-processing module which has 
-  two main goals:
+- <b>Volume Gradation</b> - maximum ratio between the lengths of two adjacent edges affecting quality of a future volume mesh, specially in thin volume areas. The volume gradation parameter must be greater than 1, and should be greater or equal to the value of the classic
+surface gradation (at the risk of increasing the time of convergence of the gradation process).
+The closer it is to 1, the smoother the final volume mesh you will build should be.
 
-    - Complete missing or inadequate CAD descriptions.
 
-    - Perform topology reconstruction and specific geometry 
-    enhancement for mesh generation.
 
-    \n This module requires a specific licence. The following PreCAD
-    options are the most significant and important ones:
+\ref blsurf_top "Back to top"
 
-    - <b>Merge Edges</b> - allows PreCAD to optimize the geometry by merging some
-    edges. This option is 0 by default.
+\section blsurf_advanced_parameters Advanced parameters
 
-    - <b>Remove nano edges</b> - allows PreCAD to optimize the geometry by removing 
-    the nano edges whenever possible. This option is 0 by default.
+The notion of <i>diag</i> used in the descriptions means the diagonal of the bounding box of the geometrical object to mesh.
 
-    - <b>Nano edge length</b> - gives the length below which an edge is considered as nano 
-    for the topology processing. See also the \b remove_nano_edges option. If unset, PreCAD
-    default value is \f$\mathrm{diag} \times 10^{-5}\f$.
+\image html blsurf_parameters_advanced.png
 
-    - <b>Discard input topology</b> - computes the CAD topology from scratch, 
-    without considering the topological information contained in the original CAD
-    (useful for iges files). This option is 0 by default.
+\b Advanced page tab expose mostly useful advanced options. Initially, default values of the options are displayed and they are not modifiable. If an option is activated using a check-box, its value becomes modifiable.
 
-- <b>ExportGMF</b> - saves the computed mesh into a GMF file (.mesh or .meshb).
+- \b Meshing options
 
-- <b>Add option</b> - provides the choice of multiple PreCAD and BLSURF 
-advanced options, which appear, if selected, in a table where it is 
-possible to input the value of the option and edit it later.
+  - <b>Enforce CAD edge sizes</b> - Relaxes the given sizemap constraint around CAD edges to allow a better
+element quality and a better geometric approximation. It is only useful in combination with the
+gradation option.
 
-- <b>Clear option</b> - removes the option selected in the table.
+  - <b>Priority of geometry over Jacobian</b> - This parameter determines whether or not the geometry accuracy
+is more important than the negative Jacobian correction. When this parameter is set to 0,
+MeshGems-CADSurf is allowed to lose the CAD-mesh associativity in order to correct the last negative Jacobians.
 
-The following BLSURF options are commonly usable:
+  - <b>Maximal number of points per patch</b> - This parameter controls the maximum amount of points MeshGems-CADSurf
+is allowed to generate on a single CAD patch. For an automatic gestion of the memory, you can set this parameter to ”0”.
 
-- \b topo_eps1 (real) - is the tolerance level inside a CAD
-patch. By default is equal to \f$\mathrm{diag} \times 10^{-4}\f$. This tolerance is used to
-identify nodes to merge within one geometrical face when \b Topology
-option is to pre-process.
+  - <b>Rectify Jacobian</b> - The quadratic elements generation is a processing of the MeshGems-CADSurf
+meshing process which inserts the extra nodes on the CAD. This parameter determines whether
+MeshGems-CADSurf will try to correct or not all the elements of the surface mesh with negative
+Jacobians by moving the internal nodes of the mesh.
 
-- \b topo_eps2 (real) - is the tolerance level between two CAD
-patches. By default is equal to \f$\mathrm{diag} \times 10^{-4}\f$. This tolerance is used to
-identify nodes to merge over different geometrical faces when
-\b Topology option is to pre-process.
+  - <b>Respect geometry</b> - This patch independent option can be deactivated to allow MeshGems-CADSurf
+to lower the geometry accuracy in its patch independent process.
 
-- \b LSS (real) - is an abbreviation for "length of sub-segment". It is
-a maximal allowed length of a mesh edge. Default is \f$0.5\f$.
+  - <b>Tiny edges avoid surface intersections</b> - This option defines the priority between the tiny feature
+suppression and the surface intersection prevention. By default, MeshGems-CADSurf gives the priority
+to the surface intersection prevention rather than to tiny edge or bad surface element removal. These
+mesh features are then removed only if it does not lead to surface intersections. This behaviour can be
+deactivated by setting this parameter to 0, giving priority to the tiny edge or bad surface element
+removal.
 
-- \b frontal (integer)
+  - <b>use deprecated patch mesher</b> - This option reproduces the mesher behaviour of previous MG-CADSurf versions
+(MeshGems before 2.3, i.e. before SALOME 8.2). This has proved useful on some particular cases such as very small 
+local size on a vertex situated on a border curve.
 
-  - 1 - the mesh generator inserts points with an advancing front method.
+- <b>CAD preprocessor</b> options. The CAD preprocessor (formerly known as PreCAD) has two main goals:
 
-  -  0 - it inserts them with an algebraic method (on internal edges). This method is
-  slightly faster but generates less regular meshes.
+  - Complete missing or inadequate CAD descriptions.
 
-  \n Default is 0.
+  - Perform topology reconstruction and specific geometry
+  enhancement for mesh generation.
 
-- \anchor blsurf_hinterpol_flag \b hinterpol_flag (integer) - determines the computation of an
-interpolated value <i>v</i> between two points <i>P1</i> and <i>P2</i> on a
-curve. Let <i>h1</i> be the value at point <i>P1,</i> <i>h2</i> be the value at point
-<i>P2,</i> and <i>t</i> be a parameter varying from 0 to 1 when moving from <i>P1
-to</i> <i>P2</i>.
+  \n All options are unchecked by default. No cleanup is made by default so that the mesh matches the shape. If the user has a bad shape (e.g. imported shape), he can activate some options to improve the mesh.
 
-  - 0 - the interpolation is linear: \f$v = h1 + t (h2 - h1 )\f$
+  - <b>Closed geometry</b> - describes whether the working geometry should be closed or not. 
+  When activated, this option helps PreCAD to process the dirtiest geometries.
 
-  - 1 - the interpolation is geometric: \f$v = h1 \times \left( \frac{h1}{h2} \right)^{t}\f$
+  - \b Debug - If debug = yes PreCAD will be very verbose and will output some intermediate files in the working directory.
 
-  - 2 - the interpolation is sinusoidal: \f$v = \frac{h1+h2}{2} + \frac{h1-h2}{2 \cdot \cos(\pi \cdot t)}\f$
+  - <b>Discard input topology</b> - compute the CAD topology from scratch,
+  without considering the topological information contained in the original CAD
+  (useful for iges files). This option is unchecked by default.
 
-  \n Default is 0.
+  - <b>Merge Edges</b> - optimize the geometry by merging some
+  edges.
 
-- \anchor blsurf_hmean_flag \b hmean_flag (integer) - determines the computation of the average of several
-values:
+  - <b>Periodic tolerance</b> - This parameter defines the maximum size difference between two periodic edges and also the maximum distance error between two periodic entities.
 
-  - -1 - the minimum is computed.
+  - <b>Remove duplicate CAD faces</b> - optimize the geometry by merging the
+  duplicate CAD faces. This option is unchecked by default.
 
-  - 0 or 2 - the arithmetic average is computed.
+  - <b>Required entities</b> - The required entities control the correction operations. Accepted values for this parameter are:
+    - respect : MeshGems-CADSurf is not allowed to alter any required entity, even for correction purposes,
+    - ignore : MeshGems-CADSurf will ignore the required entities in its processing,
+    - clear : MeshGems-CADSurf will clear any required status for the entities. There will not be any entity marked as required in the generated mesh.
 
-  - 1 - the geometric average is computed.
+  - <b>Sewing tolerance</b> - tolerance of the assembly. It rarely requires to be tuned.
 
-  \n Default is 0.
+  - \b Tags - controls the optimisation process. Possible values are:
+    - "respect" - PreCAD is not allowed to cross the CAD attributes boundaries for optimisation purpose.
+    - "ignore" - PreCAD is allowed to cross the CAD attributes boundaries for optimisation.
+    - "clear" - PreCAD will erase each tgas of each entities, and will thus be allowed to cross the CAD attributes boundaries in its optimisation purpose.
 
-- \b CheckAdjacentEdges, \b CheckCloseEdges and \b CheckWellDefined
-(integers) - give the number of calls of equally named subroutines the
-purpose of which is to improve the mesh of domains having narrow
-parts. At each iteration,\b CheckCloseEdges decreases the sizes of the
-edges when two boundary curves are neighboring,\b CheckAdjacentEdges
-balances the sizes of adjacent edges, and \b CheckWellDefined checks if
-the parametric domain is well defined. Default values are 0.
-
-- \b CoefRectangle (real)- defines the relative thickness of the rectangles
-used by subroutine \b CheckCloseEdges (see above). Default is 0.25.
 
-- \b eps_collapse (real) - if more than 0.0, BLSURF removes
-curves whose lengths are less than \b eps_collapse. To obtain an
-approximate value of the length of a curve, it is arbitrarily
-split into 20 edges. Default is 0.0.
+- <b>Add option</b> - adds a new line in <b>Other options</b> section where you can type an option name and value. The following advanced MG-CADSurf options can be used:
 
-- \b eps_ends (real) - is used to detect the curves whose lengths are very
-small, that sometimes constitutes an error. A message is printed
-if \f$\left|P2-P1\right| < eps\_ends\f$, where <i>P1</i> and <i>P2</i> are the
-extremities of a curve. Default is \f$\frac{\mathrm{diag}}{500.0}\f$.
+  - \b create_tag_on_collision (bool) - If this option is activated, MeshGems-CADSurf will create new tags to
+  describe tag collisions (when it locally changes the topology, depending on the patch independent
+  options). When this option is not activated, only one tag is preserved while the other one is dropped.
+  By default this option is 1.
 
-- \b prefix (char) - is a prefix of the files generated by
-BLSURF. Default is "x".
+  - \b tiny_edge_respect_geometry (bool) - This option defines the behaviour of the tiny edge removal algorithm
+  regarding volume collapse. By default, all tiny edges will be removed, regardless of any potential
+  volume collapse. When this option is activated, it will prevent volume from being collapsed during the tiny edge removal process.
+  By default this option is 0.
 
-- \b refs (integer) - reference of a surface, used when exporting
-files. Default is 1.
+  - \b manifold_geometry (int) - describes whether the working geometry should be manifold or not.
+  When activated, this option helps PreCAD to process the dirtiest
+  geometries. By default this option is 0.
 
-The following PreCAD options are commonly usable. 
 
-- \b closed_geometry (int) - describes whether the working geometry 
-should be closed or not. When activated, this option helps PreCAD to process 
-the dirtiest geometries. By default this option is 0.
 
-- \b debug (int) - If debug = 1 PreCAD will be very verbose and will output 
-some intermediate files in the working directory. By default this
-option is 0.
+- <b>Verbosity level</b> - defines the percentage of "verbosity" of
+MeshGems-CADSurf [0-10].
 
-- \b eps_nano_relative (real) -  the same as \b eps_nano, but relatively to 
-the diagonal of the box bounding the geometry. By default this option is \f$10^{-5}\f$.
+- <b>ExportGMF</b> - saves the computed mesh into a GMF file (.mesh or .meshb).
 
-- \b eps_sewing (real) - tolerance of the assembly. It rarely requires to be tuned. 
-By default this option is \f$\mathrm{diag} \times 5 \cdot 10^{-4}\f$.
 
-- \b eps_sewing_relative (real) -  the same as \b eps_nano but relatively to 
-the diagonal of the box bounding the geometry. By default this option
-is \f$5 \cdot 10^{-4}\f$.
-
-- \b manifold_geometry (int) - describes whether the working geometry should be manifold or not.
-When activated, this option helps PreCAD to process the dirtiest
-geometries. By default this option is 0.
-
-- \b create_tag_collision (int) - creates new tags from original ones in case 
-of collision (entity merge or association for example). By default
-this option is 0.
-
-- \b periodic_tolerance (real) - defines the maximum distance error accepted between 
-two sets of periodic entities. By default this option is \f$\mathrm{diag} \times 10^{-5}\f$.
-
-- \b periodic_tolerance_relative (real) -  the same as \b periodic_tolerance but in a relative unit.
-By default this option is \f$10^{-5}\f$.
-
-- \b periodic_split_tolerance (real) - This periodicity processing related option defines 
-the minimum distance between a CAD point and an imprinted point. It allows to indirectly 
-control the number of created points and small edges. By default this
-option is \f$\mathrm{diag} \times 10^{-4}\f$.
-
-- \b periodic_split_tolerance_relative (real -  the same as \b
-periodic_split_tolerance but in a relative unit. By default this
-option is \f$10^{-4}\f$.
-
-The following advanced options are not documented and you can use them
-at your own risk.
-
-- Integer variables:
-  - addsurf_ivertex
-  - anisotropic
-  - background
-  - coiter
-  - communication
-  - decim
-  - export_flag
-  - file_h
-  - gridnu
-  - gridnv
-  - intermedfile
-  - memory
-  - normals
-  - optim
-  - pardom_flag
-  - pinch
-  - rigid
-  - surforient
-  - tconf
-  - topo_collapse
-- Real variables:
-  - addsurf_angle
-  - addsurf_R
-  - addsurf_H
-  - addsurf_FG
-  - addsurf_r
-  - addsurf_PA
-  - angle_compcurv
-  - angle_ridge
-  - anisotropic_ratio
-  - eps_pardom
-- String variables:
-  - export_format
-  - export_option
-  - import_option
 
 \ref blsurf_top "Back to top"
 
@@ -347,6 +263,14 @@ used by default, but this can be modified by the parameter
 interpolate two values, a linear interpolation is used by default, but
 this can be modified by \ref blsurf_hinterpol_flag "hinterpol flag". 
 
+<b>Note:</b> on some particular configurations, the mesher behaviour is
+not the same as before (SALOME versions before 8.2 i.e. MeshGems before 2.3).
+For a small local size defined on a point situated on a border curve,
+the previous mesher behaviour may be prefered: 
+see "use deprecated patch mesher"
+on advanced tag.
+
+
 \ref blsurf_local_size "Back to \"Local size\""\n
 \ref blsurf_top "Back to top"
 
@@ -379,7 +303,7 @@ not with an <i>attractor</i> size map described above.
   prescribed by the attractor function.
 
   - Else the growing is only controled by the standard arguments of
-  BLSURF (gradation ...).
+  MG-CADSurf (gradation ...).
 
 \image html blsurf_const_size_near_shape2.png "Example of size map with constant size option, the size is kept constant on the left side of the surface until a certain distance"
 
@@ -388,7 +312,7 @@ attractors are defined or the "constant size" option is used because a
 map of distances has to be built on the whole surface for each face
 where such a hypothesis has been defined.
 
-\sa Sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including size map.
+\sa Sample TUI Script of the \ref tui_blsurf "creation of a MG-CADSurf hypothesis", including size map.
 
 \ref blsurf_local_size "Back to \"Local size\""\n
 \ref blsurf_top "Back to top"
@@ -416,43 +340,93 @@ shape. The distance is the geodesic distance (i.e. calculated by following the s
 
 \image html blsurf_parameters_enforced_vertices.png
 
-It is possible to define some enforced vertices to BLSurf algorithm.
-An enforced vertex is defined on a Face or a Compound by
+It is possible to define some enforced vertices to MG-CADSurf algorithm.
+An enforced vertex is defined by
 
 - selecting an existing Vertex or Compound,
 
-- or creating a new vertex given its coordinates.
+- or by its coordinates.
 
 The enforced vertex is the projection of a point defined by its
-(x,y,z) coordinates on the selected face.
+(x,y,z) coordinates on the closest face found by the application.
 
-- It is possible to define several enforced vertices on a face or a group of faces.
+- It is possible to define several enforced vertices.
 
 - If the projected point is on the boundary or outside of the face, it will be ignored.
 
-- If a group name is specified : If the group exists, the enforced nodes will be added in the existing group, if the group does not exist it will be created.
+- If a group name is specified : if the group exists, the enforced nodes will be added in the existing group, if the group does not exist it will be created.
 
-\sa Sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including enforced vertices.
+All the internal vertices of faces can be considered as enforced vertices if the corresponding checkbox is checked.
+A group can optionnaly be defined on those enforced vertices.
+
+\sa Sample TUI Script of the \ref tui_blsurf "creation of a MG-CADSurf hypothesis", including enforced vertices.
 
 \ref blsurf_top "Back to top"
 
-\section blsurf_limitations Limitations
 
-Currently BLSURF plugin has the following limitations.
+\section blsurf_periodicity Periodicity
+
+\subsection periodicity_introduction Introduction
+
+Periodicity is used to have the same discretization on two faces (in 3D) or two edges (in 2D).
+This is useful for instance for a Representative Volume Element so that the translated meshes share the same nodes on the common faces.
+
+Periodicity association uses PreCAD (MG-CADSurf preprocessor). You don't need an extra PreCAD license. It is included in MG-CADSurf since MeshGems V2.2.
+
+\image html blsurf_periodicity_translation.png "Two periodic faces (translation)"
 
-- BLSURF algorithm cannot be used as a local algorithm (on
-sub-meshes) or as a provider of a low-level
-mesh for some 3D algorithms, because the BLSURF mesher (and
-consequently plugin) does not provide the information on node
-parameters on edges (U) and faces (U,V). For example the
-following combinations of algorithms are impossible:
+\image html blsurf_periodicity_reflexion.png "Two periodic faces (reflexion)"
 
-  - global MEFISTO or Quadrangle(mapping) + local BLSURF;
+\image html blsurf_periodicity_2D.png "Associations of edges in 2D (both red edges are associated with each other)"
 
-  - BLSURF + Projection 2D from faces meshed by BLSURF;
+\subsection periodicity_gui_usage GUI usage
+
+\image html blsurf_parameters_periodicity.png
+
+The periodicity association can be defined:
+
+- on 2 groups of faces (in 3D)
+- on 2 groups of edges (in 2D)
+
+If the transformation is a translation, PreCAD makes the periodicity association with only this information.
+
+Otherwise, for instance a rotation, the user has to define 3 non-colinear vertices and their image by the transformation.
+
+\subsection periodicity_tui_precad_usage TUI PreCAD usage
+
+The two methods to define periodicity with PreCAD are
+(the former name of <em>MG-CADSurf</em> is \a BLSURF and names
+of the corresponding classes and modules still include \a "BLSURF"):
+- BLSURFPluginBuilder.BLSURF_Algorithm.AddPreCadFacesPeriodicity
+- BLSURFPluginBuilder.BLSURF_Algorithm.AddPreCadEdgesPeriodicity
+
+List of source and target vertices to define a transformation are optional.
+
+\sa Sample TUI Script of the definition of MG-CADSurf periodicity \ref tui_blsurf_periodicity_preCAD "using preCAD".
+
+\section blsurf_hyperpatch Hyper-patch
+
+\image html blsurf_parameters_hyperpatch.png
+
+Hyper-patch tab page allows defining faces that will be meshes together as
+  part of a global hyper-patch.
+
+- <b>Hyper-patch IDs</b> table - shows IDs of faces of defined hyper-patches.
+
+- <b>Face selection</b> - activates selection of faces in the VTK Viewer.
+
+- <b>Group selection</b> - activates selection of faces and groups of
+  faces in the Object Browser.
+
+- \b IDs - allows typing IDs of faces composing a hyper-patch and
+  shows IDs of faces selected in the Viewer or the Object Browser.
+
+- \b Add - adds a new row to the table and moves \b IDs there.
+
+- \b Remove - removes selected hyper-patches from the table.
 
-  - local BLSURF + Extrusion 3D;
-  
 \ref blsurf_top "Back to top"
 
+For more information on MeshGems-CADSurf, you can read its documentation at $MESHGEMS_ROOT_DIR/Docs/mg-cadsurf_user_manual.pdf
+
 */