From: inv Date: Wed, 12 May 2010 06:34:27 +0000 (+0000) Subject: Update SMESH documentation X-Git-Tag: V5_1_4~24 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d719b27fc2b7106aae5c17ee2cf8570bf7c6fdac;p=modules%2Fsmesh.git Update SMESH documentation --- diff --git a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc index 8e789536f..892cc9f74 100644 --- a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc @@ -7,8 +7,6 @@
  • \ref max_element_area_anchor "Max Element Area"
  • \ref length_from_edges_anchor "Length from Edges"
  • \ref hypo_quad_params_anchor "Quadrangle parameters"
    • -
  • \ref quadrangle_preference_anchor "Quadrangle Preference"
    • -
  • \ref triangle_preference_anchor "Triangle Preference"

    • @@ -69,29 +67,5 @@ shows the good (left) and the bad (right) results of meshing. See Also a sample TUI Script of a \ref tui_quadrangle_parameters "Quadrangle Parameters" hypothesis. -\anchor quadrangle_preference_anchor -

    Quadrangle Preference

    - -This algorithm can be used together with Quadrangle (Mapping) and Netgen 2D -algorithms. - -It allows Netgen 2D to build quadrangular meshes at any conditions. - -It allows Quadrangle (Mapping) to build quadrangular meshes even if the number -of nodes at the opposite edges of a meshed face is not equal, -otherwise this mesh will contain some triangular elements. -
    -This hypothesis has one restriction on its work: the total quantity of -segments on all four sides of the face must be even (divisible by 2). - - -
    -\anchor triangle_preference_anchor -

    Triangle Preference

    - -This algorithm can be used only together with Quadrangle (Mapping) -algorithm. It allows to build triangular mesh faces in the refinement -area if the number of nodes at the opposite edges of a meshed face is not equal, -otherwise refinement area will contain some quadrangular elements.
    */ diff --git a/doc/salome/gui/SMESH/input/about_hypo.doc b/doc/salome/gui/SMESH/input/about_hypo.doc index 9d9db7b32..0e8ac1007 100644 --- a/doc/salome/gui/SMESH/input/about_hypo.doc +++ b/doc/salome/gui/SMESH/input/about_hypo.doc @@ -55,6 +55,8 @@ with other hypotheses:
  • Propagation of 1D Hypothesis on opposite edges
  • Non conform mesh allowed
  • Quadratic mesh
    • +
  • Quadrangle preference
    • +
  • Triangle preference
    • The choice of a hypothesis depends on: diff --git a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc index 451823b74..99928215a 100644 --- a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc +++ b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc @@ -26,10 +26,11 @@ following associated submenu will appear: \image html image146.png From this submenu select the type of element which you would like to add to your mesh. -\note All dialogs intended for adding nodes or elements to mesh (except dialog for adding -0D elements) provide a possibility to add these nodes/elements to the specified group -(or to create the group if it doesn't exist). Add to group box allows to choose -an existing group for created node or element or to specify a name for new group. + +\note All dialogs for adding nodes or elements to the mesh (except for +the dialog for 0D elements) provide a possibility to add them to the specified group +or to create it anew using Add to group box, which allows to choose +an existing group for the created node or element or to give name to a new group. See Also sample TUI Scripts of diff --git a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc index 2a587d147..2ab778eca 100644 --- a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc +++ b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc @@ -2,7 +2,7 @@ \page adding_quadratic_elements_page Adding Quadratic Elements -\n MESH modules allows you to work with Quadratic Elements. +\n MESH module allows you to work with Quadratic Elements. Quadratic Edge is not a straight but a broken line and can be defined by three points: first, middle and last. All more complex \b Quadratic @@ -18,10 +18,10 @@ one of the following: \image html image152.png -\note All dialogs intended for adding quadratic elements to mesh provide a possibility -to add these elements to the specified group (or to create the group if it doesn't exist). -Add to group box allows to choose an existing group for created element or -to specify a name for new group. +\note All dialogs adding quadratic elements to mesh provide a possibility +to add them to the specified group or to create it anew using Add +to group box, which allows to choose an existing group for the created element or +to give name to a new group. To create any Quadratic Element specify the nodes which will form your triangle by selecting them in the 3D viewer with pressed Shift diff --git a/doc/salome/gui/SMESH/input/additional_hypo.doc b/doc/salome/gui/SMESH/input/additional_hypo.doc index 9687bdf2d..1205e19b0 100644 --- a/doc/salome/gui/SMESH/input/additional_hypo.doc +++ b/doc/salome/gui/SMESH/input/additional_hypo.doc @@ -28,8 +28,30 @@ hypothesis onto an opposite edge. If a local hypothesis and propagation are defined on an edge of a quadrangular face, the opposite edge will have the same hypothesis, unless another hypothesis has been locally defined on the opposite edge. - +
    See Also a sample TUI Script of a -\ref tui_propagation "Propagation hypothesis" operation. +\ref tui_propagation "Propagation hypothesis" operation + +

    Quadrangle Preference

    + +This additional hypothesis can be used together with Quadrangle (Mapping) and Netgen 2D +algorithms. + +It allows Netgen 2D to build quadrangular meshes at any conditions. + +It allows Quadrangle (Mapping) to build quadrangular meshes even if the number +of nodes at the opposite edges of a meshed face is not equal, +otherwise this mesh will contain some triangular elements. +
    +This hypothesis has one restriction on its work: the total quantity of +segments on all four sides of the face must be even (divisible by 2). + +

    Triangle Preference

    + +This additional hypothesis can be used only together with Quadrangle (Mapping) +algorithm. It allows to build triangular mesh faces in the refinement +area if the number of nodes at the opposite edges of a meshed face is not equal, +otherwise refinement area will contain some quadrangular elements. + -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index 042b66320..ace081140 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -154,21 +154,20 @@ evaluation will be displayed in the following information box: - \anchor mesh_order_anchor -It is allowed to change submesh priority in mesh computation when -there are concurrent submeshes present. I.e. user can change priority of -applying algorithms on shared subshapes of Mesh shape. + +
  • +If the mesh contains concurrent submeshes, it is possible to change +the priority of their computation, i.e. to change the priority of +applying algorithms to the shared subshapes of the Mesh shape.
    • + To change submesh priority: -
      -
    1. From the Mesh menu choose the "Change submesh priority" on -selected Mesh item, or invoke from popup menu. The opened dialogue box -shows a list of submeshes in the order of their priority. Algorithm and its -hypotheses of a submesh being upper in the list are applied before those of -a submesh lower in the list. -There is an example of submesh order modifications of Mesh created on a Box +
    2. Choose "Change submesh priority" from the Mesh menu or a popup menu. The opened dialogue +shows a list of submeshes in the order of their priority. + +There is an example of submesh order modifications of the Mesh created on a Box shape. The main Mesh object:
      • 3D Tetrahedron (Netgen) with HypothesisMax Element Volume
        • @@ -189,51 +188,50 @@ is: (Number of Segments = 8)
      -And the last third submesh object Submesh_3 created on Face_3 +And the last submesh object Submesh_3 created on Face_3 is:
      • 2D Netgen 1D-2D with Hypothesis Netgen Simple parameters (Number of Segments = 12)
      -The submeshes can become concurrent if their algorithms leads to mesh shared subshape -with different algorithms (or different algorithms parameters, i.e. hypothesises). -In fact, we have three submeshes with concurrent algorithms, because -they have different hypothesises assigned to them. +The submeshes become concurrent if they share subshapes that can be meshed +with different algorithms (or different hypothesises). +In the example, we have three submeshes with concurrent algorithms, +because they have different hypotheses. -The first mesh computation made with: +The first mesh computation is made with: \image html mesh_order_123.png
      "Mesh order SubMesh_1, SubMesh_2, SubMesh_3"
      \image html mesh_order_123_res.png
      "Result mesh with order SubMesh_1, SubMesh_2, SubMesh_3 "
      -The next mesh computation with: +The next mesh computation is made with: \image html mesh_order_213.png
      "Mesh order SubMesh_2, SubMesh_1, SubMesh_3"
      \image html mesh_order_213_res.png
      "Result mesh with order SubMesh_2, SubMesh_1, SubMesh_3 "
      -And the last mesh computation with: +And the last mesh computation is made with: \image html mesh_order_321.png
      "Mesh order SubMesh_3, SubMesh_2, SubMesh_1"
      \image html mesh_order_321_res.png
      "Result mesh with order SubMesh_3, SubMesh_2, SubMesh_1 "
      -As we can see each mesh computation has different number of result -elements and different mesh discretisation on shared edges (edges +As we can see, each mesh computation has a different number of result +elements and a different mesh discretisation on the shared edges (the edges that are shared between Face_1, Face_2 and Face_3) -Additionally, submesh priority (order of algorithms to be applied) can -be modified not only in separate dialog box, but in Preview -also. This helps to preview different mesh results, modifying submesh -order. +Additionally, submesh priority (the order of applied algorithms) can +be modified not only in a separate dialog box, but also in the +Preview. This helps to preview different mesh results, +modifying the order of submeshes. \image html mesh_order_preview.png
      "Preview with submesh priority list box"
      -If there are no concurrent submeshes under Mesh object, then user will see the -following information dialog box +If there are no concurrent submeshes under the Mesh object, the user will see the +following information. \image html mesh_order_no_concurrent.png
      "No concurrent submeshes detected"
      -and no mesh order list box will appear in Preview dialog box.
    diff --git a/doc/salome/gui/SMESH/input/find_element_by_point.doc b/doc/salome/gui/SMESH/input/find_element_by_point.doc index 34380aed4..fcdadea29 100644 --- a/doc/salome/gui/SMESH/input/find_element_by_point.doc +++ b/doc/salome/gui/SMESH/input/find_element_by_point.doc @@ -24,8 +24,8 @@ The following dialog box will appear: diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index 2de722d16..7e18d2b68 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -16,7 +16,8 @@ the VTK viewer; allowing to highlight important elements:
  • \subpage modifying_meshes_page "modifying meshes" with a vast array of dedicated operations.
    • -
  • \subpage using_notebook_mesh_page.
    • +
  • easily setting parameters via the variables predefined in +\subpage using_notebook_mesh_page "Salome notebook".
    • Almost all mesh module functionalities are accessible via diff --git a/doc/salome/gui/SMESH/input/merging_elements.doc b/doc/salome/gui/SMESH/input/merging_elements.doc index d677e179e..50513d58f 100644 --- a/doc/salome/gui/SMESH/input/merging_elements.doc +++ b/doc/salome/gui/SMESH/input/merging_elements.doc @@ -8,32 +8,31 @@ selectable in the dialog box. \image html mergeelems_ico.png "Merge elements button"
      -
    1. From the \b Modification choose \b Transformation and from its -sub-menu select the Merge elements item. The following dialog box +
    2. Choose in the main menu \b Modification -> \b Transformation -> Merge elements item. The following dialog box shall appear:
      3. \image html mergeelems_auto.png
    3. Automatic mode:
        -
      • In \b Automatic Mode the elements that were created on the same nodes will be merged.
        • +
      • In the \b Automatic Mode the elements created on the same nodes will be merged.
      4. -
    4. If the \b Manual Mode is selected there are additional controls to -manage the elements to be merged in more detail: +
    5. If the \b Manual Mode is selected, additional controls are +available: \image html mergeelems.png
      • \b Detect button generates the list of coincident elements for the given \b Tolerance.
        • -
      • Coincident elements is a list of groupes of elements for +
      • Coincident elements is a list of groups of elements for merging. All elements of each group will form one after the operation.
        • \b Remove button deletes the selected group from the list.
          • diff --git a/doc/salome/gui/SMESH/input/merging_nodes.doc b/doc/salome/gui/SMESH/input/merging_nodes.doc index d94d6f49d..eb17e0a14 100644 --- a/doc/salome/gui/SMESH/input/merging_nodes.doc +++ b/doc/salome/gui/SMESH/input/merging_nodes.doc @@ -17,25 +17,24 @@ shall appear:
          • \b Name is the name of the mesh whose nodes will be merged.
            • -
          • \b Automatic Mode or \b Manual Mode is to switch the dialog -controls type. +
          • \b Automatic or \b Manual Mode allows choosing how the nodes are +processed.
          • \b Tolerance is a maximum distance between nodes sufficient for -merging, that is able in both dialog modes.
            • +merging.
        • Automatic mode:
            -
          • In \b Automatic Mode to merge the Nodes, just input the tolerance -value and confirm by \b Apply button.
            • +
          • In the \b Automatic Mode all Nodes within the indicated tolerance +will be merged.

          • -
        • If the \b Manual Mode is selected there are additional controls to -manage the nodes to be merged in more detail: +
        • If the \b Manual Mode is selected, additional controls are available:
          • \b Detect button generates the list of coincident nodes for the given \b Tolerance.
            • -
          • Coincident nodes is a list of groupes of nodes for +
          • Coincident nodes is a list of groups of nodes for merging. All nodes of each group will form one after the operation.
              diff --git a/doc/salome/gui/SMESH/input/point_marker.doc b/doc/salome/gui/SMESH/input/point_marker.doc index c298893ef..40c2b932b 100644 --- a/doc/salome/gui/SMESH/input/point_marker.doc +++ b/doc/salome/gui/SMESH/input/point_marker.doc @@ -9,7 +9,7 @@ shapes or by loading a custom texture from an external file. - Standard point markers The Mesh module provides a set of predefined point marker shapes -which can be used to display points in 3D viewer. +which can be used to display points in the 3D viewer. Each standard point marker has two attributes: type (defines shape form) and scale factor (defines shape size). @@ -23,9 +23,9 @@ form) and scale factor (defines shape size). It is also possible to load a point marker shape from an external file. This file should provide a description of the point texture as a set -of lines; each line is represented as sequence of "0" and "1" symbols, +of lines; each line is represented as a sequence of "0" and "1" symbols, where "1" symbol means an opaque pixel and "0" symbol means a -transparent pixel. The width of the texture correspond to the length +transparent pixel. The width of the texture corresponds to the length of the longest line in the file, expanded to the nearest byte-aligned value. The height of the texture is equal to the number of non-empty lines in the file. Note that missing symbols are replaced by "0". diff --git a/doc/salome/gui/SMESH/input/scale.doc b/doc/salome/gui/SMESH/input/scale.doc index 5b10fb5a5..b833903b6 100644 --- a/doc/salome/gui/SMESH/input/scale.doc +++ b/doc/salome/gui/SMESH/input/scale.doc @@ -69,17 +69,17 @@ name in the adjacent box); Example of using: -1. Create quandrangle mesh 3x3 on simple planar face (200x200) +1. Create quandrangle mesh 3x3 on a simple planar face (200x200) \image html scaleinit01.png -and union 3 face (along axis Z) to group "gr_faces" +and union 3 faces (along axis Z) to group "gr_faces" \image html scaleinit02.png -2. Perform scale operation for whole mesh with creation of new mesh: +2. Perform scale operation for the whole mesh and create a new mesh: \image html scale03.png @@ -89,7 +89,7 @@ result after operation: -3. Perform scale operation for whole mesh with copy of elements: +3. Perform scale operation for the whole mesh and copy elements: \image html scale04.png @@ -99,7 +99,7 @@ result after operation: -4. Perform scale operation for group of faces with copy of elements: +4. Perform scale operation for a group of faces and copy elements: \image html scale06.png @@ -109,7 +109,7 @@ result after operation: -5. Perform scale operation for two edges with moving of elements: +5. Perform scale operation for two edges and move elements: \image html scale07.png @@ -119,7 +119,7 @@ result after operation: -6. Perform scale operation for one face with moving of elements: +6. Perform scale operation for one face and move elements: \image html scale09.png diff --git a/doc/salome/gui/SMESH/input/split_to_tetra.doc b/doc/salome/gui/SMESH/input/split_to_tetra.doc index 57efb37eb..4817a3f2f 100644 --- a/doc/salome/gui/SMESH/input/split_to_tetra.doc +++ b/doc/salome/gui/SMESH/input/split_to_tetra.doc @@ -23,7 +23,7 @@ The following dialog box will appear:
            • The main list contains the list of volumes. You can click on a volume in the 3D viewer and it will be highlighted (lock Shift keyboard button to select several volumes). Click \b Add button and -the ID of this volume will be added to the list. To remove a +the ID of this volume will be added to the list. To remove the selected element or elements from the list click \b Remove button. Sort list button allows to sort the list of IDs. \b Filter button allows to apply a definite filter to the selection of volumes. @@ -40,12 +40,12 @@ volumes of the currently displayed mesh or submesh.
            • Into 5 tetrahedra and Into 6 tetrahedra allows to specify the number of tetrahedra a hexahedron will be split into. If the specified method does not allow to get a conform mesh, a generic solution is applied: an additional node -is created at gravity center of a hexahedron, serving an apex of tetrahedra, all quadrangle sides of the hexahedron are split into two triangles each serving a base of a new tetrahedron.
              • +is created at the gravity center of a hexahedron, serving an apex of tetrahedra, all quadrangle sides of the hexahedron are split into two triangles each serving a base of a new tetrahedron.
            • -
          • Select from set of fields allows to choose a submesh or an +
          • Select from a set of fields allows to choose a submesh or an existing group whose elements will be automatically added to the list.
          diff --git a/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc b/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc index 80944666e..1aa91d9d5 100644 --- a/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc +++ b/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc @@ -536,7 +536,8 @@ radial_Quad_algo = mesh.Quadrangle(algo=RADIAL_QUAD) # In this case it uses "Default Nb of Segments" preferences parameter to discretize edges mesh.Compute() -# The Radial Quadrange uses global or local 1d hypotheses if no its own hypotheses assigned. +# The Radial Quadrange uses global or local 1d hypotheses if it does +# not have its own hypotheses. # Define global hypotheses to discretize radial edges and a local one for circular edge global_Nb_Segments = mesh.Segment().NumberOfSegments(5) local_Nb_Segments = mesh.Segment(circle).NumberOfSegments(10) diff --git a/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc b/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc index 1658e58c5..c55b2a492 100644 --- a/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc @@ -62,16 +62,16 @@ Nb_Segments_1.SetDistrType( 0 ) Quadrangle_2D = Mesh1.Quadrangle() isDone = Mesh1.Compute() -#Perform scale opration for whole mesh with creation of new mesh +#Perform scale opration for the whole mesh and creation of a new mesh newMesh = Mesh1.ScaleMakeMesh(Mesh1,SMESH.PointStruct(100,100,200),[0.5,0.3,0.7],True,"ScaledMesh") -#Perform scale operation for whole mesh with copy of elements +#Perform scale operation for the whole mesh and copy elements Mesh1.Scale(Mesh1,SMESH.PointStruct(200,100,100),[0.5,0.5,0.5],True,True) -#Perform scale opration for two edges with moving of elements +#Perform scale opration for two edges and move elements Mesh1.Scale([1,2],SMESH.PointStruct(-100,100,100),[0.8,1.0,0.7],False) -#Perform scale opration for one face with moving of elements +#Perform scale opration for one face and move elements Mesh1.Scale([21],SMESH.PointStruct(0,200,200),[0.7,0.7,0.7],False) \endcode diff --git a/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc b/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc index 207c4dda5..17f4c5f7f 100644 --- a/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc +++ b/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc @@ -37,9 +37,9 @@ Faces, Edges or both.
        • 2D Quadratic - allows to select between the representation of quadratic edges as broken lines or as arcs
        • Orientation of faces - shows vectors of orientation of -faces of the selected mesh. Vector is shown for each 2D mesh element -and for each free face of 3D mesh element. Vector direction is calculated by -the first three nodes of face as a cross product of vectors n1-n2 and n1-n3.
          • +faces of the selected mesh. The orientation vector is shown for each 2D mesh element +and for each free face of a 3D mesh element. the vector direction is calculated by +the first three nodes of the face produced by vectors n1-n2 and n1-n3.
        • \subpage colors_size_page "Colors / Size" - allows to select color and size of meshes.
        • \subpage transparency_page "Transparency" - allows to change the