From: vsr Date: Thu, 19 Apr 2012 08:58:00 +0000 (+0000) Subject: Improving documentation: structuring, fixing misspellings X-Git-Tag: TRIPOLI_323 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=605b398e78784d7b0d7bad36015807b7e6f76f15;p=plugins%2Fblsurfplugin.git Improving documentation: structuring, fixing misspellings --- diff --git a/doc/salome/gui/BLSURFPLUGIN/input/blsurf_hypo.doc b/doc/salome/gui/BLSURFPLUGIN/input/blsurf_hypo.doc index 94c1697..1964dbe 100644 --- a/doc/salome/gui/BLSURFPLUGIN/input/blsurf_hypo.doc +++ b/doc/salome/gui/BLSURFPLUGIN/input/blsurf_hypo.doc @@ -3,443 +3,456 @@ \page blsurf_hypo_page BLSURF Parameters hypothesis \anchor blsurf_top -\n BLSURF Parameters hypothesis works only with BLSURF 2d -algorithm. This algorithm is a commercial software. -\n To get a licence, visit http://www.distene.com/corp/eval-distene.html - -
    -
  1. \ref blsurf_general_parameters "General parameters"
    2. -
  2. \ref blsurf_advanced_parameters "Advanced parameters"
    3. -
  3. \ref blsurf_local_size "Local size"
    4. -
      -
    1. \ref blsurf_sizemap_computation "Computation of the physical size"
      2. -
    2. \ref blsurf_attractor "Advanced maps"
      3. -
    3. \ref blsurf_attractor_computation "Computation of attractors"
      4. -
    -
  4. \ref blsurf_enforced_elements "Enforced vertices"
    5. -
  5. \ref blsurf_limitations "Limitations"
    6. -
- -\anchor blsurf_general_parameters -

General parameters

+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/corp/eval-distene.html + +\tableofcontents + +\section blsurf_general_parameters General parameters \image html blsurf_parameters.png - +- Allow Quadrangles - if checked, allows the creation of + quadrilateral elements. + +- Patch independent - if checked, geometrical edges are not +respected and all geometrical faces are meshed as one hyper-face. \ref blsurf_top "Back to top" -\anchor blsurf_advanced_parameters -

Advanced parameters

+\section blsurf_advanced_parameters Advanced parameters -The notion of diag used in the descriptions means the diagonal of the bounding box of the -geometrical object to mesh. +The notion of diag used in the descriptions means the diagonal +of the bounding box of the geometrical object to mesh. \image html blsurf_parameters_advanced.png -
  • Verbosity level - Defines the percentage of "verbosity" of -BLSURF [0-100].
    • +- Verbosity level - defines the percentage of "verbosity" of +BLSURF [0-100]. + +- Topology - allows creation of a conform mesh on a shell of +not sewed faces. The following choices are allowed: -
  • Topology - allows creation of a conform mesh on a shell of -not sewed faces. - - -
  • ExportGMF - saves the computed mesh into a GMF file (.mesh or .meshb).
    • - -
  • Add option - 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 to edit it later.
    • -
  • Clear option - removes the option selected in the table.
    • + - 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: - + - Merge Edges - allows PreCAD to optimize the geometry by merging some + edges. This option is 0 by default. -\n -The following BLSURF options are commonly usable. + - Remove nano edges - allows PreCAD to optimize the geometry by removing + the nano edges whenever possible. This option is 0 by default. - +- \b refs (integer) - reference of a surface, used when exporting +files. Default is 1. -\n The following PreCAD options are commonly usable. - +option is \f$10^{-4}\f$. -\n The following advanced options are not documented and you can use them at your own risk. -\n\n Integer variables: - -Real variables: - -String variables: - + +- 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" -\anchor blsurf_local_size -

    Local size

    - -Local sizes can be defined on faces, edges or vertices. - +\section blsurf_local_size Local size + +Local sizes can be defined on faces, edges or vertices: + +- The faces, edges and vertices can belong to the meshed geometrical +object or to its sub-shapes (created using Explode command). + +- Groups of faces, edges and vertices are also handled. + +- It is possible to attribute the same size to several geometries using multi-selection. + +- The sizes are constant values or python functions. + +- In case of a python function, the following rules must be respected: + + - The name of the function is f. + + - If geometry is a face or a group of faces, the function is f(u,v). + + - If geometry is an edge or a group of edges, the function is f(t). + + - If geometry is a vertex or a group of vertices, the function is f(). + + - The function must return a double. 3 different types of size maps can be defined: -
      -
    1. \ref blsurf_sizemap_computation "Computation of the physical size"
      2. -
    2. \ref blsurf_attractor "Advanced maps"
      3. -
    3. \ref blsurf_attractor_computation "Computation of attractors"
      4. -
    + +-# \ref blsurf_sizemap_computation "Computation of the physical size" +-# \ref blsurf_attractor "Advanced maps" +-# \ref blsurf_attractor_computation "Computation of attractors" \ref blsurf_top "Back to top" -\anchor blsurf_sizemap_computation -

    Computation of the physical size

    +\subsection blsurf_sizemap_computation Computation of the physical size + \image html blsurf_parameters_sizemap1.png -The physical size is obtained by querying sizemap functions associated to the input CAD object for surfaces, curves and points. +The physical size is obtained by querying sizemap functions associated +to the input CAD object for surfaces, curves and points. Each function can either return a value h (which is then trimmed between the two bounds hphymin and hphymax), or "no answer" (by not assigning a value to h), thus providing great flexibility in the -specification of the sizes. The computation depends on whether point P is internal to a surface, internal to a curve, or at the end of several curves: - -In order to compute the mean of several values, the arithmetic mean is used by default, but this can be modified by the parameter \ref blsurf_hmean_flag "hmean flag". In the same way, in order to interpolate two values, a linear interpolation is used by default, but this can be modified by \ref blsurf_hinterpol_flag "hinterpol flag". - -\ref blsurf_local_size "Back to \"Local size\"" \n +specification of the sizes. The computation depends on whether point P +is internal to a surface, internal to a curve, or at the end of +several curves: + +- If point P is internal to a surface, the CAD surface size function +is queried. If no answer is returned, one interpolates with the values +at the vertices of the discretized interface curves. + +- If point P is internal to a curve, the CAD curve size function is +queried first. If no answer is returned, the surface size function is +queried for every adjacent surface and the mean value of the returned +values is computed. If no answer is returned, sizes h1 and h2 at both +ends of the curve are considered (see next item) and the interpolated +value is computed. + +- If point P is at the extremity of several curves, the CAD point size +function is queried first. If no answer is returned, the curve size +function is queried for every adjacent curve and the mean value of the +returned values is computed. If no answer is returned, the surface +size function is queried for every adjacent surface and the mean value +of the returned values is computed. If there is still no answer +returned, the default value hphydef is kept. + +In order to compute the mean of several values, the arithmetic mean is +used by default, but this can be modified by the parameter +\ref blsurf_hmean_flag "hmean flag". In the same way, in order to +interpolate two values, a linear interpolation is used by default, but +this can be modified by \ref blsurf_hinterpol_flag "hinterpol flag". + +\ref blsurf_local_size "Back to \"Local size\""\n \ref blsurf_top "Back to top" -\anchor blsurf_attractor -

    Advanced maps

    -\n +\subsection blsurf_attractor Advanced maps + \image html blsurf_parameters_sizemap2.png -\n + More specific size maps can be defined on faces. - + + - If the two options are combined the size will remain constant + until the distance specified in "constant over" and grow then as + prescribed by the attractor function. + + - Else the growing is only controled by the standard arguments of + BLSURF (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" -Remark : The validation of the hypothesis might take a few seconds if +\note The validation of the hypothesis might take a few seconds if 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. -
    See Also a 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 BLSurf hypothesis", including size map. -\ref blsurf_local_size "Back to \"Local size\"" \n +\ref blsurf_local_size "Back to \"Local size\""\n \ref blsurf_top "Back to top" -\anchor blsurf_attractor_computation -

    Computation of attractors

    -\n +\subsection blsurf_attractor_computation Computation of attractors + The size grows exponentially following the equation : \f$h(d) = \mathrm{User Size} + (\mathrm{h\_start} - \mathrm{User Size}) \times e ^ { - \left( \frac{d}{R} \right) ^ {2} }\f$ -\n + Where : - + +- h_start is the desired size on the given attractor shape + +- d is the distance of the current point from the attractor +shape. The distance is the geodesic distance (i.e. calculated by following the surface to be meshed) + +- R is called the distance of influence and allows controlling the growth rate of the mesh \image html blsurf_attractors2.png "Example of mesh created using attractors, the attractors here are the side edges and the size grows from the side of the surface towards the apex" -\ref blsurf_local_size "Back to \"Local size\"" \n +\ref blsurf_local_size "Back to \"Local size\""\n \ref blsurf_top "Back to top" -\anchor blsurf_enforced_elements -

    Enforced vertices

    +\section blsurf_enforced_elements Enforced vertices \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 - + +- selecting an existing Vertex or Compound, + +- or creating a new vertex given its coordinates. + The enforced vertex is the projection of a point defined by its (x,y,z) coordinates on the selected face. - -
    See Also a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including enforced vertices. +- It is possible to define several enforced vertices on a face or a group of faces. + +- If the projected point is on the boundary or outside of the face, it will be ignored. + +- If a group name is specified, the enforced nodes will be added in the 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. \ref blsurf_top "Back to top" -\anchor blsurf_limitations -

    Limitations

    +\section blsurf_limitations Limitations Currently BLSURF plugin has the following limitations. - +- 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: + + - global MEFISTO or Quadrangle(mapping) + local BLSURF; + + - BLSURF + Projection 2D from faces meshed by BLSURF; + + - local BLSURF + Extrusion 3D; + \ref blsurf_top "Back to top" */ diff --git a/doc/salome/gui/BLSURFPLUGIN/input/blsurfplugin_python_interface.doc b/doc/salome/gui/BLSURFPLUGIN/input/blsurfplugin_python_interface.doc index 0f605e9..0d3efc1 100644 --- a/doc/salome/gui/BLSURFPLUGIN/input/blsurfplugin_python_interface.doc +++ b/doc/salome/gui/BLSURFPLUGIN/input/blsurfplugin_python_interface.doc @@ -9,8 +9,10 @@ Documentation for BLSURFPlugin package is available in linear form grouped by cl Below you can see an example of usage of the BLSURFPlugin package for mesh generation: \anchor tui_blsurf -

    Construction of Mesh using BLSurf algorithm

    -

    Basic hypothesis

    + +\section blsurf_construct_mesh Construction of Mesh using BLSurf algorithm + +\subsection blsurf_construct_mesh_basic_hypo Basic hypothesis \code import geompy import smesh @@ -46,7 +48,7 @@ algo2d = blsurfMesh.Triangle(algo=smesh.BLSURF) # End of script \endcode -

    Adding sizemaps

    +\subsection blsurf_construct_mesh_sizemaps Adding sizemaps \code # optional - set physical mesh to 2 = Size Map algo2d.SetPhysicalMesh( 2 ) @@ -67,9 +69,8 @@ blsurfMesh.Compute() # End of script \endcode -

    Adding enforced vertices

    +\subsection blsurf_construct_mesh_enforced_vertices Adding enforced vertices \code - # Add enforced vertex for Face_1 on (50, 50, 50) # The projection coordinates will be (50, 50, 0) algo2d.SetEnforcedVertex(Face_1, 50, 50, 50) @@ -101,12 +102,10 @@ algo2d.UnsetEnforcedVertices(Face_1) blsurfMesh.Compute() # End of script - \endcode -

    Adding an attractor

    +\subsection blsurf_construct_mesh_attractor Adding an attractor \code - # Add an attractor on Face_2, which shape is Wire_1 # The size on Wire_1 is 1 and will grow until a maximum of 36.641 (physical size set above) @@ -122,12 +121,10 @@ algo2d.SetGradation( 2.5 ) blsurfMesh.Compute() # End of script - \endcode -

    Using internal vertices

    +\subsection blsurf_construct_mesh_internal_vertices Using internal vertices \code - # Creating a geometry containing internal vertices Face_3 = geompy.MakeFaceHW(1, 1, 1) Vertex_2 = geompy.MakeVertex(0.2, 0.2, 0) diff --git a/doc/salome/gui/BLSURFPLUGIN/input/index.doc b/doc/salome/gui/BLSURFPLUGIN/input/index.doc index 8f8fdeb..3a35d84 100644 --- a/doc/salome/gui/BLSURFPLUGIN/input/index.doc +++ b/doc/salome/gui/BLSURFPLUGIN/input/index.doc @@ -2,18 +2,19 @@ \mainpage Introduction to BLSURFPLUGIN -\note BLSURFPLUGI plugin used BLSURF commercial mesher and require a -license to be used within the Mesh module. +\b BLSURFPLUGIN SALOME module represents a meshing plug-in that can be +used within the SALOME Mesh module for generation of 2D mesh. -\n \b BLSURFPLUGIN plugin is destined for: +\note BLSURFPLUGIN plugin uses DISTENE BLSurf commercial meshing +software and requires a license at the run time (to work within the +Mesh module). - +\b BLSURFPLUGIN plugin is destined for: +- Meshing of the 2D geometric entities. -To manage parameters of the BLSURFPLUGIN use \subpage blsurf_hypo_page. +To manage parameters of the BLSURFPLUGIN, use \subpage blsurf_hypo_page. -Also all BLSURFPLUGIN functionalities are accessible via +Also, all BLSURFPLUGIN functionalities are accessible via the \subpage blsurfplugin_python_interface_page "BLSURFPLUGIN Python interface". */