From db06de940ebac60e299fd57b08a8e16045da32a6 Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 8 Jun 2011 06:50:21 +0000 Subject: [PATCH] Update user documentation --- .../gui/SMESH/input/additional_hypo.doc | 14 +++---- doc/salome/gui/SMESH/input/blsurf_hypo.doc | 40 ++++++++++++++----- .../gui/SMESH/input/constructing_meshes.doc | 8 ++-- .../input/convert_to_from_quadratic_mesh.doc | 23 +++++------ .../gui/SMESH/input/cut_mesh_by_plane.doc | 19 ++++----- .../SMESH/input/generate_flat_elements.doc | 2 +- .../gui/SMESH/input/smeshpy_interface.doc | 1 + .../input/tui_defining_ghs3d_hypotheses.doc | 24 +++++------ .../input/tui_generate_flat_elements.doc | 12 +++--- 9 files changed, 81 insertions(+), 62 deletions(-) diff --git a/doc/salome/gui/SMESH/input/additional_hypo.doc b/doc/salome/gui/SMESH/input/additional_hypo.doc index 67e10c35b..a746d3007 100644 --- a/doc/salome/gui/SMESH/input/additional_hypo.doc +++ b/doc/salome/gui/SMESH/input/additional_hypo.doc @@ -60,7 +60,7 @@ hypothesis with type Triangle Preference set instead. \anchor viscous_layers_anchor

Viscous Layers

-Viscous Layers additional hypotheses can be used together with +Viscous Layers additional hypothesis can be used together with several 3D algorithms: NETGEN 3D, GHS3D and Hexahedron(i,j,k). This hypothesis allows creation of layers of highly stretched prisms near mesh boundary, which is beneficial for high quality viscous @@ -72,13 +72,13 @@ actually the hexahedrons. \image html viscous_layers_mesh.png A group containing viscous layer prisms. diff --git a/doc/salome/gui/SMESH/input/blsurf_hypo.doc b/doc/salome/gui/SMESH/input/blsurf_hypo.doc index 99ea78e09..795fbb974 100644 --- a/doc/salome/gui/SMESH/input/blsurf_hypo.doc +++ b/doc/salome/gui/SMESH/input/blsurf_hypo.doc @@ -247,38 +247,56 @@ In order to compute the mean of several values, the arithmetic mean is used by d More specific size maps can be defined on faces. -\image html blsurf_attractors2.png "Example of mesh created using attractors, the attractors here are the side edges and the size grow from the side of the surface towards the apex" +\image html blsurf_attractors2.png "Example of mesh created using +attractors, the attractors here are the side edges and the size grows +from the side of the surface towards the apex" \n -\image html blsurf_const_size_near_shape2.png "Example of size map with constant size option, the size is kept constant on the left side of the surface until a certain distance" +\image html blsurf_const_size_near_shape2.png "Example of size map +with constant size option, the size is kept constant on the left side +of the surface until a certain distance" \n -Remark : The validation of the hypothesis might take a few seconds if attractors are defined or the "constant size" option is used because a map of distances has to be built on the whole surface for each face where such an hypothesis has been defined. +Remark : The validation of the hypothesis might take a few seconds if +attractors are defined or the "constant size" option is used because a +map of distances has to be built on the whole surface for each face +where such a hypothesis has been defined.
See Also a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including size map. \anchor blsurf_attractor_computation

Computation of attractors

\n -The size grow exponentially following the equation : h(d) = User size + (h_start - User Size) * exp( -(d / R)^2 ). +The size grows exponentially following the equation : h(d) = User size + (h_start - User Size) * exp( -(d / R)^2 ). \n Where : diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index 6ceaba3ac..5f7466998 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -52,7 +52,7 @@ The use of additional hypotheses is optional (i.e. you may leave Proceed in the same way with 2d and 3d Algorithms and Hypotheses, note that the choice of hypotheses depends on the algorithm. There must be one Algorithm and zero or several Hypotheses for each dimension of your -object (most of the standard 2D and 3D algorithms can work without +object (most standard 2D and 3D algorithms can work without hypotheses using some default parameters), otherwise you will not get any mesh at all. Of course, if you wish to mesh a face, which is a 2d object, you don't need to define 3d @@ -74,11 +74,11 @@ algorithms applied to the construction of the mesh. There is an alternative way to create a mesh on an object simply by clicking Assign a set of hypotheses button and selecting among pre-defined sets of hypotheses. In addition to the standard -sets of hypotheses, one can create his own sets by creating +sets of hypotheses, it is possible to create custom sets by editing CustomMeshers.xml file located in the home directory. CustomMeshers.xml -file must describe sets of hypotheses the +file must describe sets of hypotheses in the same way as ${SMESH_ROOT_DIR}/share/salome/resources/smesh/StdMeshers.xml -file does (hypotheses sets are enclosed between +file does (sets of hypotheses are enclosed between tags). \image html hypo_sets.png
List of sets of hypotheses: [custom] is automatically added to the sets defined diff --git a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc index dd1b71e44..66f850664 100644 --- a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc +++ b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc @@ -2,11 +2,11 @@ \page convert_to_from_quadratic_mesh_page Convert to/from Quadratic Mesh -\n This functionality allows you to transtorm standard meshes (or -sum-mesh) to quadratic and vice versa. +\n This functionality allows transforming standard meshes (or +sub-meshes) to quadratic and vice versa. See \ref adding_quadratic_elements_page "Adding quadratic elements" for more information about quadratic meshes. -Note that conversion of the sub-mesh most probably will +Note that conversion of a sub-mesh most probably will produce a non-conformal mesh. Elements on the boundary between quadratic and linear sub-meshes become (or remain) quadratic. @@ -14,8 +14,8 @@ quadratic and linear sub-meshes become (or remain) quadratic.
  1. Select a mesh or a sub-mesh in the Object Browser or in the Viewer.
    2. -
  2. From the Modification menu choose the Convert to/from Quadratic -Mesh item, or click "Convert to/from quadratic" button in the +
  3. From the Modification menu choose Convert to/from Quadratic +Mesh item , or click "Convert to/from quadratic" button in the toolbar. \image html image154.png @@ -26,18 +26,17 @@ The following dialog box will appear: \image html convert.png
    4. -
  4. In this dialog box you should specify: +
  5. In this dialog box specify:
      -
    • if you wish to convert a standard mesh to quadratic or a quadratic +
    • if it is necessary to convert a standard mesh to quadratic or a quadratic mesh to standard. Note that the choice is available only if the selected mesh (or sub-mesh) contains both quadratic and linear elements, else the -sole direction of convertion is automatically selected.
      • +direction of conversion is selected automatically. -
    • if you wish to place medium nodes of the quadratic mesh on the -geometry (meshed object). This option is active at convertion to -qudratic mesh only and provided that the mesh is based on some -geometry (not imported from the file).
      • +
    • if it is necessary to place medium nodes of the quadratic mesh on the +geometry (meshed object). This option is relevant for conversion to +quadratic provided that the mesh is based on a geometry (not imported from file).
    \image html image156.gif diff --git a/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc b/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc index d08914498..0b9500b4e 100644 --- a/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc +++ b/doc/salome/gui/SMESH/input/cut_mesh_by_plane.doc @@ -2,8 +2,8 @@ \page cut_mesh_by_plane_page Cut a tetrahedron mesh by a plane -\n MeshCut works only on Med files and produces Med files, and is a standalone program. -It can be used either directly on a shell command outside SALOME, or with a GUI interface in SMESH, +\n MeshCut works only with MED files and produces MED files, and is a standalone program. +It can be used either directly from a command shell outside SALOME, or with a GUI interface in SMESH, provided in a python plugin that needs to be installed in your SALOME application. \n MeshCut allows to cut a mesh constituted of linear tetrahedrons by a plane. @@ -31,20 +31,21 @@ MeshCut input.med output.med resuMeshName aboveGroup belowGroup nx ny nz px py p \n nx ny nz = vector normal to the cut plane \n px py pz = a point of the cut plane \n T = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to -\n the cut plane if their distance to the plane is inferior to L*T +\n the cut plane if their distance from the plane is inferior to L*T, \n where L is the mean edge size of the tetrahedron
    \anchor meshcut_plugin

    Using MeshCut inside SALOME

    -When the MeshCut plugin is installed, you will find it in the Mesh menu, sub-menu SMESH_plugins. -\n If the plugin is not installed, look for a file named meshcut_plugin.py in your SMESH installation. -The file is normally in the subdirectory bin/salome/meshcut_plugin.py. +When the MeshCut plugin is installed, it can be found in the Mesh menu, sub-menu SMESH_plugins. +\n If the plugin is not installed, the file meshcut_plugin.py is in +SMESH installation in subdirectory bin/salome/meshcut_plugin.py. -\n If you already have plugins defined in a smesh_plugins.py file, add this file at the end. - if not, copy this file as ${HOME}/Plugins/smesh_plugins.py or ${APPLI}/Plugins/smesh_plugins.py - or in your ${PLUGINPATH} Directory. +\n If there are already plugins defined in a smesh_plugins.py file, + this file should be added at the end. + if not, copied as ${HOME}/Plugins/smesh_plugins.py or ${APPLI}/Plugins/smesh_plugins.py + or in ${PLUGINPATH} Directory.
  6. From the Mesh menu, sub-menu SMESH_plugins, choose "MeshCut" item The following dialog box will appear: diff --git a/doc/salome/gui/SMESH/input/generate_flat_elements.doc b/doc/salome/gui/SMESH/input/generate_flat_elements.doc index 36ecea7b8..7cfdbf90b 100644 --- a/doc/salome/gui/SMESH/input/generate_flat_elements.doc +++ b/doc/salome/gui/SMESH/input/generate_flat_elements.doc @@ -7,6 +7,6 @@ allow to generate flat volume elements on the boundaries of a list of groups of volumes, or on a list of groups of faces. \n These functionalities are only available in python scripts. -
    See a sample TUI Script of a \ref tui_double_nodes_on_group_boundaries "Generate flat elements" operations. +
    See a sample TUI Script of \ref tui_double_nodes_on_group_boundaries "Generate flat elements" operation. */ diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index 8b63ddfa3..a677107cf 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -139,5 +139,6 @@ the following links: - \subpage tui_transforming_meshes_page - \subpage tui_notebook_smesh_page - \subpage tui_measurements_page +- \subpage tui_generate_flat_elements_page */ diff --git a/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc b/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc index 0146e81e3..0051faada 100644 --- a/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc +++ b/doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc @@ -38,11 +38,11 @@ ghs3dMesh.Compute() # - the coordinates x,y,z # - a GEOM vertex or compound (No geometry, TUI only) # -# The enforced nodes created can also be stored in +# The created enforced nodes can also be stored in # a group (No geometry, TUI only). -# Ex1: Add 1 enforced vertices by coords at (50,50,100) -# with a physical size of 2 +# Ex1: Add one enforced vertex with coordinates (50,50,100) +# and physical size 2. import geompy import smesh @@ -73,10 +73,10 @@ GHS3D_Parameters.SetEnforcedVertex( 50, 50, 100, 2) # no group ghs3dMesh.Compute() -# Ex2: Add 1 enforced vertices by GEOM vertex at (50,50,100) -# with a physical size of 5 and add it to a group called "My special nodes" +# Ex2: Add one vertex enforced by a GEOM vertex at (50,50,100) +# with physical size 5 and add it to a group called "My special nodes" -# Create another GHS3D hypothesis and assign it to the mesh wo geometry +# Create another GHS3D hypothesis and assign it to the mesh without geometry GHS3D_Parameters_wo_geometry = smesh.CreateHypothesis('GHS3D_Parameters', 'GHS3DEngine') ghs3dMesh_wo_geometry.AddHypothesis( GHS3D ) ghs3dMesh_wo_geometry.AddHypothesis( GHS3D_Parameters_wo_geometry ) @@ -104,8 +104,8 @@ GHS3D_Parameters.ClearEnforcedVertices() \code -# It is possible to constraint GHS3D with another mesh or group. -# The constraint can be the nodes, edges or faces. +# It is possible to constrain GHS3D with another mesh or group. +# The constraint can refer to the nodes, edges or faces. # This feature is available only in TUI, on meshes without geometry. # The constraining elements are called enforced elements for the mesh. # They can be recovered using groups if necessary. @@ -133,7 +133,7 @@ geompy.addToStudy( p1, "p1" ) geompy.addToStudy( p2, "p2" ) geompy.addToStudy( c, "c" ) -# Create the 2D algo and hypothesis +# Create the 2D algorithm and hypothesis BLSURF = smesh.CreateHypothesis('BLSURF', 'BLSURFEngine') # For the box BLSURF_Parameters = smesh.CreateHypothesis('BLSURF_Parameters', 'BLSURFEngine') @@ -143,7 +143,7 @@ BLSURF_Parameters.SetPhySize( 200 ) BLSURF_Parameters2 = smesh.CreateHypothesis('BLSURF_Parameters', 'BLSURFEngine') BLSURF_Parameters2.SetGeometricMesh( 1 ) -# Create the 3D algo and hypothesis +# Create the 3D algorithm and hypothesis GHS3D = smesh.CreateHypothesis('GHS3D_3D', 'GHS3DEngine') GHS3D_Parameters_node = smesh.CreateHypothesis('GHS3D_Parameters', 'GHS3DEngine') #GHS3D_Parameters_node.SetToMeshHoles( 1 ) @@ -173,7 +173,7 @@ Mesh_box_tri.AddHypothesis( BLSURF_Parameters ) Mesh_box_tri.Compute() # Create 4 copies of the 2D mesh to test the 3 types of contraints (NODE, EDGE, FACE) -# from a whole mesh and from groups of elements. +# from the whole mesh and from groups of elements. # Then the 3D algo and hypothesis are assigned to them. mesh_mesh = smesh.CopyMesh( Mesh_box_tri, 'Enforced by faces of mesh', 0, 0) @@ -213,4 +213,4 @@ mesh_mesh.Compute() \image html ghs3d_screenshot_enf5.png \image html ghs3d_screenshot_enf6.png -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc b/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc index eb336888f..45806adbb 100644 --- a/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc +++ b/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc @@ -7,10 +7,10 @@

    Double nodes on groups boundaries

    \n Double nodes on shared faces between groups of volumes and create flat elements on demand. -\n The list of groups must describe a partition of the mesh volumes.The nodes of the internal -faces at the boundaries of the groups are doubled. In option, the internal faces are replaced +\n The list of groups must describe a partition of the mesh volumes. The nodes of the internal +faces at the boundaries of the groups are doubled. Optionally, the internal faces are replaced by flat elements. -\n Triangles are transformed in prisms, and quadrangles in hexahedrons. +\n Triangles are transformed into prisms, and quadrangles into hexahedrons. \n The flat elements are stored in groups of volumes. \n @@ -37,7 +37,7 @@ Partition_1 = geompy.MakePartition([Fuse_1], [Cylinder_1], [], [], geompy.ShapeT [Solid_1,Solid_2,Solid_3] = geompy.SubShapes(Partition_1, [53, 2, 30]) [Face_1,Face_2] = geompy.SubShapes(Partition_1, [37, 20]) -# meshing (linear tetrahedrons here, but other elements are OK) +# meshing (linear tetrahedrons are here, but other elements are OK) Mesh_1 = smesh.Mesh(Partition_1) BLSURF = Mesh_1.Triangle(algo=smesh.BLSURF) @@ -61,7 +61,7 @@ Face_2_1 = Mesh_1.GroupOnGeom(Face_2,'Face_2',SMESH.FACE) \n Here, the 3 groups of volumes [Solid_1_1, Solid_2_1, Solid_3_1] constitute a partition of the mesh. The flat elements on group boundaries and on faces are built with the following code. -\n If the last argument (boolean) in DoubleNodesOnGroupBoundaries is set to 1, +\n If the last argument (Boolean) in DoubleNodesOnGroupBoundaries is set to 1, the flat elements are built, otherwise, there is only a duplication of the nodes. \code @@ -70,6 +70,6 @@ Mesh_1.DoubleNodesOnGroupBoundaries([Solid_1_1, Solid_2_1, Solid_3_1], 1) Mesh_1.CreateFlatElementsOnFacesGroups([Face_1_1, Face_2_1]) \endcode -\n To observe the flat element groups, save the resulting mesh on a Med file and reload it. +\n To observe flat element groups, save the resulting mesh on a MED file and reload it. */ -- 2.39.2