From: vsr Date: Thu, 12 Dec 2013 14:35:44 +0000 (+0000) Subject: Update documentation X-Git-Tag: V7_3_0~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=3cd8d693a93135ca68e9bfe2d1a8838716c19a80;p=modules%2Fsmesh.git Update documentation --- diff --git a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc index 5deb1344a..470fe0c4d 100644 --- a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc @@ -20,22 +20,21 @@

Adaptive hypothesis

Adaptive hypothesis allows to split edges into segments with a -length that depends on curvature of edges and faces and is limited -from up and down. In addition length of a segment depends on lengths -of adjacent segments (that can't differ more than twice) and on +length that depends on the curvature of edges and faces and is limited by Min. Size +and Max Size. The length of a segment also depends on the lengths +of adjacent segments (that can't differ more than twice) and on the distance to close geometrical entities (edges and faces) to avoid creation of narrow 2D elements. \image html adaptive1d.png -Min size parameter limits minimal segment size. Max size -parameter defines length of segments on stright edges. \b Deflection -parameter gives maximal distance of a segment from a curved edge. +- Min size parameter limits the minimal segment size. +- Max size parameter defines the length of segments on straight edges. +- \b Deflection parameter gives maximal distance of a segment from a curved edge. -\image html adaptive1d_sample_mesh.png "A geometry and a mesh generated on this geometry using Adaptive hypothesis and Netgen 2D algorithm - the size of mesh segments reflects size of geometrical features" +\image html adaptive1d_sample_mesh.png "Adaptive hypothesis and Netgen 2D algorithm - the size of mesh segments reflects the size of geometrical features" -See Also a \ref tui_1d_adaptive "sample TUI Script" that -creates the mesh of the above image. +See Also a \ref tui_1d_adaptive "sample TUI Script" that creates mesh of the above image.
\anchor arithmetic_1d_anchor diff --git a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc index c5095b1bf..38efc810c 100644 --- a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc @@ -2,14 +2,10 @@ \page a2d_meshing_hypo_page 2D Meshing Hypotheses -
- +- \ref max_element_area_anchor "Max Element Area" +- \ref length_from_edges_anchor "Length from Edges" +- \ref hypo_quad_params_anchor "Quadrangle parameters" -
\anchor max_element_area_anchor

Max Element Area

@@ -25,10 +21,8 @@ which will compose the mesh of these faces. \image html max_el_area.png "In this example, Max. element area is very small compared to the 1D hypothesis" See Also a sample TUI Script of a -\ref tui_max_element_area "Maximum Element Area" hypothesis -operation. +\ref tui_max_element_area "Maximum Element Area" hypothesis operation. -
\anchor length_from_edges_anchor

Length from Edges

@@ -39,7 +33,6 @@ of a given face. See Also a sample TUI Script of a \ref tui_length_from_edges "Length from Edges" hypothesis operation. -
\anchor hypo_quad_params_anchor

Quadrangle parameters

@@ -72,37 +65,34 @@ shows the good (left) and the bad (right) results of meshing. segments on opposite sides to define the algorithm of transition between them. The following types are available: - + the transition area is located along the coarser meshed sides. +- Reduced type forces building only quadrangles and the transition + between the sides is made gradually, layer by layer. This type has + a limitation on the number of segments: one pair of opposite sides must have + the same number of segments, the other pair must have an even difference + between the numbers of segments on the sides. In addition, the number + of rows between sides with different discretization + should be enough for the transition. Following the fastest transition + pattern, three segments become one (see the image below), hence + the least number of face rows needed to reduce from Nmax segments + to Nmin segments is log3( Nmax / Nmin ). The number of + face rows is equal to the number of segments on each of equally + discretized sides. + \image html reduce_three_to_one.png "The fastest transition pattern: 3 to 1" See Also a sample TUI Script of a \ref tui_quadrangle_parameters "Quadrangle Parameters" hypothesis. diff --git a/doc/salome/gui/SMESH/input/clipping.doc b/doc/salome/gui/SMESH/input/clipping.doc index 6be9878e9..f28b88001 100644 --- a/doc/salome/gui/SMESH/input/clipping.doc +++ b/doc/salome/gui/SMESH/input/clipping.doc @@ -2,27 +2,26 @@ \page clipping_page Clipping -\n Using this menu you can create cross-section views (clipping planes) +\b Clipping allows creating cross-section views (clipping planes) of your mesh. -To start, click on the \em New button. +It is available as a sub-item in the context menu of an active mesh. -Now you must specify what mode of creating plane you want to choose: -absolute or relative. +To create a clipping plane, click on the \b New button in the dialog and choose how it is defined: by \b Absolute or \b Relative coordinates. -Absolute mode +Absolute Coordinates \image html Clipping_Absolute.png -- Base point - allows to define the coordinates of the base +- Base point - allows defining the coordinates of the base point for the clipping plane. - Reset - returns the base point to coordinate origin. -- Direction - allows to define the orientation of the +- Direction - allows defining the orientation of the clipping plane. - - Invert - allows to select which part of the object will be + - Invert - allows selecting, which part of the object will be removed and which will remain after clipping. Relative mode @@ -30,42 +29,34 @@ absolute or relative. \image html Clipping_Relative.png - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z). + - \b Distance between the opposite extremities of the boundary box of selected objects, if it is set to 0.5 the boundary box is split in two halves. + - \b Rotation (in angle degrees) around X (Y to Z) and around Y (X to Z) (depending on the chosen Orientation) -The parameters of cross-section: - -List of meshes, sub-meshes and groups to which the cross-section will be applied. - -Select all button allows to select and deselect all available -objects at once. - -If the Show preview button is on, you can see the clipping plane -in the 3D Viewer. +\image html before_clipping_preview.png "The preview plane and the cut object" -\image html before_clipping.png "The plane and the cut object" +The other parameters are available in both modes : -Also there the possibility to interact directly with the clipping plane in 3D -view with mouse. User can change the parameters of clipping plane by dialog data -or by hand. +- OpenGL clipping check-box allows choosing OpenGL native clipping, which clips the whole presentation. If it is unchecked, the clipping is done on the dataset i.e. only the visibility of separate mesh cells is changed (see the examples). +- The List contains Meshes, sub-meshes and groups to which the cross-section will be applied. +- Select all check-box allows to selecting and deselecting all available objects at once. +- Show preview check-box shows the clipping plane in the 3D Viewer. +- Auto Apply check-box shows button is on, you can preview the +cross-section in the 3D Viewer. -\image html before_clipping_preview.png "The preview plane and the cut object" +It is also possible to interact with the clipping plane directly in 3D +view using the mouse. -If the Auto Apply button is on, you can preview the -cross-section in the 3D Viewer. +To get a new object from \b Clipping, click \b Apply. -Also, it is possible to specify the type of clipping: using dataset, -i.e. it only changes the visibility of separate mesh cells or alternative -clipping - an OpenGL native one, which clips overall presentation. -For choosing use OpenGL clipping checkbox. +Examples: \image html dataset_clipping.png "The cross-section using dataset" - \image html opengl_clipping.png "The OpenGL cross-section" -To get a new object from \b Clipping, click \b Apply. */ diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index 2255641b3..0671f8909 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -314,8 +314,8 @@ or/and hidden by other mesh elements. They can be seen after switching the mesh to Wireframe visualization mode or switching off the visualization of faces and volumes (if any). -Bad Mesh to Group button creates groups of the bad mesh entities, -thus allowing you for more comfortable analysis of these entities. +Bad Mesh to Group button creates groups of bad mesh entities +to facilitate their analysis. \image html show_bad_mesh.png Edges bounding a hole in the surface are shown in magenta using Show @@ -341,8 +341,8 @@ this, there exist two algorithms: Use existing edges and Use For example, you want to use standard algorithms to generate 1D and 3D meshes and to create 2D mesh by your python code. Then you
    -
  1. create a mesh object, assign an 1D algorithm,
    2. -
  2. invoke \b Compute command, which computes an 1D mesh,
    3. +
  3. create a mesh object, assign a 1D algorithm,
    4. +
  4. invoke \b Compute command, which computes a 1D mesh,
  5. assign Use existing faces and a 3D algorithm,
  6. run your python code, which creates a 2D mesh,
  7. invoke \b Compute command, which computes a 3D mesh.
    8. diff --git a/doc/salome/gui/SMESH/input/cutting_quadrangles.doc b/doc/salome/gui/SMESH/input/cutting_quadrangles.doc index 52b3b1ea6..222ea8379 100644 --- a/doc/salome/gui/SMESH/input/cutting_quadrangles.doc +++ b/doc/salome/gui/SMESH/input/cutting_quadrangles.doc @@ -2,13 +2,13 @@ \page cutting_quadrangles_page Cutting quadrangles -\n This operation allows cutting one or several quadrangle elements -into two or four triangles. +This operation allows cutting one or several quadrangle elements into two or four triangles. To cut quadrangles: -
      -
    1. Display a mesh, a 2D sub-mesh or a group of faces in the 3D viewer.
      2. -
    2. In the \b Modification menu select the Cutting of quadrangles item or + +1) Display a mesh, a 2D sub-mesh or a group of faces in the 3D viewer. + +2) In the \b Modification menu select the Cutting of quadrangles item or click "Cutting of quadrangles" button in the toolbar. \image html image82.png @@ -18,50 +18,27 @@ The following dialog box will appear: \image html a-cuttingofquadrangles.png -
        -
      • The main list contains the list of quadrangles selected for cutting. You can - click on an quadrangle in the 3D viewer and it will be highlighted (lock Shift - keyboard button to select several quadrangles). Click \b Add button and the ID of - this quadrangle will be added to the list. To remove a 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 - quadrangles.
        • -
      • Apply to all check box allows to cut all quadrangles of the selected mesh, - sub-mesh or group.
        • -
      • \b Preview provides a preview of cutting in the viewer. It is disabled for Cut - into 4 triangles as this cutting way implies no ambiguity.
        • -
      - -
        -
      • \b Criterion defines a cutting way. -
          -
        • Cut into 4 triangles selects cutting the quadrangle into four triangles by - inserting a new node at the center of quadrangle. The other options selects cutting - the quadrangle into two triangles by connecting nodes of either of the two diagonals. -
        • Use diagonal 1-3 and Use diagonal 2-4 allows to specify the - opposite corners which will be connected to form two new triangles.
          • -
        • Use numeric functor allows to choose a quality metric which will be - optimized when choosing a diagonal for cutting a quadrangle. -
            -
          • Minimum diagonal cuts by the shortest diagonal.
            • -
          • Aspect Ratio cuts by the diagonal splitting the quadrangle into - triangles with \ref aspect_ratio_page "Aspect Ratio" closer to 1.
            • -
          • Minimum Angle cuts by the diagonal splitting the quadrangle into - triangles with \ref minimum_angle_page "Minimum Angle" closer to 60 - degrees.
            • -
          • Skew cuts by the diagonal splitting the quadrangle into triangles - with \ref skew_page "Skew" closer to 0.0 degrees.
            • -
          -
          • -
        -
        • -
      • Select from allows to choose a sub-mesh or an existing group whose - quadrangle elements will be automatically added to the main list.
        • -
      -
      3. -
    3. Click the \b Apply or Apply and Close button to confirm the operation.
      4. -
    +- The main list contains the list of quadrangles selected for cutting. You can +click on a quadrangle in the 3D viewer and it will be highlighted (lock Shift +keyboard button to select several quadrangles): + - Click \b Add button and the ID of this quadrangle will be added to the list. + - To remove a selected element or elements from the list click \b Remove button. + - Sort list button allows sorting the list of IDs. + - \b Filter button allows applying a definite filter to the selection of quadrangles. +- Apply to all check box allows cutting all quadrangles of the selected mesh, sub-mesh or group. +- \b Preview provides a preview of cutting in the viewer. It is disabled for Cut into 4 triangles as this cutting way implies no ambiguity. +- \b Criterion defines the way of cutting: + - Cut into 4 triangles allows cutting a quadrangle into four triangles by inserting a new node at the center of the quadrangle. The other options allow cutting a quadrangle into two triangles by connecting the nodes of a diagonal. + - Use diagonal 1-3 and Use diagonal 2-4 allow specifying the opposite corners, which will be connected to form two new triangles. + - Use numeric functor allows selecting in the field below a quality metric, which will be optimized when choosing a diagonal for cutting a quadrangle: + - Minimum diagonal cuts by the shortest diagonal. + - Aspect Ratio cuts by the diagonal splitting the quadrangle into triangles with \ref aspect_ratio_page "Aspect Ratio" closer to 1 + - Minimum Angle cuts by the diagonal splitting the quadrangle into triangles with \ref minimum_angle_page "Minimum Angle" closer to 60 degrees. + - Skew cuts by the diagonal splitting the quadrangle into triangles with \ref skew_page "Skew" closer to 0.0 degrees. +- Select from allows choosing a sub-mesh or an existing group, whose quadrangle elements will be automatically added to the main list. + +3) Click the \b Apply or Apply and Close button to confirm the operation. \image html image52.jpg "The chosen quadrangular element" diff --git a/doc/salome/gui/SMESH/input/double_nodes_page.doc b/doc/salome/gui/SMESH/input/double_nodes_page.doc index 0c4c1eb2c..817a7e40a 100644 --- a/doc/salome/gui/SMESH/input/double_nodes_page.doc +++ b/doc/salome/gui/SMESH/input/double_nodes_page.doc @@ -2,8 +2,8 @@ \page double_nodes_page Duplicate Nodes or/and Elements -\n This operation allows to duplicate nodes or/and elements of your mesh. -Duplication of nodes can be useful to emulate a crack in the model. +\n This operation allows duplicating mesh nodes or/and elements, which can be useful to emulate a crack in the model. + Duplication consists in creation of mesh element "equal" to existing ones. To duplicate nodes or/and elements: @@ -31,9 +31,8 @@ Duplication consists in creation of mesh element "equal" to existing ones.
    \anchor mode_without_elem_anchor -

    Duplicate nodes only

    -In this mode the dialog looks like: +

    Duplicate nodes only

    \image html duplicate01.png @@ -42,28 +41,26 @@ Parameters to be defined in this mode:
  8. Group of nodes to duplicate (mandatory): these nodes will be duplicated.
  9. Group of elements to replace nodes with new ones - (optional): the new nodes will replace the nodes to - duplicate within these elements.
    10. + (optional): the new nodes will replace the duplicated nodes within these elements.
  10. Construct group with newly created nodes option - (checked by default): if checked - the group with just + (checked by default): if checked - the group with newly created nodes will be built.
    11. -A schema below explains the crack emulation using the node duplication. +A schema below illustrates how the crack is emulated using the node duplication. \image html crack_emulation_double_nodes.png "Crack emulation" This schema shows a virtual crack in a 2D mesh created using this duplication -mode. In this schema: -- Black balls are nodes to duplicate. +mode: +- Black balls are duplicated nodes. - Red balls are new nodes. - Elements to replace nodes with new ones are marked with green. -Note that in reality nodes to duplicate coincide with new nodes. - +Note that in the reality duplicated nodes coincide with new nodes.
    \anchor mode_with_elem_anchor -

    Duplicate nodes and border elements

    -In this mode the dialog looks like: + +

    Duplicate nodes and border elements

    \image html duplicate02.png @@ -77,10 +74,10 @@ Parameters to be defined in this mode: (mandatory): the new nodes will replace the nodes to duplicate within these elements.
  11. Construct group with newly created elements option - (checked by default): if checked - the group of just created + (checked by default): if checked - the group of newly created elements will be built.
  12. Construct group with newly created nodes option - (checked by default): if checked - the group of just + (checked by default): if checked - the group of newly created nodes will be built.
    13. @@ -89,15 +86,14 @@ with border elements. \image html crack_emulation_double_nodes_with_elems.png "Crack emulation" This schema shows a virtual crack in a 2D mesh created using this duplication mode. In this schema: -- Black segments are elements to duplicate (edges in 2D case). -- Black balls (except the lowest one) are nodes of elements to - duplicate that are duplicated. -- The lowest black ball is a node not to duplicate. -- Red balls are creates nodes. +- Black segments are duplicated elements (edges in 2D case). +- Black balls (except for the lowest one) are duplicated nodes of duplicated elements. +- The lowest black ball is the non-duplicated node. +- Red balls are newly created nodes. - Red segments are created elements (edges). - Elements to replace nodes with new ones are marked with green. -Note that in reality nodes to duplicate coincide with new nodes. +Note that in the reality nodes to duplicate coincide with new nodes.
    In a 3D case, where elements to duplicate are faces, the edges located at the "crack" (if any) are cloned automatically. @@ -106,24 +102,22 @@ located at the "crack" (if any) are cloned automatically. \anchor mode_elem_only_anchor

    Duplicate elements only

    -This mode just duplicates given elements, i.e. creates new elements on -the same nodes as the given elements. +This mode duplicates the given elements, i.e. creates new elements with the same nodes as the given elements. +
    -In this mode the dialog looks like: + \image html duplicate03.png -Parameters to be defined in this mode:
    • Group of elements to duplicate (mandatory): these elements will be duplicated.
    • Construct group with newly created elements option - (checked by default): if checked - the group of just created - elements will be built. A name of the created group starts from + (checked by default): if checked - the group of newly created + elements will be built. The name of the created group starts from "DoubleElements".
    -
    See Also a sample TUI Script of a \ref tui_duplicate_nodes "Duplicate nodes or/and elements" operation. diff --git a/doc/salome/gui/SMESH/input/extrusion_along_path.doc b/doc/salome/gui/SMESH/input/extrusion_along_path.doc index d58f9697f..4de60e535 100644 --- a/doc/salome/gui/SMESH/input/extrusion_along_path.doc +++ b/doc/salome/gui/SMESH/input/extrusion_along_path.doc @@ -1,8 +1,8 @@ /*! -\page extrusion_along_path_page Extrusion along a path +\page extrusion_along_path_page Extrusion along Path -\n In principle, Extrusion along a path works in the same way +\n In principle, Extrusion along Path works in the same way as \b 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. To get an idea of how this algorithm works, examine several examples, @@ -69,7 +69,7 @@ mesh.
    The same, but using angles {45, -45, 45, -45, 45, -45, 45, -45}
    -
    To use Extrusion along a path: +
    To use Extrusion along Path:
    1. From the \b Modification menu choose the Extrusion along a path item or click "Extrusion along a path" button in the toolbar. @@ -88,25 +88,24 @@ The following dialog common for line and planar elements will appear:
    2. specify the IDs of the elements which will be extruded
        -
      • Select the whole mesh, submesh or group activating this -checkbox; or
        • -
      • choose mesh elements with the mouse in the 3D Viewer. It is +
      • Select the whole mesh, sub-mesh or group activating the corresponding 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 +
      • 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.
      3. -
    3. define the \b Path along which the elements will be extruded.
      +
    4. 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 proceeds the extrusion
      • Start node - the start node. It is used to define the direction of extrusion
      5. -
    5. activate Generate Groups checkbox if it is necessary to copy the groups of +
    6. Activate Generate Groups check-box if it is necessary to copy the groups of elements of the source mesh to the newly created one.
      7. @@ -119,9 +118,8 @@ curve. By default, the Base Point around which the elements are rotated i the mass center of the elements, however, you can specify any point as the Base Point and the elements will be rotated with respect to this point.
      - Note that it is the Base Point whos track exactly equals to the - path, and all the elements being extruded just keep their relative - position around the Base Point at each iteration. + Note that only the displacement of the Base Point exactly equals to the + path, and all other extruded elements simply keep their position relatively to the Base Point at each iteration.
    7. The elements can also be rotated around the path to get the resulting mesh in a helical fashion. You can set the values of angles at the diff --git a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc index 6519aa16d..516981cd9 100644 --- a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc +++ b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc @@ -38,21 +38,20 @@ group as a whole mesh. \image html meshexportmesh.png -At export to MED and SAUV format files additional parameters are available. + There are additional parameters available at export to MED and SAUV format files.
      • Automatically create groups check-box specifies whether to create groups of all mesh entities of available dimensions or not. If checked, the created groups have names like "Group_On_All_Nodes", - "Group_On_All_Faces" etc.
        • + "Group_On_All_Faces", etc.
      • Automatically define space dimension check-box specifies whether to define space dimension for export by mesh configuration or not. Usually the mesh is exported as a mesh in 3D space, just as - it is in Mesh module. The mesh can be exported as a mesh in lower - dimension in following cases, provided that this check-box is - checked. + it is in Mesh module. The mesh can be exported as a mesh of a lower + dimension in the following cases, provided that this check-box is checked:
          -
        • 1D: if all mesh nodes lie on OX coordinate axis.
          • -
        • 2D: if all mesh nodes lie on XOY coordinate plane.
          • +
        • 1D: if all mesh nodes lie on OX coordinate axis.
          • +
        • 2D: if all mesh nodes lie in XOY coordinate plane.
      diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index 917e540bd..9182f97be 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -6,7 +6,7 @@ \n \b MESH module of SALOME is destined for:
        -
      • \ref importing_exporting_meshes_page "import and export of meshes in different formats";
        • +
      • \ref importing_exporting_meshes_page "import and export of meshes in various formats";
      • \subpage about_meshes_page "meshing geometrical models" previously created or imported by the Geometry component;
      • \subpage viewing_meshes_overview_page "viewing created meshes" in @@ -18,22 +18,20 @@ allowing to highlight important elements; \subpage filters_page "Filters" functionality;
      • \subpage modifying_meshes_page "modifying meshes" with a vast array of dedicated operations;
        • -
      • different \subpage measurements_page "measurements" of the mesh objects; -
      • easily setting parameters via the variables predefined in -\subpage using_notebook_mesh_page "Salome notebook".
        • +
      • various \subpage measurements_page "measurements" of the mesh objects.
      -The possibility to sort the created sub-meshes or groups is detailed on -\subpage arranging_study_objects_page section. +It is possible to easily set parameters via the variables predefined in +\subpage using_notebook_mesh_page "Salome notebook". Mesh module preferences are described in the \subpage mesh_preferences_page section of SALOME Mesh Help. +Also, there is a possibility to \subpage arranging_study_objects_page "re-arrange sub-meshes and groups in the SALOME study". Almost all mesh module functionalities are accessible via \subpage smeshpy_interface_page "Mesh module Python interface". Other functions are available in salome.smesh python package. - \image html image7.jpg "Example of MESH module usage for engineering tasks" */ diff --git a/doc/salome/gui/SMESH/input/measurements.doc b/doc/salome/gui/SMESH/input/measurements.doc index 0787b7c20..bfedbe0c8 100644 --- a/doc/salome/gui/SMESH/input/measurements.doc +++ b/doc/salome/gui/SMESH/input/measurements.doc @@ -18,79 +18,72 @@ available, but this operation will be extended in the future to support other mesh objects - elements, meshes, sub-meshes and groups. To start Minimum Distance operation, select Minimum Distance -item from \b Measurements menu. +tab in \b Measurements dialog. \image html min_distance.png -In the dialog box choose the first target and the second target mode by +Choose the first and the second target by switching the corresponding radio buttons, then select the objects the distance between which is to be calculated (or input their IDs directly -in case of nodes/elements) and press \em Compute button. +in case of nodes/elements) and press \b Compute button. -The following types of targets are supported: -- \em Node: single mesh node; -- \em Element: single mesh element (not available in this version); -- \em Object: mesh, sub-mesh or group object (not available in this +The following targets are supported: +- \b Node: single mesh node; +- \b Element: single mesh element (not available in this version); +- \b Object: mesh, sub-mesh or group object (not available in this version); -- \em Origin: origin of the global co-ordinate system. +- \b Origin: origin of the global co-ordinate system. -The result will -be shown in the bottom area of the dialog box. In addition, a simple +The result will be shown in the bottom area of the dialog. In addition, a simple preview will be shown in the 3D viewer. \image html min_distance_preview.png \section bounding_box_anchor Bounding Box -This operation allows to calculate the bounding box of the selected +This operation allows calculating the bounding box of the selected object(s). To start Bounding Box operation, select Bounding Box -item from \b Measurements menu. +tab in \b Measurements dialog. \image html bnd_box.png -In the dialog box choose the required type of the object by switching the -corresponding radio button, select the object(s) and press \em Compute button. +Choose the required type of the object by switching the corresponding radio button, select the object(s) and press \em Compute button. The following types of input are available: -- \em Objects: select one or several mesh, sub-mesh or group objects; -- \em Nodes: select a set of mesh nodes; -- \em Elements: select a set of mesh elements. +- \b Objects: one or several mesh, sub-mesh or group objects; +- \b Nodes: a set of mesh nodes; +- \b Elements: a set of mesh elements. The result of calculation will be shown in the bottom area of the -dialog box. In addition, a simple preview will be shown in the 3D -viewer. +dialog. In addition, a simple preview will be shown in the 3D viewer. \image html bnd_box_preview.png \section basic_properties_anchor Basic Properties -This operation allows calculation of length, area or volume for the the selected -object: -- Length is calculated as a sum of length of all 1D elements; -- Area id a sum of area of all 2D elements -- Volume is a sum of volume of all 3D elements. +This operation provides calculation of length, area or volume for the the selected object: +- \b Length is calculated as a sum of lengths of all 1D elements; +- \b Area is a sum of areas of all 2D elements +- \b Volume is a sum of volumes of all 3D elements. -To start one of Basic Properties calculations, select Length, Area -or Volume item from Measurements - Basic Properties menu. +To start a Basic Properties calculation, select Length, Area or Volume item. \image html basic_props.png -In the dialog box select the required type of calculation (length, area or volume), select -the the object (mesh, sub-mesh or group) and press \em Compute button. +In the dialog box select the required type of calculation (length, area or volume) and the object (mesh, sub-mesh or group) and press \b Compute button. -The result of calculation will be shown in the bottom area of the -dialog box. +The result of calculation will be shown in the bottom area of the dialog. \note -- If mesh consists of 3D elements only, its "length" and "area" will be 0. -- As calculation result is a sum of length, area and volume of all mesh elements, - duplications are not taken into account; i.e. all duplicated elements +- If the mesh consists of 3D elements only, its "length" and "area" will be 0. +- As calculation result is a sum of lengths, areas and volumes of all mesh elements, the + duplication is not taken into account; i.e. all duplicated elements (elements built on the same set of nodes) will be included into the result. - Similarly, intersection of elements is not taken into account. -See Also a sample TUI Script of a +See Also a sample TUI Script of \ref tui_measurements_page "Measurement operations". */ diff --git a/doc/salome/gui/SMESH/input/mesh_infos.doc b/doc/salome/gui/SMESH/input/mesh_infos.doc index d446d2e9d..8ead995f0 100644 --- a/doc/salome/gui/SMESH/input/mesh_infos.doc +++ b/doc/salome/gui/SMESH/input/mesh_infos.doc @@ -124,12 +124,10 @@ preferences (zero value means no limit). \anchor mesh_quality_info_anchor

      Quality Information

      -The Quality Info tab page of the dialog box provides overal -mesh quality controls information on the selected object - mesh, -sub-mesh or mesh group: +The Quality Info tab provides overall information about mesh quality controls on the selected object - mesh, sub-mesh or mesh group: - Name; - Nodes information: - - Number of the free nodes; + - Number of free nodes; - Number of double nodes; - Edges information: - Number of double edges; @@ -145,21 +143,22 @@ sub-mesh or mesh group:
      \image html ctrlinfo.png "Quality Info" page
      -\note User can set "Double nodes tolerance" in the dialog for local change +\note It is possible to set "Double nodes tolerance" in the dialog for a local change or via the "Quality controls" in Mesh preferences. -\note For the perfomance reason, all quality control values for the big meshes are -computed only by demand. For this, the user should press the "compute" -button (see picture). Also, values are automatically computed if the number of the +\note For performance reasons, all quality control values for big meshes are +computed only by demand. For this, press the "compute" +button. Also, values are automatically computed if the number of nodes / elements does not exceed the "Automatic controls compute limit" set -via the "Mesh information" preferences (zero value means no limit). +via the "Mesh information" preferences (zero value means that there is no limit). The button \b "Dump" allows printing the information displayed in the dialog box to a .txt file. In case you get Mesh Information via a TUI script, the information is displayed in the Python Console. -See the \ref tui_viewing_mesh_infos "TUI Example". + +See the \ref tui_viewing_mesh_infos "TUI Example". */ diff --git a/doc/salome/gui/SMESH/input/mesh_preferences.doc b/doc/salome/gui/SMESH/input/mesh_preferences.doc index b93723a3e..02574d07d 100644 --- a/doc/salome/gui/SMESH/input/mesh_preferences.doc +++ b/doc/salome/gui/SMESH/input/mesh_preferences.doc @@ -11,22 +11,21 @@ later sessions with this module. - Automatic Update - If you toggle Automatic Update checkbox, the model in your - viewer automatically updated when you make changes in it, depending on + viewer will be automatically updated when you make changes in it, depending on values of additional preferences specified below. - - Size limit (elements) - allows to specify the maximum + - Size limit (elements) - allows specifying the maximum number of elements in the resulting mesh for which the automatic updating of the presentation is performed. This option affects only Compute operation. Zero value means "no limit". Default value is 500 000 mesh elements. - Incremental limit check - when this control is switched on, - check for mesh size limit will be applied not to total number of - elements in resulting mesh, but iteratively to each entity types - in the following order: 0D elements, edges, faces, volumes, balls; - at each step number of entities of given type will be added to the - total number of elements computed at previous step - if resulting - number of elements does not exceed size limit, the entities of - this type will be shown, otherwise user will be warned that some - entities are not shown. + the mesh size limit check is not applied to the total number of + elements in the resulting mesh, it is applied iteratively to each entity type + in the following order: 0D elements, edges, faces, volumes, balls. + At each step the number of entities of a certain type is added to the + total number of elements computed at the previous step - if the resulting + number of elements does not exceed the size limit, the entities of + this type are shown, otherwise the user is warned that some entities are not shown. - Quality Controls - If you toggle Display entity, both faces and edges of an @@ -68,40 +67,40 @@ later sessions with this module. information is shown: - Simple - as a plain text - Tree - in a tree-like form - - Automatic nodes compute limit - allows to define the size limit for the + - Automatic nodes compute limit - allows defining the size limit for the mesh groups for which the number of underlying nodes is calculated automatically. If the group size exceeds the value set in the preferences, the user will have to press \em Compute button explicitly. Zero value means "no limit". By default the value is set to 100 000 mesh elements. - - Automatic controls compute limit - allows to define the size limit for the + - Automatic controls compute limit - allows defining the size limit for the mesh elements for which the Aspect Ratio histogram is calculated automatically. If the mesh elements size exceeds the value set in the preferences, - the user will have to press \em Compute button explicitly. Zero value + it is possible to press \b Compute button explicitly to calculate the histogram . Zero value means "no limit". By default the value is set to 3 000 mesh elements. - Show details on groups in element information tab - when this option is switched off (default), only the names of groups, to which the node or element belongs, are shown in the \ref mesh_element_info_anchor "Info Tab" tab of "Mesh Information" dialog box. If this option is switched on, the detailed information on groups is shown. - - Dump base information - allows to dump base mesh information to the + - Dump base information - allows dumping base mesh information to the file, see \ref mesh_infos_page. - - Dump element information - allows to dump element information to the + - Dump element information - allows dumping element information to the file, see \ref mesh_infos_page. - - Dump additional information - allows to dump additional mesh + - Dump additional information - allows dumping additional mesh information to the file, see \ref mesh_infos_page. - - Dump controls information - allows to dump quality mesh + - Dump controls information - allows dumping quality mesh information to the file, see \ref mesh_infos_page. - Automatic Parameters - Ratio Bounding Box Diagonal / Max Size - this parameter is - used for automatic meshing: ratio between the bounding box of the + used for automatic meshing. This is the ratio between the bounding box of the meshed object and the Max Size of segments. - - Default Number of Segments - allows defining the default + - Default Number of Segments - defines the default number of segments on each edge. - Mesh loading - If No mesh loading from study file at hypothesis modification - checkbox is on, the mesh data will not be loaded from the study file + check-box is on, the mesh data will not be loaded from the study file when a hypothesis is modified. This allows saving time by omitting loading data of a large mesh that is planned to be recomputed with other parameters. diff --git a/doc/salome/gui/SMESH/input/mesh_through_point.doc b/doc/salome/gui/SMESH/input/mesh_through_point.doc index b84df8b1b..5f4166b38 100644 --- a/doc/salome/gui/SMESH/input/mesh_through_point.doc +++ b/doc/salome/gui/SMESH/input/mesh_through_point.doc @@ -21,13 +21,9 @@ The following dialog box shall appear:
    8. Enter the coordinates of the destination point.
    9. Check in Find closest to destination option or -select the necessary node manually (X, Y, Z, dX, dY, dZ fields allow -to see original coordinates and displacement of the node to move). -\b Preview check-box allows to see the results of the operation.
      10. -
    10. The Update Destination button is activated when Find -closest to destination option is unchecked. Click the Update -Destination button for update coordinates of the destination point -from original coordinates of the node to move.
      11. +select the necessary node manually (X, Y, Z, dX, dY, dZ fields show the original coordinates and displacement of the node to move). +\b Preview check-box shows the operation results. +
    11. Update Destination button is activated when Find closest to destination option is unchecked. Click Update Destination button to update the coordinates of the destination point.
    12. Click the \b Apply or Apply and Close button.
    diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc index 583d7e773..c06fb6ec5 100644 --- a/doc/salome/gui/SMESH/input/selection_filter_library.doc +++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc @@ -84,7 +84,7 @@ IDs. the color defined by the Threshold Value.
  13. Elements of a domain allows selection of entities belonging to -one domain of a mesh. The domain is a part of mesh not connected to +one domain of a mesh. The domain is mesh part not connected to other parts. Threshold Value locating any element of the domain can be either - node ID (that you can pick in the Viewer) or - geometrical vertex (that you can pick either in the Viewer or in the