From e7f4c012fbf331df02bbde719b6e49cce95d202a Mon Sep 17 00:00:00 2001 From: eap Date: Thu, 14 May 2015 12:51:53 +0300 Subject: [PATCH] Update docs --- doc/salome/gui/SMESH/input/area.doc | 6 +- .../input/borders_at_multi_connection.doc | 7 +- .../input/borders_at_multi_connection_2d.doc | 6 +- .../input/convert_to_from_quadratic_mesh.doc | 2 +- .../gui/SMESH/input/extrusion_along_path.doc | 17 ++--- doc/salome/gui/SMESH/input/free_borders.doc | 2 +- doc/salome/gui/SMESH/input/free_edges.doc | 6 +- doc/salome/gui/SMESH/input/length_2d.doc | 8 +-- .../gui/SMESH/input/make_2dmesh_from_3d.doc | 6 +- .../gui/SMESH/input/pattern_mapping.doc | 66 ++++++++++--------- doc/salome/gui/SMESH/input/smoothing.doc | 64 +++++++++--------- doc/salome/gui/SMESH/input/taper.doc | 7 +- 12 files changed, 101 insertions(+), 96 deletions(-) diff --git a/doc/salome/gui/SMESH/input/area.doc b/doc/salome/gui/SMESH/input/area.doc index f650a3fd6..765d4d4f4 100644 --- a/doc/salome/gui/SMESH/input/area.doc +++ b/doc/salome/gui/SMESH/input/area.doc @@ -3,9 +3,7 @@ \page area_page Area \n \b Area mesh quality control is based on the algorithm of area -calculation of meshing elements. It can be applied to meshes -consisting of 2D meshing elements with 3 and 4 nodes (triangles and -quadrangles). +calculation of mesh faces. To apply the Area quality control to your mesh:
    @@ -17,7 +15,7 @@ quadrangles). \image html image35.png
    "Area" button
    -Your mesh will be displayed in the viewer with its elements colored +Your mesh will be displayed in the viewer with its faces colored according to the applied mesh quality control criterion: \image html image5.jpg diff --git a/doc/salome/gui/SMESH/input/borders_at_multi_connection.doc b/doc/salome/gui/SMESH/input/borders_at_multi_connection.doc index 8f92d3995..b4f14481f 100644 --- a/doc/salome/gui/SMESH/input/borders_at_multi_connection.doc +++ b/doc/salome/gui/SMESH/input/borders_at_multi_connection.doc @@ -2,9 +2,8 @@ \page borders_at_multi_connection_page Borders at multi-connection -\n This mesh quality control highlights borders of faces consisting of -edges belonging to several faces. The amount of faces is specified by -user. +\n This mesh quality control highlights segments according to number +of elements, faces and volumes, the segment belongs to. \image html image151.gif @@ -13,4 +12,4 @@ In this picture the borders at multi-connection are displayed in blue.
    See Also a sample TUI Script of a \ref tui_borders_at_multiconnection "Borders at Multi-Connection quality control" operation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/borders_at_multi_connection_2d.doc b/doc/salome/gui/SMESH/input/borders_at_multi_connection_2d.doc index a0fe04290..e0e78959b 100644 --- a/doc/salome/gui/SMESH/input/borders_at_multi_connection_2d.doc +++ b/doc/salome/gui/SMESH/input/borders_at_multi_connection_2d.doc @@ -2,12 +2,12 @@ \page borders_at_multi_connection_2d_page Borders at multi-connection 2D -\n This mesh quality control highlights borders of elements of mesh, -consisting of edges belonging to several elements of mesh. +\n This mesh quality control highlights borders of faces (links +between nodes) according to number of faces the link belongs to. \image html image127.gif
    See Also a sample TUI Script of a \ref tui_borders_at_multiconnection_2d "Borders at Multi-Connection quality control" operation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc index d321a2f20..a8ad620b5 100644 --- a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc +++ b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc @@ -14,7 +14,7 @@ quadratic meshes. To produce a conversion:
    1. Select a mesh or a sub-mesh in the Object Browser or in the -Viewer.
      2. + Viewer.
    2. From the Modification menu or from the contextual menu in the Object Browser choose Convert to/from Quadratic Mesh item, or click "Convert to/from quadratic" button in the diff --git a/doc/salome/gui/SMESH/input/extrusion_along_path.doc b/doc/salome/gui/SMESH/input/extrusion_along_path.doc index 7151f77b8..03717c77f 100644 --- a/doc/salome/gui/SMESH/input/extrusion_along_path.doc +++ b/doc/salome/gui/SMESH/input/extrusion_along_path.doc @@ -3,8 +3,9 @@ \page extrusion_along_path_page Extrusion along Path \n In principle, Extrusion along Path works in the same way -as \ref extrusion_page "Extrusion", the main difference is that we define not a vector, -but a path of extrusion which must be a 1D mesh or 1D sub-mesh. +as \ref extrusion_page "Extrusion", the main difference is that we +define not a vector, but a path of extrusion which must be an 1D mesh +or 1D sub-mesh. To get an idea of how this algorithm works, examine several examples, starting from the most simple case of extrusion along a straight edge. In the examples the sample mesh will be extruded along different @@ -66,8 +67,8 @@ six coincident nodes and two coincident faces in the resulting mesh. \image html circle_angles_after.png -
      The same, but using angles {45, -45, 45, -45, 45, -45, 45, --45}
      +
      The same, but using angles {45, -45, 45, -45, 45, -45, 45, -45} +

      To use Extrusion along Path:
        @@ -93,7 +94,7 @@ The following dialog will appear: of following means:
        • Select the whole mesh, sub-mesh or group activating this - checkbox.
          • + check-box.
        • Choose mesh elements with the mouse in the 3D Viewer. It is possible to select a whole area with a mouse frame.
        • Input the element IDs directly in Node IDs, Edge @@ -107,10 +108,10 @@ The following dialog will appear:
        • Define the \b Path along which the elements will be extruded.
          Path definition consists of several elements:
            -
          • Mesh or submesh - 1D mesh or sub-mesh, along which +
          • Mesh or sub-mesh - 1D mesh or sub-mesh, along which proceeds the extrusion.
            • -
          • Start node - the start node. It is used to define - the direction of extrusion.
            • +
          • Start node - the start node of the Path. It is used + to define the direction of extrusion.
        • If you activate Generate Groups check-box, the result elements diff --git a/doc/salome/gui/SMESH/input/free_borders.doc b/doc/salome/gui/SMESH/input/free_borders.doc index 824fbd9e0..86e5e2a37 100644 --- a/doc/salome/gui/SMESH/input/free_borders.doc +++ b/doc/salome/gui/SMESH/input/free_borders.doc @@ -3,7 +3,7 @@ \page free_borders_page Free borders \n This mesh quality control highlights borders of faces consisting of -edges belonging to one face only. +1D elements (segments) belonging to one face only. \image html free_borders1.png diff --git a/doc/salome/gui/SMESH/input/free_edges.doc b/doc/salome/gui/SMESH/input/free_edges.doc index 2d51733fc..1a5720ee2 100644 --- a/doc/salome/gui/SMESH/input/free_edges.doc +++ b/doc/salome/gui/SMESH/input/free_edges.doc @@ -2,8 +2,8 @@ \page free_edges_page Free edges -\n This mesh quality control highlights borders of elements of mesh -consisting of edges belonging to one element of mesh only. +\n This mesh quality control highlights borders of faces +consisting of node links belonging to one face only. \image html free_edges.png
          In this picture some elements of mesh have been deleted and @@ -12,4 +12,4 @@ the "holes" are outlined in red.

          See Also a sample TUI Script of a \ref tui_free_edges "Free Edges quality control" operation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/length_2d.doc b/doc/salome/gui/SMESH/input/length_2d.doc index 4ed5b69e6..b3599ae29 100644 --- a/doc/salome/gui/SMESH/input/length_2d.doc +++ b/doc/salome/gui/SMESH/input/length_2d.doc @@ -3,8 +3,7 @@ \page length_2d_page Length 2D \n This quality control criterion consists of calculation of length of -the edges combining the meshing elements (triangles and quadrangles) -of your mesh. +the links between corner nodes of mesh faces. To apply the Length 2D quality criterion to your mesh:
            @@ -16,7 +15,8 @@ of your mesh. \image html image34.png
            "Length 2D" button
            -Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion: +Your mesh will be displayed in the viewer with links colored according +to the applied mesh quality control criterion: \image html length2d.png @@ -25,4 +25,4 @@ Your mesh will be displayed in the viewer with its elements colored according to
            See Also a sample TUI Script of a \ref tui_length_2d "Length 2D quality control" operation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc b/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc index 8b9486e0a..3dfec30d5 100644 --- a/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc +++ b/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc @@ -28,8 +28,8 @@ the type of operation you would like to perform. \n "Create boundary elements" dialog allows creation of boundary elements of two types.
              -
            • 2D from 3D creates mesh faces on free facets of volume elements
              • -
            • 1D from 2D creates mesh edges on free edges of mesh faces
              • +
            • 2D from 3D creates missing mesh faces on free facets of volume elements
              • +
            • 1D from 2D creates missing mesh edges on free edges of mesh faces
            Here a free facet means a facet shared by only one volume, a free edge means an edge shared by only one mesh face. @@ -41,7 +41,7 @@ In this dialog:
            • This mesh adds elements in the selected mesh.
            • New mesh adds elements to a new mesh. The new mesh appears - in the Object Browser with the name that you can change in the adjacent box.
              • + in the Object Browser with the name that you can change in the adjacent box.
          1. activate Copy source mesh checkbox to copy all elements of the selected mesh to the new mesh, else the new mesh will contain only diff --git a/doc/salome/gui/SMESH/input/pattern_mapping.doc b/doc/salome/gui/SMESH/input/pattern_mapping.doc index 969b9fc5e..0fee46ccc 100644 --- a/doc/salome/gui/SMESH/input/pattern_mapping.doc +++ b/doc/salome/gui/SMESH/input/pattern_mapping.doc @@ -14,17 +14,19 @@ The smp file contains 4 sections: -# The first line indicates the total number of pattern nodes (N). -# The next N lines describe nodes coordinates. Each line contains 2 -node coordinates for a 2D pattern or 3 node coordinates for a 3D pattern. -Note, that node coordinates of a 3D pattern can be defined only by relative values in range [0;1]. + node coordinates for a 2D pattern or 3 node coordinates for a 3D pattern. + Note, that node coordinates of a 3D pattern can be defined only by + relative values in range [0;1]. -# The key-points line contains the indices of the nodes to be mapped on geometrical -vertices (for a 2D pattern only). Index n refers to the node described -on the n-th line of section 2. The index of the first node zero. For a 3D pattern the key points are not specified. + vertices (for a 2D pattern only). Index n refers to the node described + on the n-th line of section 2. The index of the first node is + zero. For a 3D pattern the key points are not specified. -# The remaining lines describe nodal connectivity of elements, one line -for each element. Each line holds indices of nodes forming an element. -Index n refers to the node described on the n-th line of section 2. -The first node index is zero. There must be 3 or 4 indices on each -line for a 2D pattern (only 2d elements are allowed) and 4, 5, 6 or 8 -indices for a 3D pattern (only 3d elements are allowed). + for each element. Each line holds indices of nodes forming an element. + Index n refers to the node described on the n-th line of section 2. + The first node index is zero. There must be 3 or 4 indices on each + line for a 2D pattern (only liner 2d elements are allowed) and 4, 5, 6 or 8 + indices for a 3D pattern (only linear 3d elements are allowed). A 2D pattern must contain at least one element and at least one key-point. All key-points must lie on boundaries. @@ -107,21 +109,24 @@ In this dialog you should specify:
            • \b Pattern, which can be loaded from .smp pattern file previously -created manually or generated automatically from an existing mesh or submesh.
              • + created manually or generated automatically from an existing mesh or + sub-mesh.
            • \b Face with the number of vertices equal to the number of - key-points in the pattern; the number of key-points on internal - boundaries of the pattern must also be equal to the number of vertices - on internal boundaries of the face;
              • + key-points in the pattern; the number of key-points on internal + boundaries of the pattern must also be equal to the number of vertices + on internal boundaries of the face;
            • \b Vertex to which the first key-point should be mapped;
            + Alternatively, it is possible to select Refine selected mesh elements check-box and apply the pattern to
              -
            • Mesh Face instead of a geometric Face
              • -
            • and select \b Node instead of vertex.
              • +
            • Mesh Face instead of a geometric Face
              • +
            • and select \b Node instead of vertex.
            + Additionally it is possible to:
            • Reverse the order of key-points. By default, the vertices of - a face are ordered counterclockwise.
              • + a face are ordered counterclockwise.
            • Enable to Create polygons near boundary
            • and Create polyhedrons near boundary
            @@ -133,17 +138,18 @@ Additionally it is possible to:
              In this dialog you should specify:
              • \b Pattern, which can be loaded from .smp pattern file previously -created manually or generated automatically from an existing mesh or submesh.
                • + created manually or generated automatically from an existing mesh or + sub-mesh.
              • A 3D block (Solid) object.
              • Two vertices that specify the order of nodes in the resulting mesh.
              + Alternatively, it is possible to select Refine selected mesh elements -checkbox and apply the pattern to +check-box and apply the pattern to
                -
              • One or several Mesh volumes instead of a geometric 3D -object
                • -
              • and select two /b Nodes instead of vertices.
                • +
              • One or several Mesh volumes instead of a geometric 3D object
                • +
              • and select two /b Nodes instead of vertices.
              Additionally it is possible to:
                @@ -152,7 +158,7 @@ Additionally it is possible to:

              -

              Automatic Generation

              +

              Automatic Pattern Generation

              To generate a pattern automatically from an existing mesh or sub-mesh, click \b New button. @@ -164,8 +170,8 @@ The following dialog box will appear: In this dialog you should specify:
                -
              • Mesh or Submesh, which is a meshed geometrical face (for a -2D pattern) or a meshed solid (for a 3D pattern). Mesh nodes lying on +
              • Mesh or Sub-mesh, which is a meshed geometrical face (for a +2D pattern) or a meshed solid block (for a 3D pattern). Mesh nodes lying on the face vertices become key-points of the pattern.
              • A custom Pattern Name
              • Additionally, for a 2D pattern you may choose to @@ -204,17 +210,17 @@ The mapping algorithm for a 2D case is as follows: vertices. The node position on the edge depends on its distance from the key-points. \image html image96.gif -- The cordinates of a non-boundary node in the parametric space of the face - are defined in the following way. In the parametric space of the +- The coordinates of a non-boundary node in the parametric space of the face + are defined in the following way. In the parametric space of the pattern, the node lies at the intersection of two iso-lines. Both of them intersect the pattern boundary at two points at least. If the mapped positions of boundary nodes are known, it is - possible to find, where the points at the intersection of isolines + possible to find, where the points at the intersection of iso-lines and boundaries are mapped. Then it is possible to find - the direction of mapped isolinesection and, filally, the poitions of + the direction of mapped iso-line section and, finally, the positions of two nodes on two mapped isolines. The eventual mapped - position of the node is found as an average of the positions on mapped - isolines. + position of the node is found as an average of the positions on mapped + iso-lines. \image html image97.gif The 3D algorithm is similar. diff --git a/doc/salome/gui/SMESH/input/smoothing.doc b/doc/salome/gui/SMESH/input/smoothing.doc index dc15270a8..eb74611cf 100644 --- a/doc/salome/gui/SMESH/input/smoothing.doc +++ b/doc/salome/gui/SMESH/input/smoothing.doc @@ -2,8 +2,9 @@ \page smoothing_page Smoothing -\n Smoothing is used to adjust the locations of element corners -(nodes) to reduce distortions in these elements. +\n Smoothing is used to improve quality of 2D mesh by adjusting the +locations of element corners (nodes). \note Depending on smoothing +method and mesh geometry smoothing can decrease quality of elements. To apply smoothing to the elements of your mesh:
                  @@ -23,23 +24,25 @@ The following dialog will appear:
                  • specify the IDs of the elements which will be smoothed:
                      -
                    • Select the whole mesh, submesh or group activating this -checkbox; or
                      • +
                    • Select the whole mesh, sub-mesh or group activating this + check-box; or
                    • choose mesh elements with the mouse in the 3D Viewer. It is -possible to select a whole area with a mouse frame; or
                      • -
                    • input the element IDs directly in ID Elements field. The selected elements will be highlighted in the -viewer; or
                      • -
                    • apply Filters. Set filter button allows to apply a filter to the selection of elements. See more -about filters in the \ref selection_filter_library_page "Selection filter library" page.
                      • + possible to select a whole area with a mouse frame; or +
                    • input the element IDs directly in ID Elements field. The + selected elements will be highlighted in the viewer; or
                      • +
                    • apply Filters. Set filters button allows to apply a filter + to the selection of elements. See more about filters in the + \ref filtering_elements "Selection filter library" page.
                    • -
                  • define the Fixed nodes ids that should remain at their location during -smoothing. If a mesh is built on a shape, the nodes built on its -geometric edges are always fixed. If the smoothing is applied to a part -of the mesh, the nodes of boundary elements are also -fixed. It is possible to additionally fix any other nodes. The fixed nodes can be -selected manually or by filters, just as the smoothed elements.
                    • +
                  • define the Fixed nodes ids that should remain at their + location during smoothing. If a mesh is built on a shape, the nodes + built on its geometric edges are always fixed. If the smoothing is + applied to a part of the mesh (a set of element), the nodes on + boundary of the element set are also fixed. It is possible to + additionally fix any other nodes. The fixed nodes can be selected + manually or by filters, just as the smoothed elements.
                  • choose the Smoothing Method:
                    • \b Laplacian smoothing pulls a node toward the center of @@ -48,27 +51,26 @@ edge.
                    • \b Centroidal smoothing pulls a node toward the element-area-weighted centroid of the surrounding elements.
                      • -Typically, the Laplacian method will produce the mesh with the least element -distortion. It is also the fastest method. Centroidal smoothing usually -produces a mesh with more uniform element sizes. Both methods -produce good results with "free" meshes. +Laplacian method will produce the mesh with the least element +edge length. It is also the fastest method. Centroidal smoothing +produces a mesh with more uniform element sizes.
                    \image html image83.gif
                    • -
                  • specify the Iteration limit. Both smoothing methods -iterate through a number of steps to produce the resulting smoothed -mesh. At each new step the smoothing is reevaluated with the updated nodal locations. This -process continues till the limit of iterations has been -exceeded, or till the aspect ratio of all element is less than or equal to the -specified one.
                    • -
                  • specify the Max. aspect ratio - the target mesh quality at which the -smoothing algorithm should stop the iterations.
                    • -
                  • activate in parametric space checkbox if it is necessary to -to improve the shape of faces in the parametric space -of geometrical surfaces on which they are generated, else the shape of -faces in the 3D space is improved.
                    • +
                  • specify the Iteration limit. Both smoothing methods iterate + through a number of steps to produce the resulting smoothed mesh. At + each new step the smoothing is reevaluated with the updated nodal + locations. This process continues till the limit of iterations has + been exceeded, or till the aspect ratio of all element is less than + or equal to the specified one.
                    • +
                  • specify the Max. aspect ratio - the target mesh quality at + which the smoothing algorithm should stop the iterations.
                    • +
                  • activate in parametric space check-box if it is necessary to + improve the shape of faces in the parametric space of geometrical + surfaces on which they are generated, else the shape of faces in the + 3D space is improved that is suitable for planar meshes only.
                1. Click \b Apply or Apply and Close button to confirm the operation.
                  2. diff --git a/doc/salome/gui/SMESH/input/taper.doc b/doc/salome/gui/SMESH/input/taper.doc index 143c34628..da3ed83f6 100644 --- a/doc/salome/gui/SMESH/input/taper.doc +++ b/doc/salome/gui/SMESH/input/taper.doc @@ -3,11 +3,10 @@ \page taper_page Taper \n \b Taper mesh quality criterion represents the ratio of the areas -of two triangles separated by a diagonal. So it can be calculated only -for elements consisting of 4 nodes. +of two triangles separated by a diagonal within a quadrilateral face. -
                  JA=0.25 * (A1 + A2 + A3 + A4) -
                  TAPER= MAX(|A1/JA - 1|, |A2/JA - 1|, |A3/JA - 1|, |A4/JA - 1|)
                   +
                  JA = 0.25 * (A1 + A2 + A3 + A4) +
                  TAPER = MAX(|A1/JA - 1|, |A2/JA - 1|, |A3/JA - 1|, |A4/JA - 1|)
                  To apply the Taper quality criterion to your mesh: -- 2.30.2