From: maintenance team Date: Fri, 20 Feb 2009 14:12:39 +0000 (+0000) Subject: Update SMESH documentation X-Git-Tag: V5_1_1a1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e7c421ee2a70216b7f739e3bb4d484fc60517682;p=modules%2Fsmesh.git Update SMESH documentation --- diff --git a/doc/salome/gui/SMESH/images/rotation2.png b/doc/salome/gui/SMESH/images/rotation2.png new file mode 100755 index 000000000..366771a69 Binary files /dev/null and b/doc/salome/gui/SMESH/images/rotation2.png differ diff --git a/doc/salome/gui/SMESH/input/about_quality_controls.doc b/doc/salome/gui/SMESH/input/about_quality_controls.doc index 9872b6c9f..0d7ab61b0 100644 --- a/doc/salome/gui/SMESH/input/about_quality_controls.doc +++ b/doc/salome/gui/SMESH/input/about_quality_controls.doc @@ -17,7 +17,7 @@ There are 0D, 1D, 2D and 3D quality controls. 0D mesh quality controls: 1D mesh quality controls: @@ -29,6 +29,7 @@ There are 0D, 1D, 2D and 3D quality controls. 2D mesh quality controls: -
  • Click the \b Apply or \b OK button.
    • +
  • Click \b Apply or Apply and Close button to confirm the operation.
    • \image html image77.jpg "The mesh with an edge selected for extrusion" diff --git a/doc/salome/gui/SMESH/input/extrusion_along_path.doc b/doc/salome/gui/SMESH/input/extrusion_along_path.doc index d35d23315..31174dde2 100644 --- a/doc/salome/gui/SMESH/input/extrusion_along_path.doc +++ b/doc/salome/gui/SMESH/input/extrusion_along_path.doc @@ -88,26 +88,27 @@ path     item or click "Extrusion along a path" button in the toolbar. \image html image101.png
    "Extrusion along a path" button
    -The following dialog box will appear: +The following dialog common for line and planar elements will appear: \image html extrusion1.png - -\image html extrusion2.png -
  • In the dialog box you should: +
  • In this dialog:
    • -
  • Generate Groups checkbox allows copying the groups of +
  • activate Generate Groups checkbox if it is necessary to copy the groups of elements of the source mesh to the newly created one.
    • @@ -149,7 +150,9 @@ At each step the shape will be rotated by angle/nb. of steps. -
  • Click the \b Apply or \b OK button. Mesh edges will be extruded into + +
  • Click \b Apply or Apply and Close button to confirm the operation. +Mesh edges will be extruded into faces, faces into volumes. The external surface of the resulting 3d mesh (if faces have been extruded) is covered with faces, and corners with edges. If the path is closed, the resulting mesh can contain diff --git a/doc/salome/gui/SMESH/input/free_faces.doc b/doc/salome/gui/SMESH/input/free_faces.doc index 4a87b992a..68a986efd 100644 --- a/doc/salome/gui/SMESH/input/free_faces.doc +++ b/doc/salome/gui/SMESH/input/free_faces.doc @@ -2,14 +2,14 @@ \page free_faces_page Free faces -\n This mesh quality control highlights faces which are connected -less than to two mesh volume elements. Free faces are shown with a color differs from -the color of shared faces. +\n This mesh quality control highlights the faces connected +less than to two mesh volume elements. The free faces are shown with a +color different from the color of shared faces. \image html free_faces.png -
    In this picture some volume mesh element are removed as -a result some faces become connected only to one -volume. i.e. become free. +
    In this picture some volume mesh elements have been, as +a result some faces became connected only to one +volume. i.e. became free.
    See Also a sample TUI Script of a \ref tui_free_faces "Free Faces quality control" operation. diff --git a/doc/salome/gui/SMESH/input/free_nodes.doc b/doc/salome/gui/SMESH/input/free_nodes.doc index 13f314309..1caaf9e4b 100644 --- a/doc/salome/gui/SMESH/input/free_nodes.doc +++ b/doc/salome/gui/SMESH/input/free_nodes.doc @@ -2,13 +2,12 @@ \page free_nodes_page Free nodes -\n This mesh quality control highlights nodes which are not connected -to any mesh element. Free nodes are shown with a color differs from -the color of nodes. +\n This mesh quality control highlights the nodes which are not connected +to any mesh element. \image html free_nodes.png -
    In this picture some nodes don't connected to a mesh element as -a result of deleting elements and adding several isolated nodes. +
    In this picture some nodes are not connected to any mesh +element after deleting some elements and adding several isolated nodes.
    See Also a sample TUI Script of a \ref tui_free_nodes "Free Nodes quality control" operation. diff --git a/doc/salome/gui/SMESH/input/modifying_meshes.doc b/doc/salome/gui/SMESH/input/modifying_meshes.doc index d3149b730..f7a882524 100644 --- a/doc/salome/gui/SMESH/input/modifying_meshes.doc +++ b/doc/salome/gui/SMESH/input/modifying_meshes.doc @@ -47,4 +47,7 @@ of the selected node or edge.
    • or vice versa. +\note It is possible to use the variables defined in the SALOME \b NoteBook + to specify the numerical parameters used for modification of any object. + */ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/preview_meshes.doc b/doc/salome/gui/SMESH/input/preview_meshes.doc deleted file mode 100644 index 92a4cca27..000000000 --- a/doc/salome/gui/SMESH/input/preview_meshes.doc +++ /dev/null @@ -1,36 +0,0 @@ -/*! - -\page preview_meshes_page Preview and Compute meshes - -Before whole mesh computation it is allowed to see the mesh preview. -When mesh object is already created and all hypotheses assigned, -select your mesh in the Object Browser. From the -\b Mesh menu select \b Preview or click "Preview" button of the -toolbar or activate "Preview" item from pop-up menu. - -\image html mesh_precompute.png -
    "Preview" button
    - -The Mesh Preview dialog box appears. In this dialog box you can select -preview mode 1D mesh or 2D mesh depending on assigned -hypotheses to mesh. - -The 1D mesh preview shows as nodes computed on geometry edges - -\image html preview_mesh_1D.png - -The 2D mesh preview shows edge mesh elements, computed on geometry faces - -\image html preview_mesh_2D.png - -Pressing Compute button leads to whole mesh computation -process. -During exit from Preview dialog box, the question about storage temporary -created mesh elements appers: - -\image html preview_tmp_data.png - -Note, that computed temporary mesh elements can be reused during next -mesh computation process. - -*/ diff --git a/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc b/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc index 6e0f7f804..6cd891573 100644 --- a/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc +++ b/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc @@ -29,15 +29,17 @@ The following dialog box will appear: \image html removenodes.png -In this dialog box you can specify one or several nodes +In this dialog box you can specify one or several nodes: + + @@ -65,13 +67,14 @@ The following dialog box will appear: In this dialog box you can specify one or several elements +
  • Click \b Apply or Apply and Close to confirm deletion of the specified elements.
    • diff --git a/doc/salome/gui/SMESH/input/revolution.doc b/doc/salome/gui/SMESH/input/revolution.doc index 67dfdb374..503799d4e 100644 --- a/doc/salome/gui/SMESH/input/revolution.doc +++ b/doc/salome/gui/SMESH/input/revolution.doc @@ -16,31 +16,40 @@ on the revolution axis). \image html image92.png
    "Revolution" button
    -The following dialog box shall appear: +The following dialog common for line and planar elements will appear: \image html revolution1.png -\image html revolution2.png
  • -In this dialog box you should specify: +In this dialog you should specify: +
    • + +
  • specify the tolerance for the operation
    • -
  • Preview checkbox allows showing the results of parameter-setting in the viewer
    • -
  • Generate Groups checkbox allows copying the groups of +
  • activate Preview checkbox to show the parameter-setting in the viewer
    • +
  • activate Generate Groups checkbox to copy the groups of elements of the source mesh to the newly created one.
    • -
  • Click the \b Apply or \b OK button.
    • +
  • Click \b Apply or Apply and Close button to confirm the +operation.
    • diff --git a/doc/salome/gui/SMESH/input/rotation.doc b/doc/salome/gui/SMESH/input/rotation.doc index e64357276..79d27d7c1 100644 --- a/doc/salome/gui/SMESH/input/rotation.doc +++ b/doc/salome/gui/SMESH/input/rotation.doc @@ -2,41 +2,69 @@ \page rotation_page Rotation -\n This operation allows to rotate in space your mesh or +\n This operation allows to rotate in space the mesh or some of its elements. +To rotate the mesh: + +
      +
    1. From the \b Modification menu choose \b Transformation -> \b Rotation item or click +"Rotation" button in the toolbar. + \image html rotation_ico.png "Rotation button" -To rotate your mesh: -\par -From the \b Modification choose \b Transformation and from its sub-menu -select the \b Rotation item. The following dialog box shall appear: +The following dialog will appear: \image html rotation.png -\par -In this dialog box you can specify the elements which should be -rotated + +
      2. + +
    2. +In this dialog: +
        +
      • specify the IDs of the elements which will be rotated: +
          -
        • Check on Select the whole mesh, submesh or group option -
        • Choosing them manually with the mouse in the 3D Viewer. You can -click on an element in the 3D viewer and it will be highlighted
          • -
        • Applying Filters. The Set filter button allows to apply a -definite filter to selection of the elements. See more -about filters on the -\ref selection_filter_library_page "Selection filter library" page.
          • +
        • Select the whole mesh, submesh or group activating this +checkbox; 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.
        - and the rotation parameters: +
        • + +
      • specify the axis of rotation:
          -
        • \b Axis: point and vector
          • -
        • \b Angle of rotation
          • +
        • specify the cooordinates of the start \b Point of the vector of rotation;
          • +
        • specify the \b Vector of rotation through the coordinates of its +end point with respect to the coordinates of the start point;
        +
        • +
      • specify the \b Angle of rotation
        • + +
      • specify the conditions of rotation: +
          +
        • activate Move elements radio button to create the source +mesh (or elements) at the new location and erase it from the previous location;
          • +
        • activate Copy elements radio button to create the source +mesh (or elements) at the new location, but leave it at the previous +location, the source mesh will be considered one and single mesh with the result of the rotation;
          • +
        • activate Create as new mesh radio button to leave the +source mesh (or elements) at its previous location and create a new +mesh at the new location, the new mesh appears in the Object Browser +with the default name MeshName_rotated (it is possible to change this +name in the adjacent box);
          • +
        • activate Copy groups checkbox to copy the groups of elements of the source mesh to the newly created mesh.
          • +
        +
        • + +
      • Click \b Apply or Apply and Close button to confirm the +operation.
        • -\n Toggle the corresponding checkbox to Select whole mesh, submesh or group. -\n When Move elements radio button is selected, the source mesh (or elements) is created at the new location and erased from its previous location -\n When Copy elements radio button is selected,the source mesh (or elements) is created at the new location, but it also remains at its previous location and is considered one and single mesh with the result of the rotation. -\n When Create as new mesh radio button is selected, the source mesh (or elements) remains at its previous location and a new mesh is created at the new location and appears in the Object Browser with the default name MeshName_rotated (you can change this name in the adjacent box). -\n Copy groups checkbox allows copying the groups of elements of the source mesh to the newly created one. -\par +
    \image html rotation1.png "The initial mesh" diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc index da38dfd76..94dd3844c 100644 --- a/doc/salome/gui/SMESH/input/selection_filter_library.doc +++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc @@ -66,20 +66,19 @@ shape, the algorithm works slower. IDs. Threshold Value can be, for example: "1,2,3,50-60,63,67,70-78"
  • -Color of Group allows selection of entities belonging to Group with -specified color defined by the Threshold Value. +Color of Group allows selection of entities belonging to the Group with +the color defined by the Threshold Value.
    • -Some criteria are applicable to all Entity types: except for +Some criteria are applicable to all Entity types, except for Nodes @@ -97,14 +96,6 @@ specified arbitrary surface within a given Tolerance. -Additional criteria to select mesh Nodes are the following: - - Additional criteria to select mesh Edges are the following: