From: ysn Date: Mon, 5 May 2014 05:25:50 +0000 (+0400) Subject: Review of reference documentation. X-Git-Tag: V7_4_0rc1~10^2^2~1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d971e6ef1699b04a2cf3145b56dcd9a8abb6fea4;p=modules%2Fsmesh.git Review of reference documentation. --- diff --git a/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo.png b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo.png deleted file mode 100755 index adddf842c..000000000 Binary files a/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo.png and /dev/null differ diff --git a/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo1.png b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo1.png new file mode 100644 index 000000000..304001544 Binary files /dev/null and b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo1.png differ diff --git a/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo2.png b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo2.png new file mode 100644 index 000000000..f0a4c6290 Binary files /dev/null and b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo2.png differ diff --git a/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo3.png b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo3.png new file mode 100644 index 000000000..f6db3397e Binary files /dev/null and b/doc/salome/gui/SMESH/images/hypo_quad_params_enfnodes_algo3.png differ diff --git a/doc/salome/gui/SMESH/images/split_into_prisms.png b/doc/salome/gui/SMESH/images/split_into_prisms.png index 6b9f77a2d..6d48e6956 100644 Binary files a/doc/salome/gui/SMESH/images/split_into_prisms.png and b/doc/salome/gui/SMESH/images/split_into_prisms.png differ diff --git a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc index b992bc8e2..ac0902ec1 100644 --- a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc @@ -48,7 +48,7 @@ beginning from a given starting length and up to a given end length. The direction of the splitting is defined by the orientation of the underlying geometrical edge. "Reverse Edges" list box allows to specify the edges for which the splitting should be made in the direction opposing to their orientation. This list box is enabled only if the geometry object -is selected for the meshing. In this case the user can select edges to be reversed either directly +is selected for the meshing. In this case the user can select edges to be reversed either by directly picking them in the 3D viewer or by selecting the edges or groups of edges in the Object Browser. \image html a-arithmetic1d.png @@ -62,17 +62,14 @@ picking them in the 3D viewer or by selecting the edges or groups of edges in th \anchor geometric_1d_anchor

Geometric Progression hypothesis

-Geometric Progression hypothesis allows to split edges into +Geometric Progression hypothesis allows splitting edges into segments with a length that changes in geometric progression (Lk = -Lk-1 * d) beginning from a given starting length and with a given -common ratio. +Lk-1 * d) starting from a given Start Length and Common Ratio. -The direction of the splitting is defined by the orientation of the -underlying geometrical edge. "Reverse Edges" list box allows to -specify the edges for which the splitting should be made in the -direction opposing to their orientation. This list box is enabled only -if the geometry object is selected for the meshing. In this case the -user can select edges to be reversed either directly picking them in +The splitting direction is defined by the orientation of the +underlying geometrical edge. +Reverse Edges list box allows specifying the edges, for which the splitting should be made in the +direction opposite to their orientation. This list box is filled after a geometry object is selected for meshing. In this case it is possible to select edges to be reversed either directly picking them in the 3D viewer or by selecting the edges or groups of edges in the Object Browser. diff --git a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc index e019c8b87..0ccb902e0 100644 --- a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc @@ -36,13 +36,13 @@ of a given face. \anchor hypo_quad_params_anchor

Quadrangle parameters

-\image html hypo_quad_params_dialog.png "Quadrangle parameters creation/edition dialog" +\image html hypo_quad_params_dialog.png "Quadrangle parameters: Transition" Quadrangle parameters is a hypothesis for Quadrangle (Mapping) algorithm. Transition tab is used to define the algorithm of transition between opposite sides of faces with a different number of -segments on opposite sides. The following types of transition +segments on them. The following types of transition algorithms are available: - Standard is the default case, when both triangles and quadrangles @@ -80,7 +80,7 @@ algorithm for meshing of trilateral faces. In this case it is necessary to select the vertex, which will be used as the fourth edge (degenerated). -\image html hypo_quad_params_dialog_vert.png "Base Vertex tab of Quadrangle parameters creation/edition dialog" +\image html hypo_quad_params_dialog_vert.png "Quadrangle parameters: Base Vertex" \image html hypo_quad_params_1.png "A face built from 3 edges" @@ -98,9 +98,9 @@ shows the good (left) and the bad (right) results of meshing. \image html hypo_quad_params_res_2.png "The resulting meshes" -\image html hypo_quad_params_dialog_enf.png "Enforced nodes tab of Quadrangle parameters creation/edition dialog" +\image html hypo_quad_params_dialog_enf.png "Quadrangle parameters: Enforced nodes" -Enforced nodes tab allows for defining points where the +Enforced nodes tab allows defining points, where the algorithm should create nodes. There are two ways to define positions of the enforced nodes. -Algorithm of creation of the enforced nodes is following. -\image html hypo_quad_params_enfnodes_algo.png "Steps of the algorithm of creation of the enforced nodes" -
    -
  1. Left image: Positions of nodes are computed without taking into +Let us see how the algorithm works: + + +
      +
    • Initially positions of nodes are computed without taking into account the enforced vertex (yellow point).
      • -
    • Middle image: A node closest to the enforced vertex is +\image html hypo_quad_params_enfnodes_algo1.png "Initial mesh" + +
    • Then the node closest to the enforced vertex is detected. Extreme nodes of the row and column of the detected node are used to create virtual edges (yellow lines) ending at the enforced vertex.
      • -
    • Right image: The meshed face is thus divided by the virtual +\image html hypo_quad_params_enfnodes_algo2.png "Creation of virtual edges" + +
    • Consequently, the meshed face is divided by the virtual edges into four quadrilateral sub-domains each of which is meshed - as usually: the nodes of the row and column of detected node are + as usually: the nodes of the row and column of the detected node are moved to the virtual edges and the quadrilateral elements are constructed. -
+ +\image html hypo_quad_params_enfnodes_algo3.png "Final mesh" + + If there are several enforced vertices, the algorithm is applied recursively to the formed sub-domains. diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc index 565b3a48b..870e5c182 100644 --- a/doc/salome/gui/SMESH/input/about_meshes.doc +++ b/doc/salome/gui/SMESH/input/about_meshes.doc @@ -10,7 +10,7 @@ on the basis of geometrical shapes produced in the GEOM module. It is also possible to \subpage constructing_submeshes_page "construct mesh on a part of the geometrical object", for example, a face, with different meshing parameters or using -another meshing algorithm than the whole mesh. +another meshing algorithm. Several created meshes can be \subpage building_compounds_page "combined into another mesh". diff --git a/doc/salome/gui/SMESH/input/arranging_study_objects_page.doc b/doc/salome/gui/SMESH/input/arranging_study_objects_page.doc deleted file mode 100644 index ea655d5f4..000000000 --- a/doc/salome/gui/SMESH/input/arranging_study_objects_page.doc +++ /dev/null @@ -1,11 +0,0 @@ -/*! - -\page arranging_study_objects_page Arranging objects in study - -If sub-meshes or groups container item has more than one child sub-object, then there is a possibility to sort these children in ascending order. - -To use sort functionality select "Sort children" popup menu item for the parent object. - -\image html smesh_sort.png "Sorting of sub-objects" - -*/ diff --git a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc index e76863e8a..ee632b282 100644 --- a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc +++ b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc @@ -9,9 +9,9 @@ used for meshing entities (1D, 2D, 3D) composing geometrical objects.
  • For meshing of 1D entities (edges):
    • -\ref use_existing_anchor "Use Edges to be Created Manually" and -\ref use_existing_anchor "Use Faces to be Created Manually" algorithms can be -used to create a 1D or a 2D mesh in a python script. \ref constructing_meshes_page "Constructing meshes" page describes in detail how to apply meshing algorithms. diff --git a/doc/salome/gui/SMESH/input/cartesian_algo.doc b/doc/salome/gui/SMESH/input/cartesian_algo.doc index 7bf830690..6062aa89e 100644 --- a/doc/salome/gui/SMESH/input/cartesian_algo.doc +++ b/doc/salome/gui/SMESH/input/cartesian_algo.doc @@ -7,7 +7,7 @@ the internal part of geometry and polyhedrons and other types of elements at the intersection of Cartesian cells with the geometrical boundary. -\image html cartesian3D_sphere.png "A shpere meshed by Body Fitting algorithm" +\image html cartesian3D_sphere.png "A sphere meshed by Body Fitting algorithm" The meshing algorithm is as follows.
      @@ -29,10 +29,7 @@ nodes are inside and some outside.
    To apply this algorithm when you define your mesh, select Body - Fitting in the list of 3D algorithms and click "Add - Hypothesis" button and "Body Fitting Parameters"" menu -item. Dialog of Body Fitting Parameters - hypothesis will appear. + Fitting in the list of 3D algorithms and add Body Fitting Parameters hypothesis. The following dialog will appear:
    \anchor cartesian_hyp_anchor @@ -43,19 +40,21 @@ item. Dialog of Body Fitting Parameters This dialog allows to define + + +
    See Also a sample TUI Script of a diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index b6c687bb0..34ca6e995 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -10,9 +10,6 @@
  • \ref submesh_order_anchor "Changing sub-mesh priority" (optional)
  • \ref compute_anchor "Computing the mesh"
    • -Mesh can be \ref use_existing_anchor "computed using your own meshing algorithms" -written in Python. - \anchor create_mesh_anchor

    Creation of a mesh object

    @@ -32,6 +29,10 @@ written in Python. \image html createmesh-inv.png
    +
  • Select Mesh Type in the corresponding list from Any, Hexahedral, Tetrahedral, Triangular and \b Quadrilateral (there can be less items for lower dimensions). + + Selection of a mesh type hides any algorithms that are not able to create elements of this type.
    • +
  • Apply \subpage basic_meshing_algos_page "meshing algorithms" and \subpage about_hypo_page "hypotheses" which will be used to compute this mesh. @@ -87,23 +88,20 @@ written in Python. "Edit Hypothesis" button - Most 2D and 3D algorithms can work without hypotheses using some - default meshing parameters. Some algorithms does not require any - hypothesis. After selection of an algorithm "Hypothesis" field of + Most 2D and 3D algorithms can work without hypotheses using default meshing parameters. Some algorithms do not require any hypotheses. After selection of an algorithm "Hypothesis" field of the dialog can contain:
    • \ if the algorithm can work using default parameters.
    • \ if the algorithm requires a hypothesis defining its parameters.
      • -
    • Nothing if the algorithm has no parameters to tune.
      • +
    • If the algorithm does not use hypotheses, this field is grayed.
    - After selection of an algorithm "Add. Hypothesis" field of - the dialog can contain: + After selection of an algorithm Add. Hypothesis field can contain:
      -
    • \ if the algorithm can be additionally tuned +
    • \ if the algorithm can be tuned using an additional hypothesis.
      • -
    • Nothing if the algorithm has no additional parameters to tune.
      • +
    • If the algorithm does not use additional hypotheses, this field is grayed.
    Proceed in the same way with 2D and 1D Algorithms and Hypotheses that @@ -346,33 +344,6 @@ By default, the information box is always shown after mesh computation operation

    -\anchor use_existing_anchor -

    "Use Edges to be Created Manually" and "Use Faces to be Created Manually" algorithms

    - -It is possible to create a 1D or a 2D mesh in a python script -(using AddNode, AddEdge and AddFace commands) and -then use such sub-meshes in the construction of a 2D or a 3D mesh. For -this, there exist two algorithms: Use Edges to be Created -Manually and Use Faces to be Created Manually. -Imagine, 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 a 1D algorithm,
      2. -
    2. invoke \b Compute command, which computes a 1D mesh,
      3. -
    3. assign Use Faces to be Created Manually and a 3D algorithm,
      4. -
    4. run your python code, which creates a 2D mesh,
      5. -
    5. invoke \b Compute command, which computes a 3D mesh.
      6. -
    -\warning Use Edges to be Created Manually and Use Faces to -be Created Manually algorithms should be assigned _before_ -mesh generation by the Python code. - -Consider trying a sample script demonstrating the usage of -\ref tui_use_existing_faces "Use Faces to be Created Manually" -algorithm for construction of a 2D mesh using Python commands. -\image html use_existing_face_sample_mesh.png - Mesh computed by \ref tui_use_existing_faces "the sample script" - shown in a Shrink mode. */ diff --git a/doc/salome/gui/SMESH/input/define_mesh_by_script.doc b/doc/salome/gui/SMESH/input/define_mesh_by_script.doc new file mode 100644 index 000000000..beb9d8e40 --- /dev/null +++ b/doc/salome/gui/SMESH/input/define_mesh_by_script.doc @@ -0,0 +1,29 @@ +/*! + +\page use_existing_page Use Edges/Faces to be Created Manually" + +The algorithms Use Edges to be Created Manually and Use Faces to be Created Manually allow creating a 1D or a 2D mesh in a python script (using AddNode, AddEdge and AddFace commands) and then using such sub-meshes in the construction of a 2D or a 3D mesh. + +For example, you want to use standard algorithms to generate 1D and 3D +meshes and to create 2D mesh by your python code. For this, you +
      +
    1. create a mesh object, assign a 1D algorithm,
      2. +
    2. invoke \b Compute command, which computes a 1D mesh,
      3. +
    3. assign Use Faces to be Created Manually and a 3D algorithm,
      4. +
    4. run your python code, which creates a 2D mesh,
      5. +
    5. invoke \b Compute command, which computes a 3D mesh.
      6. +
    + +\warning Use Edges to be Created Manually and Use Faces to +be Created Manually algorithms should be assigned _before_ +mesh generation by the Python code. + +Consider trying a sample script demonstrating the usage of +\ref tui_use_existing_faces "Use Faces to be Created Manually" +algorithm for construction of a 2D mesh using Python commands. + +\image html use_existing_face_sample_mesh.png + Mesh computed by \ref tui_use_existing_faces "the sample script" + shown in a Shrink mode. + +*/ diff --git a/doc/salome/gui/SMESH/input/double_nodes_page.doc b/doc/salome/gui/SMESH/input/double_nodes_page.doc index c86f0bdc1..9c3983f01 100644 --- a/doc/salome/gui/SMESH/input/double_nodes_page.doc +++ b/doc/salome/gui/SMESH/input/double_nodes_page.doc @@ -122,18 +122,7 @@ Parameters to be defined in this mode: \anchor mode_group_boundary_anchor

    Duplicate nodes on group boundaries

    -This mode duplicates nodes located on boundaries between given groups of -volumes. If required, flat elements are created on the duplicated -nodes: a triangular facet shared by two volumes of two groups generates -a flat prism, a quadrangular facet generates a flat hexahedron. -
    -The created flat volumes are stored in groups. These groups are named -according to the position of the group in the list of groups: group -"j_n_p" is a group of flat elements that are built between the group \#n -and the group \#p in the group list. All the flat elements are gathered -into the group named "joints3D". The flat element of the multiple -junctions between the simple junction are stored in a group named -"jointsMultiples". +This mode duplicates nodes located on boundaries between given groups of volumes.
    @@ -142,12 +131,12 @@ junctions between the simple junction are stored in a group named Parameters to be defined in this mode:
    • Groups of volumes (mandatory): list of volume - groups. These groups should be disjoint, i.e. should not share volumes.
      • -
    • Create joint elements : if checked - the flat elements are created.
      • -
    • On all boundaries : if checked - then the volumes not - included into the Groups of volumes are considered as another given - group. And thus nodes on boundary between Groups of volumes and the - rest mesh are also duplicated.
      • + groups. These groups should be disjoint, i.e. should not have shared volumes. +
    • If Create joint elements option is activated, flat elements are created on the duplicated +nodes: a triangular facet shared by two volumes of two groups generates +a flat prism, a quadrangular facet generates a flat hexahedron.
      • +
    • If On all boundaries : option is activated, the volumes, which are not + included into Groups of volumes, are considered as another group and thus the nodes on the boundary between Groups of volumes and the remaining mesh are also duplicated.

    See Also a sample TUI Script of a diff --git a/doc/salome/gui/SMESH/input/grouping_elements.doc b/doc/salome/gui/SMESH/input/grouping_elements.doc index 9615ad4c3..c6a97e165 100644 --- a/doc/salome/gui/SMESH/input/grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/grouping_elements.doc @@ -32,6 +32,10 @@ The created groups can be later: - \subpage using_operations_on_groups_page "Subjected to Boolean operations" - \subpage deleting_groups_page "Deleted" +If sub-meshes or groups container item has more than one child sub-object, it is possible to sort the children in ascending order. For this, select the parent object in the Object Browser and choose Sort children context menu item. + +\image html smesh_sort.png "Sorting of sub-objects" + An important tool, providing filters for creation of \b Standalone groups is \ref selection_filter_library_page. diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index a4c2a66ab..d7a475137 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -25,7 +25,6 @@ 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". diff --git a/doc/salome/gui/SMESH/input/mesh_through_point.doc b/doc/salome/gui/SMESH/input/mesh_through_point.doc index 958a662eb..679d629b4 100644 --- a/doc/salome/gui/SMESH/input/mesh_through_point.doc +++ b/doc/salome/gui/SMESH/input/mesh_through_point.doc @@ -14,17 +14,19 @@ click "Move Node" button in the toolbar. \image html image67.png
    "Move Node" button
    -One of the following dialogs will appear: +The following dialog will appear: -\image html meshtopass1.png "manual method of selecting node" -\image html meshtopass2.png "automatic method of selecting node" +\image html meshtopass1.png "Manual node selection" + +\image html meshtopass2.png "Automatic node selection"
    • -
  • Specify the way of selection of the node: manually (first radio button) or automatically (second radio button).
    • -
  • If the manual method selected, select the necessary node (X, Y, Z fields show the original coordinates of the node to move) or set the ID node.
    • +
  • Specify the way of node selection: manually (the first radio button) or automatically (the second radio button).
    • + +
  • If the manual method is selected, select the necessary node (X, Y, Z fields show the original coordinates of the node to move) or set the node ID.
  • Enter the coordinates of the destination point.
  • Click Update Destination button to update the coordinates of the destination point.
    • -
  • Activate \b Preview checkbox to show the result of move in the viewer
    • +
  • Activate \b Preview check-box to show the result of move in the viewer
  • Click the \b Apply or Apply and Close button to confirm the operation.
    • diff --git a/doc/salome/gui/SMESH/input/split_to_tetra.doc b/doc/salome/gui/SMESH/input/split_to_tetra.doc index eb7fe0f26..187af8b89 100644 --- a/doc/salome/gui/SMESH/input/split_to_tetra.doc +++ b/doc/salome/gui/SMESH/input/split_to_tetra.doc @@ -19,70 +19,50 @@ The following dialog box will appear: \image html split_into_tetra.png
    -Target element type group of radio-buttons allows to select -a type of operation. If \b Tetrahedron button is checked, then the -operation will split volumes of any type into tetrahedra. -If \b Prism button is checked, then the operation will split hexahedra -into prisms, and the dialog will look as follows: - -\image html split_into_prisms.png +First it is possible to select the type of operation: +- If \b Tetrahedron button is checked, the operation will split volumes of any type into tetrahedra. +- If \b Prism button is checked, the operation will split hexahedra into prisms.     + +
  • If \b Tetrahedron element type is selected, Split hexahedron group allows specifying the number of tetrahedra a hexahedron will be split into. If the chosen method does not allow to get a conform mesh, a generic solution is applied: an additional node 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.
    • - -
  • Click the \b Apply or Apply and Close button to confirm the operation.
    • +
  • Click \b Apply or Apply and Close button to confirm the operation.
    • */ diff --git a/doc/salome/gui/SMESH/input/use_existing_algos.doc b/doc/salome/gui/SMESH/input/use_existing_algos.doc index 55eb854dd..bdb4151a4 100644 --- a/doc/salome/gui/SMESH/input/use_existing_algos.doc +++ b/doc/salome/gui/SMESH/input/use_existing_algos.doc @@ -1,8 +1,8 @@ /*! -\page import_algos_page "Import Elements from Another Mesh" Algorithms +\page import_algos_page Import Elements from Another Mesh Algorithms -\n Import nD Elements from Another Mesh algorithms allow to +\n Import Elements from Another Mesh algorithms allow to define the mesh of a geometrical object by importing suitably located mesh elements from another mesh. The mesh elements to import from the other mesh should be contained in