ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2024-12-26 09:20:34 +05:00
Code Issues Packages Projects Releases Wiki Activity

Fix Redesign of SMESH documentation

Browse Source
This commit is contained in:
eap 2018-05-25 20:04:48 +03:00
parent 24dd5df5f0
commit 67312ab966
129 changed files with 5030 additions and 5377 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/salome/examples/modifying_meshes_split_vol.py Normal file
View File

@ -0,0 +1,19 @@
# Split volumic elements into tetrahedrons
import salome
salome.salome_init()
from salome.geom import geomBuilder
geompy = geomBuilder.New(salome.myStudy)
from salome.smesh import smeshBuilder
smesh = smeshBuilder.New(salome.myStudy)
# mesh a hexahedral mesh
box = geompy.MakeBoxDXDYDZ (1, 1, 1 )
mesh = smesh.Mesh( box )
mesh.AutomaticHexahedralization(0)
print("Nb volumes mesh: %s" % mesh.NbHexas())
# split each hexahedron into 6 tetrahedra
mesh.SplitVolumesIntoTetra( mesh, smesh.Hex_6Tet )
print("Nb volumes mesh: %s" % mesh.NbTetras())

36
doc/salome/examples/radial_prism_3d_algo.py Normal file
View File

@ -0,0 +1,36 @@
# Usage of Radial Prism 3D meshing algorithm
import salome
salome.salome_init()
from salome.geom import geomBuilder
geompy = geomBuilder.New(salome.myStudy)
import SMESH
from salome.smesh import smeshBuilder
smesh = smeshBuilder.New(salome.myStudy)
# Create geometry: hollow sphere
sphere_1 = geompy.MakeSphereR( 100 )
sphere_2 = geompy.MakeSphereR( 50 )
hollow_sphere = geompy.MakeCut( sphere_1, sphere_2, theName="hollow sphere")
faces = geompy.ExtractShapes( hollow_sphere, geompy.ShapeType["FACE"] )
# Create mesh
mesh = smesh.Mesh( hollow_sphere, "Mesh of hollow sphere" )
# assign Global Radial Prism algorithm
prism_algo = mesh.Prism()
# define projection between the inner and outer spheres
mesh.Triangle( smeshBuilder.NETGEN_1D2D, faces[0] ) # NETGEN on faces[0]
mesh.Projection1D2D( faces[1] ).SourceFace( faces[0] ) # projection faces[0] -> faces[1]
# define distribution of layers using Number of Segments hypothesis in logarithmic mode
prism_algo.NumberOfSegments( 4, 5. )
# compute the mesh
mesh.Compute()

2
doc/salome/examples/tests.set
View File

@ -42,6 +42,7 @@ SET(BAD_TESTS
quality_controls_ex21.py
quality_controls_ex22.py
viewing_meshes_ex01.py
radial_prism_3d_algo.py
)
SET(GOOD_TESTS
@ -137,6 +138,7 @@ SET(GOOD_TESTS
modifying_meshes_ex23.py
modifying_meshes_ex24.py
modifying_meshes_ex25.py
modifying_meshes_split_vol.py
prism_3d_algo.py
quality_controls_ex01.py
quality_controls_ex02.py

6
doc/salome/gui/SMESH/collect_mesh_methods.py
View File

@ -134,7 +134,7 @@ def main(plugin_name, dummymeshhelp = True, output_file = "smeshBuilder.py", for
output.append( " #" )
output.append( " # If the optional @a geom_shape parameter is not set, this algorithm is global (applied to whole mesh)." )
output.append( " # Otherwise, this algorithm defines a submesh based on @a geom_shape subshape." )
output.append( " # @param algo_type type of algorithm to be created; allowed values are specified by classes implemented by plug-in (see below)" )
output.append( " # @param algo_type type of algorithm to be created; allowed values are specified by classes implemented by plug-in" )
output.append( " # @param geom_shape if defined, the subshape to be meshed (GEOM_Object)" )
output.append( " # @return An instance of Mesh_Algorithm sub-class according to the specified @a algo_type, see " )
output.append( " # %s" % ", ".join( [ "%s.%s" % ( plugin_module_name, algo.__name__ ) for algo in methods[ method ] ] ) )
@ -145,13 +145,13 @@ def main(plugin_name, dummymeshhelp = True, output_file = "smeshBuilder.py", for
output.append( ' """' )
output.append( ' %s' % docHelper )
output.append( ' ' )
output.append( ' This method is dynamically added to **Mesh** class by the meshing plug-in(s). ' )
output.append( ' This method is dynamically added to :class:`Mesh <smeshBuilder.Mesh>` class by the meshing plug-in(s). ' )
output.append( ' ' )
output.append( ' If the optional *geom_shape* parameter is not set, this algorithm is global (applied to whole mesh).' )
output.append( ' Otherwise, this algorithm defines a submesh based on *geom_shape* subshape.' )
output.append( ' ' )
output.append( ' Parameters:' )
output.append( ' algo_type: type of algorithm to be created; allowed values are specified by classes implemented by plug-in (see below)' )
output.append( ' algo_type: type of algorithm to be created; allowed values are specified by classes implemented by plug-in' )
output.append( ' geom_shape (GEOM_Object): if defined, the subshape to be meshed' )
output.append( ' ' )
output.append( ' Returns:')

2
doc/salome/gui/SMESH/conf.py.in
View File

@ -23,7 +23,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary',
'sphinxcontrib.napoleon'
]
#add pdfbuilder to build a pdf with rst2pdf

BIN
doc/salome/gui/SMESH/images/smoothing1.png Executable file → Normal file
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

BIN
doc/salome/gui/SMESH/images/smoothing2.png Executable file → Normal file
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

100
doc/salome/gui/SMESH/input/1d_meshing_hypo.rst
View File

@ -5,29 +5,29 @@
*********************
Basic 1D hypothesis specifies:
* how a :ref:`a1d_algos_anchor` should divide the edge;
* how a :ref:`a1d_algos_anchor` should divide the group of C1-continuous edges.
* how a :ref:`Wire Discretization <a1d_algos_anchor>` should divide the edge;
* how a :ref:`Composite Side Discretization <a1d_algos_anchor>` should divide the group of C1-continuous edges.
1D hypotheses can be categorized by type of nodes distribution as follows:
* Uniform distribution:
* :ref:`average_length_anchor`
* :ref:`max_length_anchor`
* :ref:`number_of_segments_anchor` with Equidistant distribution
* :ref:`automatic_length_anchor`
* :ref:`Local Length <average_length_anchor>`
* :ref:`Max Size <max_length_anchor>`
* :ref:`Number of Segments <number_of_segments_anchor>` with Equidistant distribution
* :ref:`Automatic Length <automatic_length_anchor>`
* Constantly increasing or decreasing length of segments:
* :ref:`arithmetic_1d_anchor`
* :ref:`geometric_1d_anchor`
* :ref:`start_and_end_length_anchor`
* :ref:`number_of_segments_anchor` with Scale distribution
* :ref:`Arithmetic Progression <arithmetic_1d_anchor>`
* :ref:`Geometric Progression <geometric_1d_anchor>`
* :ref:`Start and end length <start_and_end_length_anchor>`
* :ref:`Number of Segments <number_of_segments_anchor>` with Scale distribution
* Distribution depending on curvature:
* :ref:`adaptive_1d_anchor`
* :ref:`deflection_1d_anchor`
* :ref:`Adaptive <adaptive_1d_anchor>`
* :ref:`Deflection <deflection_1d_anchor>`
* Arbitrary distribution:
* :ref:`fixed_points_1d_anchor`
* :ref:`number_of_segments_anchor` "Number of Segments" with :ref:`analyticdensity_anchor` or Table Density Distribution
* :ref:`Fixed Points <fixed_points_1d_anchor>`
* :ref:`Number of Segments <number_of_segments_anchor>` with :ref:`Analytic Density Distribution <analyticdensity_anchor>` or Table Density Distribution
.. _adaptive_1d_anchor:
@ -50,7 +50,7 @@ Adaptive hypothesis
.. centered::
Adaptive hypothesis and NETGEN 2D algorithm - the size of mesh segments reflects the size of geometrical features
**See Also** a :ref:`tui_1d_adaptive` that uses Adaptive hypothesis.
**See Also** a :ref:`sample TUI Script <tui_1d_adaptive>` that uses Adaptive hypothesis.
.. _arithmetic_1d_anchor:
@ -62,7 +62,7 @@ Arithmetic Progression hypothesis
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 usable only if 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. Use
**Add** button to add the selected edges to the list.
:ref:`reversed_edges_helper_anchor` group assists you in defining **Reversed Edges** parameter.
:ref:`Helper <reversed_edges_helper_anchor>` group assists you in defining **Reversed Edges** parameter.
.. image:: ../images/a-arithmetic1d.png
@ -73,9 +73,9 @@ The splitting direction is defined by the orientation of the underlying geometri
:align: center
.. centered::
"Arithmetic Progression hypothesis - the size of mesh elements gradually increases"
Arithmetic Progression hypothesis - the size of mesh elements gradually increases
**See Also** a sample TUI Script of a :ref:`tui_1d_arithmetic` operation.
**See Also** a sample TUI Script of :ref:`Defining Arithmetic Progression and Geometric Progression hypothesis <tui_1d_arithmetic>` operation.
.. _geometric_1d_anchor:
@ -87,13 +87,12 @@ Geometric Progression hypothesis
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 usable only if 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. Use **Add** button to add the selected edges to the list.
:ref:'reversed_edges_helper_anchor' group assists you in
defining **Reversed Edges** parameter.
:ref:`Helper <reversed_edges_helper_anchor>` group assists you in defining **Reversed Edges** parameter.
.. image:: ../images/a-geometric1d.png
:align: center
**See Also** a sample TUI Script of a :ref:`tui_1d_arithmetic` operation.
**See Also** a sample TUI Script of :ref:`Defining Arithmetic Progression and Geometric Progression hypothesis <tui_1d_arithmetic>` operation.
.. _deflection_1d_anchor:
@ -111,9 +110,9 @@ A geometrical edge is divided into segments of length depending on edge curvatur
:align: center
.. centered::
"Deflection hypothesis - useful for meshing curvilinear edges"
Deflection hypothesis - useful for meshing curvilinear edges
**See Also** a sample TUI Script of a :ref:`tui_deflection_1d` operation.
**See Also** a sample TUI Script of :ref:`Defining Deflection hypothesis <tui_deflection_1d>` operation.
.. _average_length_anchor:
@ -141,9 +140,9 @@ If **precision** is more than 0.33(3) then the edge is divided into 4 segments.
:align: center
.. centered::
"Local Length hypothesis - all 1D mesh segments are equal"
Local Length hypothesis - all 1D mesh segments are equal
**See Also** a sample TUI Script of a :ref:`tui_average_length` hypothesis
**See Also** a sample TUI Script of :ref:`Defining Local Length <tui_average_length>` hypothesis
operation.
.. _max_length_anchor:
@ -152,7 +151,7 @@ Max Size
########
**Max Size** hypothesis allows splitting geometrical edges into segments not longer than the given length. Definition of this hypothesis consists of setting the maximal allowed **length** of segments.
**Use preestimated length** check box lets you use **length** automatically calculated basing on size of your geometrical object, namely as diagonal of bounding box divided by ten. The divider can be changed via :ref:`diagonal_size_ratio_pref` preference parameter.
**Use preestimated length** check box lets you use **length** automatically calculated basing on size of your geometrical object, namely as diagonal of bounding box divided by ten. The divider can be changed via :ref:`Ratio Bounding Box Diagonal / Max Size <diagonal_size_ratio_pref>` preference parameter.
**Use preestimated length** check box is enabled only if the geometrical object has been selected before hypothesis definition.
.. image:: ../images/a-maxsize1d.png
@ -163,13 +162,13 @@ Max Size
Number of Segments hypothesis
#############################
**Number of Segments** hypothesis can be applied for approximating edges by a definite number of mesh segments with length depending on the selected type of distribution of nodes. The default number of segments can be set via :ref:`nb_segments_pref` preference parameter.
**Number of Segments** hypothesis can be applied for approximating edges by a definite number of mesh segments with length depending on the selected type of distribution of nodes. The default number of segments can be set via :ref:`Automatic Parameters / Default Number of Segments <nb_segments_pref>` preference parameter.
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 it is possible to 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.
:ref:`reversed_edges_helper_anchor` group assists you in defining **Reversed Edges** parameter.
:ref:`Helper <reversed_edges_helper_anchor>` group assists you in defining **Reversed Edges** parameter.
You can set the type of node distribution for this hypothesis in the **Hypothesis Construction** dialog bog :
You can set the type of node distribution for this hypothesis in the **Hypothesis Construction** dialog box:
.. image:: ../images/a-nbsegments1.png
:align: center
@ -178,42 +177,32 @@ You can set the type of node distribution for this hypothesis in the **Hypothesi
**Scale Distribution** - length of segments gradually changes depending on the **Scale Factor**, which is a ratio of the first segment length to the last segment length.
Length of segments changes in geometric progression with the common ratio (A) depending on the **Scale Factor** (S) and **Number of Segments** (N) as follows: <code> A = S**(1/(N-1))</code>. For an edge of length L, length of the first segment is
::
L * (1 - A)/(1 - A**N)
Length of segments changes in geometric progression with the common ratio (A) depending on the **Scale Factor** (S) and **Number of Segments** (N) as follows: A = S**(1/(N-1)). For an edge of length L, length of the first segment is L * (1 - A)/(1 - A**N)
.. image:: ../images/a-nbsegments2.png
:align: center
.. _analyticdensity_anchor:
**Distribution with Analytic Density** - you input the formula, which will rule the change of length of segments and the module shows in the plot the density function curve in red and the nodedistribution as blue crosses.
**Distribution with Analytic Density** - you input the formula, which will rule the change of length of segments and the module shows in the plot the density function curve in red and the node distribution as blue crosses.
.. image:: ../images/distributionwithanalyticdensity.png
:align: center
.. _analyticdensity_anchor:
Analytic Density
================
The node distribution is computed so that to have the density function integral on the range between two nodes equal for all segments.
.. image:: ../images/analyticdensity.png
:align: center
**Distribution with Table Density** - you input a number of pairs **t - F(t)**, where **t** ranges from 0 to 1, and the module computes the formula, which will rule the change of length of segments and shows in the plot the density function curve in red and the node distribution as blue crosses. The node distribution is computed in the same way as for :ref:`analyticdensity_anchor`. You can select the **Conversion mode** from **Exponent** and **Cut negative**.
**Distribution with Table Density** - you input a number of pairs **t - F(t)**, where **t** ranges from 0 to 1, and the module computes the formula, which will rule the change of length of segments and shows in the plot the density function curve in red and the node distribution as blue crosses. The node distribution is computed in the same way as for :ref:`Distribution with Analytic Density <analyticdensity_anchor>`. You can select the **Conversion mode** from **Exponent** and **Cut negative**.
.. image:: ../images/distributionwithtabledensity.png
:align: center
**See Also** a sample TUI Script of a :ref:`tui_deflection_1d` hypothesis operation.
**See Also** a sample TUI Script of :ref:`Defining Number of Segments <tui_deflection_1d>` hypothesis operation.
.. The plot functionality is available only if GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
.. note:: The plot functionality is available only if GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
.. _start_and_end_length_anchor:
@ -224,7 +213,7 @@ Start and End Length hypothesis
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 it is possible to 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.
:ref:`reversed_edges_helper_anchor` group assists you in defining **Reversed Edges** parameter.
:ref:`Helper <reversed_edges_helper_anchor>` group assists you in defining **Reversed Edges** parameter.
.. image:: ../images/a-startendlength.png
@ -234,9 +223,9 @@ The direction of the splitting is defined by the orientation of the underlying g
:align: center
.. centered::
"The lengths of the first and the last segment are strictly defined"
The lengths of the first and the last segment are strictly defined
**See Also** a sample TUI Script of a :ref:`tui_start_and_end_length` hypothesis operation.
**See Also** a sample TUI Script of :ref:`Defining Start and End Length <tui_start_and_end_length>` hypothesis operation.
.. _automatic_length_anchor:
@ -255,13 +244,13 @@ Compare one and the same object (sphere) meshed with minimum and maximum value o
:align: center
.. centered::
"Example of a rough mesh at Automatic Length Fineness of 0."
Example of a rough mesh at Automatic Length Fineness of 0.
.. image:: ../images/image148.gif
:align: center
.. centered::
"Example of a fine mesh at Automatic Length Fineness of 1."
Example of a fine mesh at Automatic Length Fineness of 1.
.. _fixed_points_1d_anchor:
@ -277,16 +266,16 @@ It is possible to check in **Same Nb. Segments for all intervals** option and to
The splitting direction 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 opposite to their orientation. This list box is enabled only if the geometrical object is selected for meshing. In this case it is possible to select the edges to be reversed either directly picking them in the 3D viewer or selecting the edges or groups of edges in the Object Browser.
:ref:`reversed_edges_helper_anchor` group assists in defining **Reversed Edges** parameter.
:ref:`Helper <reversed_edges_helper_anchor>` group assists in defining **Reversed Edges** parameter.
.. image:: ../images/mesh_fixedpnt.png
:align: center
.. centered::
"Example of a sub-mesh on the edge built using Fixed Points hypothesis"
Example of a sub-mesh on the edge built using Fixed Points hypothesis
**See Also** a sample TUI Script of a :ref:`tui_fixed_points` hypothesis operation.
**See Also** a sample TUI Script of a :ref:`Defining Fixed Points <tui_fixed_points>` hypothesis operation.
.. _reversed_edges_helper_anchor:
@ -307,9 +296,8 @@ Reversed Edges Helper
:align: center
.. centered::
"The whole geometry and a propagation chain"
The whole geometry and a propagation chain
.. note::
Alternatively, uniform direction of edges of one propagation chain can be achieved by :ref:`constructing_submeshes_page` on one edge of the chain and assigning a :ref:`propagation_anchor` additional hypothesis. Orientation of this edge (and hence of all the rest edges of the chain) can be controlled by using **Reversed Edges** field.
.. note:: Alternatively, uniform direction of edges of one propagation chain can be achieved by :ref:`definition of a sub-mesh <constructing_submeshes_page>` on one edge of the chain and assigning a :ref:`Propagation <propagation_anchor>` additional hypothesis. Orientation of this edge (and hence of all the rest edges of the chain) can be controlled by using **Reversed Edges** field.

43
doc/salome/gui/SMESH/input/2d_meshing_hypo.rst
View File

@ -24,9 +24,9 @@ Max Element Area
:align: center
.. centered::
"In this example, Max. element area is very small compared to the 1D hypothesis"
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` hypothesis operation.
**See Also** a sample TUI Script of :ref:`tui_max_element_area` hypothesis operation.
.. _length_from_edges_anchor:
@ -35,7 +35,7 @@ Length from Edges
**Length from edges** hypothesis defines the maximum linear size of mesh faces as an average length of mesh edges approximating the meshed face boundary.
**See Also** a sample TUI Script of a :ref:`tui_length_from_edges` hypothesis operation.
**See Also** a sample TUI Script of :ref:`tui_length_from_edges` hypothesis operation.
.. _hypo_quad_params_anchor:
@ -46,7 +46,7 @@ Quadrangle parameters
:align: center
.. centered::
"Quadrangle parameters: Transition"
Quadrangle parameters: Transition
**Quadrangle parameters** is a hypothesis for :ref:`quad_ijk_algo_page`.
@ -55,13 +55,11 @@ Quadrangle parameters
* **Standard** is the default case, when both triangles and quadrangles are possible in the transition area along the finer meshed sides.
* **Triangle preference** forces building only triangles in the transition area along the finer meshed sides.
.. note::
This type corresponds to **Triangle Preference** additional hypothesis, which is obsolete now.
.. note:: This type corresponds to **Triangle Preference** additional hypothesis, which is obsolete now.
* **Quadrangle preference** forces building only quadrangles in the transition area along the finer meshed sides. This hypothesis has a restriction: the total quantity of segments on all four face sides must be even (divisible by 2).
.. note::
This type corresponds to **Quadrangle Preference** additional hypothesis, which is obsolete now.
.. note:: This type corresponds to **Quadrangle Preference** additional hypothesis, which is obsolete now.
* **Quadrangle preference (reversed)** works in the same way and with the same restriction as **Quadrangle preference**, but 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 total number of segments. 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 log<sub>3</sub>( Nmax / Nmin ). The number of face rows is equal to the number of segments on each of equally discretized sides.
@ -70,7 +68,7 @@ Quadrangle parameters
:align: center
.. centered::
"The fastest transition pattern: 3 to 1"
The fastest transition pattern: 3 to 1
**Base vertex** tab allows using Quadrangle: Mapping algorithm for meshing of trilateral faces. In this case it is necessary to select the vertex, which will be used as the forth degenerated side of quadrangle.
@ -78,19 +76,19 @@ Quadrangle parameters
:align: center
.. centered::
"Quadrangle parameters: Base Vertex"
Quadrangle parameters: Base Vertex
.. image:: ../images/ hypo_quad_params_1.png
:align: center
.. centered::
"A face built from 3 edges"
A face built from 3 edges
.. image:: ../images/ hypo_quad_params_res.png
:align: center
.. centered::
"The resulting mesh"
The resulting mesh
This parameter can be also used to mesh a segment of a circular face. Please, consider that there is a limitation on the selection of the vertex for the faces built with the angle > 180 degrees (see the picture).
@ -98,7 +96,7 @@ This parameter can be also used to mesh a segment of a circular face. Please, co
:align: center
.. centered::
"3/4 of a circular face"
3/4 of a circular face
In this case, selection of a wrong vertex for the **Base vertex** parameter will generate a wrong mesh. The picture below shows the good (left) and the bad (right) results of meshing.
@ -106,37 +104,38 @@ In this case, selection of a wrong vertex for the **Base vertex** parameter will
:align: center
.. centered::
"The resulting meshes"
The resulting meshes
.. image:: ../images/ hypo_quad_params_dialog_enf.png
:align: center
.. centered::
"Quadrangle parameters: Enforced nodes"
Quadrangle parameters: Enforced nodes
**Enforced nodes** tab allows defining points, where the algorithm should create nodes. There are two ways to define positions of the enforced nodes.
* **Vertices** group allows to set up shapes whose vertices will define positions of the enforced nodes. Only vertices successfully projected to the meshed face and located close enough to the meshed face will be used to create the enforced nodes.
* **Points** group allows to explicitly define coordinates of points used to create the enforced nodes. Only points successfully projected to the meshed face and located close enough to the meshed face will be used to create the enforced nodes.
* **Vertices** group allows to set up shapes whose vertices will define positions of the enforced nodes. Only vertices successfully projected to the meshed face and located close enough to the meshed face will be used to create the enforced nodes.
* **Points** group allows to explicitly define coordinates of points used to create the enforced nodes. Only points successfully projected to the meshed face and located close enough to the meshed face will be used to create the enforced nodes.
.. note::
**Enforced nodes** cannot be created at **Reduced** transition type.
Let us see how the algorithm works:
* Initially positions of nodes are computed without taking into account the enforced vertex (yellow point).
* Initially positions of nodes are computed without taking into account the enforced vertex (yellow point).
.. image:: ../images/ hypo_quad_params_enfnodes_algo1.png
:align: center
.. centered::
"Initial mesh"
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.
.. image:: ../images/ hypo_quad_params_enfnodes_algo2.png
:align: center
.. centered::
"Creation of virtual edges"
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 the detected node are moved to the virtual edges and the quadrilateral elements are constructed.
@ -144,10 +143,10 @@ Let us see how the algorithm works:
:align: center
.. centered::
"Final mesh"
Final mesh
If there are several enforced vertices, the algorithm is applied recursively to the formed sub-domains.
**See Also** a sample TUI Script of a :ref:`tui_quadrangle_parameters` hypothesis.
**See Also** a sample TUI Script of a :ref:`Quadrangle Parameters <tui_quadrangle_parameters>` hypothesis.

9
doc/salome/gui/SMESH/input/StdMeshersBuilder.rst Normal file
View File

@ -0,0 +1,9 @@
smesh_algorithm module
======================
.. automodule:: smesh_algorithm
:members:
StdMeshersBuilder module
========================
.. automodule:: StdMeshersBuilder
:members:

13
doc/salome/gui/SMESH/input/about_filters.rst
View File

@ -4,19 +4,20 @@
About filters
*************
**Filters** allow picking only the mesh elements satisfying to a specific condition or a set of conditions. Filters can be used to create or edit mesh groups, remove elements from the mesh, control mesh quality by different parameters, etc.
**Filters** allow picking only the mesh elements satisfying to a specific condition or a set of conditions. Filters can be used to create or edit mesh groups, remove elements from the mesh, control mesh quality by different parameters, etc.
Several criteria can be combined together by using logical operators *AND* and *OR*. In addition, a filter criterion can be reverted using logical operator *NOT*.
Some filtering criteria use the functionality of :ref:`quality_page`:"mesh quality controls" to filter mesh nodes / elements by specific characteristic (Area, Length, etc).
Some filtering criteria use the functionality of :ref:`mesh quality controls <quality_page>` to filter mesh nodes / elements by specific characteristic (Area, Length, etc).
The functinality of mesh filters is available in both GUI and TUI modes:
* In GUI, filters are available in some dialog boxes via "Set Filters" button, clicking on which opens the dialog box allowing to specify the list of filter criteria to be applied to the current selection. See :ref:`selection_filter_library_page` page to learn more about selection filters and their usage in GUI.
* In GUI, filters are available in some dialog boxes via "Set Filters" button, clicking on which opens the :ref:`dialog box <filtering_elements>` allowing to specify the list of filter criteria to be applied to the current selection. See :ref:`selection_filter_library_page` page to learn more about selection filters and their usage in GUI.
* In Python scripts, filters can be used to choose only some mesh entities (nodes or elements) for the operations, which require the list of entities as input parameter (create/modify group, remove nodes/elements, etc) and for the operations, which accept objects (groups, sub-meshes) as input parameter. The page :ref:`tui_filters_page` provides examples of the filters usage in Python scripts.
* In Python scripts, filters can be used to choose only some mesh nodes or elements for the operations, which require the list of entities as input parameter (create/modify group, remove nodes/elements, etc) and for the operations, which accept objects (groups, sub-meshes) as input parameter. The page :ref:`tui_filters_page` provides examples of the filters usage in Python scripts.
.. toctree::
:maxdepth: 2
:maxdepth: 2
:hidden:
selection_filter_library.rst
selection_filter_library.rst

51
doc/salome/gui/SMESH/input/about_hypo.rst
View File

@ -9,50 +9,23 @@ About Hypotheses
The choice of a hypothesis depends on the selected algorithm.
Hypotheses are created during creation and edition of
:ref:`constructing_meshes_page`:"meshes" and
:ref:`constructing_submeshes_page`:"sub-meshes".
:ref:`meshes <constructing_meshes_page>` and :ref:`sub-meshes <constructing_submeshes_page>`.
Once created a hypotheses can be reused during creation and edition of other meshes and sub-meshes. All created hypotheses and algorithms are present in the Object Browser in *Hypotheses* and *Algorithms* folders correspondingly. It is possible to open a dialog to modify the parameters of a hypothesis from its context menu. This menu also provides **Unassign** command that will unassign the hypothesis from all meshes and sub-meshes using it. Modification of any parameter of a hypothesis and its unassignment leads to automatic removal of elements generated using it.
In **MESH** there are the following Basic Hypotheses:
In **MESH** there are:
* :ref:`a1d_meshing_hypo_page` (for meshing of **edges**):
* :ref:`number_of_segments_anchor`
* :ref:`average_length_anchor`
* :ref:`max_length_anchor`
* :ref:`adaptive_1d_anchor`
* :ref:`arithmetic_1d_anchor`
* :ref:`geometric_1d_anchor`
* :ref:`start_and_end_length_anchor`
* :ref:`deflection_1d_anchor`
* :ref:`automatic_length_anchor`
* :ref:`fixed_points_1d_anchor`
* :ref:`a2d_meshing_hypo_page` (for meshing of **faces**):
* :ref:`max_element_area_anchor`
* :ref:`length_from_edges_anchor`
* :ref:`hypo_quad_params_anchor`
* 3D Hypothesis (for meshing of **volumes**):
* :ref:`max_element_volume_hypo_page`
There also exist :ref:`additional_hypo_page`:
* :ref:`propagation_anchor`
* :ref:`propagofdistribution_anchor`
* :ref:`viscous_layers_anchor`
* :ref:`quadratic_mesh_anchor`
* :ref:`quadrangle_preference_anchor`
* :ref:`a1d_meshing_hypo_page` for meshing of **edges**
* :ref:`a2d_meshing_hypo_page` for meshing of **faces**
* :ref:`3D Hypothesis <max_element_volume_hypo_page>` for meshing of **volumes**
* :ref:`additional_hypo_page`
**Table of Contents**
.. toctree::
:maxdepth: 2
:maxdepth: 2
1d_meshing_hypo.rst
2d_meshing_hypo.rst
max_element_volume_hypo.rst
additional_hypo.rst
1d_meshing_hypo.rst
2d_meshing_hypo.rst
3D: Max Element Volume hypothesis <max_element_volume_hypo>
additional_hypo.rst

54
doc/salome/gui/SMESH/input/about_meshes.rst
View File

@ -10,38 +10,38 @@ A SALOME study can contain multiple meshes, but they do not implicitly compose o
Mesh module provides several ways to create the mesh:
* The main way is to :ref:`constructing_meshes_page` on the basis of the geometrical shape produced in the Geometry module. This way implies selection of
* The main way is to :ref:`construct the mesh <constructing_meshes_page>` on the basis of the geometrical shape produced in the Geometry module. This way implies selection of
* a geometrical object (**main shape**) and
* **meshing parameters** ( :ref:`basic_meshing_algos_page` and characteristics (e.g. element size) of a required mesh encapsulated in :ref:`about_hypo_page` objects).
* a geometrical object (*main shape*) and
* *meshing parameters* (:ref:`meshing algorithms <basic_meshing_algos_page>` and characteristics (e.g. element size) of a required mesh encapsulated in :ref:`hypothesis <about_hypo_page>` objects).
Construction of :ref:`constructing_submeshes_page` allows to discretize some sub-shapes of the main shape, for example a face, using the meshing parameters that differ from those used for other sub-shapes.
Meshing parameters of meshes and sub-meshes can be :ref:`editing_meshes_page`. (Upon edition only mesh entities generated using changed meshing parameters are removed and will be re-computed).
Construction of :ref:`sub-meshes <constructing_submeshes_page>` allows to discretize some sub-shapes of the main shape, for example a face, using the meshing parameters that differ from those used for other sub-shapes.
Meshing parameters of meshes and sub-meshes can be :ref:`edited <editing_meshes_page>`. (Upon edition only mesh entities generated using changed meshing parameters are removed and will be re-computed).
.. note::
.. note::
Algorithms and hypotheses used at mesh level are referred to as *global* ones and those used at sub-mesh level are referred to as *local* ones.
* Bottom-up way, using :ref:`modifying_meshes_page` operations, especially :ref:`extrusion_page` and :ref:`revolution_page`. To create an empty mesh not based on geometry, use the same dialog as to :ref:`constructing_meshes_page` but specify neither the geometry nor meshing algorithms.
* Bottom-up way, using :ref:`mesh modification <modifying_meshes_page>` operations, especially :ref:`extrusion <extrusion_page>` and :ref:`revolution <revolution_page>`. To create an empty mesh not based on geometry, use the same dialog as to :ref:`construct the mesh on geometry <constructing_meshes_page>` but specify neither the geometry nor meshing algorithms.
* The mesh can be :ref:`importing_exporting_meshes_page` from (and exported to) the file in MED, UNV, STL, CGNS, DAT, GMF and SAUVE formats.
* The mesh can be :ref:`imported <importing_exporting_meshes_page>` from (and exported to) the file in MED, UNV, STL, CGNS, DAT, GMF and SAUVE formats.
* The 3D mesh can be generated from the 2D mesh not based on geometry, which was either :ref:`importing_exporting_meshes_page` or created in other way. To setup the meshing parameters of a mesh not based on geometry, just invoke :ref:`editing_meshes_page` command on your 2D mesh.
* The 3D mesh can be generated from the 2D mesh not based on geometry, which was either :ref:`imported <importing_exporting_meshes_page>` or created in other way. To setup the meshing parameters of a mesh not based on geometry, just invoke :ref:`Edit mesh / sub-mesh <editing_meshes_page>` command on your 2D mesh.
* Several meshes can be :ref:`building_compounds_page` into a new mesh.
* Several meshes can be :ref:`combined <building_compounds_page>` into a new mesh.
* The whole mesh or its part (sub-mesh or group) can be :ref:`copy_mesh_page` into a new mesh.
* The whole mesh or its part (sub-mesh or group) can be :ref:`copied <copy_mesh_page>` into a new mesh.
* A new mesh can be created from a transformed, e.g. :ref:`translation_page`, part of the mesh.
* A new mesh can be created from a transformed, e.g. :ref:`translated <translation_page>`, part of the mesh.
Meshes can be edited using the MESH functions destined for :ref:`modifying_meshes_page` of meshes.
Meshes can be edited using the MESH functions destined for :ref:`modification <modifying_meshes_page>` of meshes.
Attractive meshing capabilities include:
* 3D and 2D :ref:`viscous_layers_anchor` (boundary layers of highly stretched elements beneficial for high quality viscous computations);
* 3D and 2D :ref:`Viscous Layers <viscous_layers_anchor>` (boundary layers of highly stretched elements beneficial for high quality viscous computations);
* automatic conformal transition between tetrahedral and hexahedral sub-meshes.
The **structure** of a SALOME mesh is described by nodes and elements based on these nodes. The geometry of an element is defined by the sequence of nodes constituting it and the :ref:`connectivity_page` (adopted from MED library). Definition of the element basing on the elements of a lower dimension is NOT supported.
The **structure** of a SALOME mesh is described by nodes and elements based on these nodes. The geometry of an element is defined by the sequence of nodes constituting it and the :ref:`connectivity convention <connectivity_page>` (adopted from MED library). Definition of the element basing on the elements of a lower dimension is NOT supported.
.. _elementary geometrical elements:
@ -50,7 +50,7 @@ The mesh can include the following entities:
* **Node** - a mesh entity defining a position in 3D space with coordinates (x, y, z).
* **Edge** (or segment) - 1D mesh element linking two nodes.
* **Face** - 2D mesh element representing a part of surface bound by links between face nodes. A face can be a triangle, quadrangle or polygon.
* **Volume** - 3D mesh element representing a part of 3D space bound by volume facets. Nodes of a volume describing each facet are defined by the :ref:`connectivity_page`. A volume can be a tetrahedron, hexahedron, pentahedron, pyramid, hexagonal prism or polyhedron.
* **Volume** - 3D mesh element representing a part of 3D space bound by volume facets. Nodes of a volume describing each facet are defined by the :ref:`connectivity convention <connectivity_page>`. A volume can be a tetrahedron, hexahedron, pentahedron, pyramid, hexagonal prism or polyhedron.
* **0D** element - mesh element defined by one node.
* **Ball** element - discrete mesh element defined by a node and a diameter.
@ -69,13 +69,17 @@ Quadratic mesh can be obtained in three ways:
* Using :ref:`convert_to_from_quadratic_mesh_page` operation.
* Using an appropriate option of some meshing algorithms, which generate elements of several dimensions starting from mesh segments.
.. toctree::
:maxdepth: 2
constructing_meshes.rst
constructing_submeshes.rst
editing_meshes.rst
importing_exporting_meshes.rst
building_compounds.rst
copy_mesh.rst
connectivity.rst
**Table of Contents**
.. toctree::
:titlesonly:
:maxdepth: 2
constructing_meshes.rst
constructing_submeshes.rst
editing_meshes.rst
importing_exporting_meshes.rst
building_compounds.rst
copy_mesh.rst
connectivity.rst

8
doc/salome/gui/SMESH/input/about_quality_controls.rst
View File

@ -4,8 +4,7 @@
About quality controls
**********************
.. note::
**Mesh quality control** in MESH is destined for visual control of the generated mesh.
**Mesh quality control** in MESH is destined for visual control of the generated mesh.
Application of a definite quality control consists of usage of the corresponding algorithm, which calculates a value of a definite geometric characteristic (Area, Length of edges, etc) for all meshing elements, composing your mesh. Then all meshing elements are colored according the calculated values. The reference between the coloring of the meshing elements and these calculated values is shown with the help of a scalar bar, which is displayed near the presentation of your mesh.
@ -64,11 +63,12 @@ To manage the quality controls call pop-up in the VTK viewer and select "Control
* **Edge Controls** provides access to the edge quality controls;
* **Face Controls** provides access to the face quality controls;
* **Volume Controls** provides access to the volume quality controls;
* **Scalar Bar Properties** allows setting :ref:scalar_bar_dlg;
* **Scalar Bar Properties** allows setting :ref:`scalar_bar_dlg`;
* **Distribution -> Export ...** allows saving the distribution of quality control values in the text file;
* **Distribution -> Show** Shows/Hides the distribution histogram of the quality control values in the VTK Viewer.
* **Distribution -> Plot** Plots the distribution histogram of the quality control values in the Plot 2D Viewer.
**Table of Contents**
.. toctree::
:maxdepth: 2
@ -98,5 +98,3 @@ To manage the quality controls call pop-up in the VTK viewer and select "Control
bare_border_volumes.rst
over_constrained_volumes.rst
scalar_bar.rst

43
doc/salome/gui/SMESH/input/adding_nodes_and_elements.rst
View File

@ -6,23 +6,23 @@ Adding nodes and elements
In MESH you can add to your mesh different elements such as:
* :ref:`adding_nodes_anchor`
* :ref:`adding_0delems_anchor`
* :ref:`adding_0delems_on_all_nodes_anchor`
* :ref:`adding_balls_anchor`
* :ref:`adding_edges_anchor`
* :ref:`adding_triangles_anchor`
* :ref:`adding_quadrangles_anchor`
* :ref:`adding_polygons_anchor`
* :ref:`adding_tetrahedrons_anchor`
* :ref:`adding_hexahedrons_anchor`
* :ref:`adding_octahedrons_anchor`
* :ref:`adding_polyhedrons_anchor`
* :ref:`Nodes <adding_nodes_anchor>`
* :ref:`0D Elements <adding_0delems_anchor>`
* :ref:`0D elements on Element Nodes <adding_0delems_on_all_nodes_anchor>`
* :ref:`Ball Elements <adding_balls_anchor>`
* :ref:`Edges <adding_edges_anchor>`
* :ref:`Triangles <adding_triangles_anchor>`
* :ref:`Quadrangles <adding_quadrangles_anchor>`
* :ref:`Polygons <adding_polygons_anchor>`
* :ref:`Tetrahedrons <adding_tetrahedrons_anchor>`
* :ref:`Hexahedrons <adding_hexahedrons_anchor>`
* :ref:`Hexagonal prism <adding_octahedrons_anchor>`
* :ref:`Polyhedrons <adding_polyhedrons_anchor>`
The convention of nodal connectivity of elements used in SALOME is the MED library convention. You can consult the description of nodal connectivity of elements in the documentation on MED library or :ref:`connectivity_page`.
The convention of nodal connectivity of elements used in SALOME is the MED library convention. You can consult the description of nodal connectivity of elements in the documentation on MED library or :ref:`here <connectivity_page>`.
**To add a node or an element to your mesh:**
*To add a node or an element to your mesh:*
#. Select your mesh in the Object Browser or in the 3D viewer.
#. From the **Modification** menu choose the **Add** item, the following associated sub-menu will appear:
@ -30,16 +30,9 @@ The convention of nodal connectivity of elements used in SALOME is the MED libra
.. image:: ../images/image152.png
:align: center
From this sub-menu select the type of element which you would like to add to your mesh.
From this sub-menu select the type of element which you would like to add to your mesh.
.. note::
All dialogs for new node or element adding to the mesh provide the possibility to automatically add a node or element to the specified group or to create it anew using **Add to group** box, that allows choosing an existing group for the created node or element or giving the name to a new group. By default, the **Add to group** check box is switched off. If the user switches this check box on, the combo box listing all currently existing groups of the corresponding type becomes available. By default, no group is selected. In this case, when the user presses **Apply** or **Apply & Close** button, the warning message box informs the user about the necessity to input new group name. The combo box lists groups of all the
:ref:`grouping_elements_page`: both
:ref:`standalone_group`,
:ref:`group_on_filter`, and
:ref:`group_on_geom`. If the user chooses a group on geometry or on filter, he is warned and proposed to convert this group to standalone.
If the user rejects conversion operation, it is cancelled and a new node/element is not created!
.. note:: All dialogs for new node or element adding to the mesh provide the possibility to automatically add a node or element to the specified group or to create it anew using **Add to group** box, that allows choosing an existing group for the created node or element or giving the name to a new group. By default, the **Add to group** check box is switched off. If the user switches this check box on, the combo box listing all currently existing groups of the corresponding type becomes available. By default, no group is selected. In this case, when the user presses **Apply** or **Apply & Close** button, the warning message box informs the user about the necessity to input new group name. The combo box lists groups of all the :ref:`three types <grouping_elements_page>`: both :ref:`standalone groups <standalone_group>`, :ref:`groups on filter <group_on_filter>`, and :ref:`groups on geometry <group_on_geom>`. If the user chooses a group on geometry or on filter, he is warned and proposed to convert this group to standalone. If the user rejects conversion operation, it is cancelled and a new node/element is not created!
**See Also** sample TUI Scripts of :ref:`tui_adding_nodes_and_elements` operations.
@ -91,9 +84,9 @@ In this dialog
* **Elements** - this button allows selecting elements in the VTK viewer or typing their IDs in the dialog.
* **Nodes** - this button allows selecting nodes to create 0D elements on in the VTK viewer or typing their IDs in the dialog.
* **Set Filter** button allows selecting elements or nodes by filtering mesh elements or nodes with different criteria (see :ref:`filtering_elements`).
* **Set Filter** button allows selecting elements or nodes by filtering mesh elements or nodes with different criteria (see :ref:`Filter usage <filtering_elements>`).
* Activate **Allow duplicate elements** to get several 0D elements on a node.
* Switching on **Add to group** check-box allows specifying the name of the group to which all created or found (existing) 0D elements will be added. You can either select an existing group from a drop-down list, or enter the name of the group to be created. If a selected existing :ref:`grouping_elements_page` is not Standalone (Group On Geometry or Group On Filter) it will be converted to Standalone.
* Switching on **Add to group** check-box allows specifying the name of the group to which all created or found (existing) 0D elements will be added. You can either select an existing group from a drop-down list, or enter the name of the group to be created. If a selected existing :ref:`group <grouping_elements_page>` is not Standalone (Group On Geometry or Group On Filter) it will be converted to Standalone.
.. warning:: If **Add to group** is activated it has to be filled in.

10
doc/salome/gui/SMESH/input/adding_quadratic_elements.rst
View File

@ -11,7 +11,7 @@ Quadratic elements are defined by the same corner nodes as the corresponding lin
If a quadratic 2D element has an additional node at the element center, it is a bi-quadratic element (both TRIA7 and QUAD9 elements are supported). If a quadratic hexahedral element has 7 additional nodes: at the element center and at the center of each side, it is a tri-quadratic element (or HEXA27).
The convention of nodal connectivity of elements used in SALOME is the MED library convention. You can consult the description of nodal connectivity of elements in the documentation on MED library or :ref:`connectivity_page`.
The convention of nodal connectivity of elements used in SALOME is the MED library convention. You can consult the description of nodal connectivity of elements in the documentation on MED library or :ref:`here <connectivity_page>`.
There are several ways to create quadratic elements in your mesh:
@ -29,13 +29,7 @@ There are several ways to create quadratic elements in your mesh:
:align: center
.. note::
All dialogs for adding quadratic element to the mesh provide the possibility to automatically add an element to the specified group or to create the group anew using **Add to group** box, that allows choosing an existing group for the created node or element or giving the name to a new group. By default, the **Add to group** check box is switched off. If the user switches this check box on, the combo box listing all currently existing groups of the corresponding type becomes available. By default, no group is selected. In this case, when the user presses **Apply** or **Apply & Close** button, the warning message box informs the user about the necessity to input a new group name. The combo box lists groups of all the
:ref:`grouping_elements_page` both
:ref:`standalone_group`,
:ref:`group_on_filter`, and
:ref:`group_on_geom`. If the user chooses a group on geometry or on filter, he is warned and proposed to convert this group to standalone.
If the user rejects conversion operation, it is cancelled and a new quadratic element is not created.
All dialogs for adding quadratic element to the mesh provide the possibility to automatically add an element to the specified group or to create the group anew using **Add to group** box, that allows choosing an existing group for the created node or element or giving the name to a new group. By default, the **Add to group** check box is switched off. If the user switches this check box on, the combo box listing all currently existing groups of the corresponding type becomes available. By default, no group is selected. In this case, when the user presses **Apply** or **Apply & Close** button, the warning message box informs the user about the necessity to input a new group name. The combo box lists groups of all the :ref:`three types <grouping_elements_page>`: both :ref:`standalone groups <standalone_group>`, :ref:`groups on filter <group_on_filter>`, and :ref:`groups on geometry <group_on_geom>`. If the user chooses a group on geometry or on filter, he is warned and proposed to convert this group to standalone. If the user rejects conversion operation, it is cancelled and a new node/element is not created!
To create any **Quadratic Element** specify the nodes which will form your element by selecting them in the 3D viewer with pressed Shift button and click *Selection* button to the right of **Corner Nodes** label. Their numbers will appear in the dialog box as **Corner Nodes** (alternatively you can just input numbers in this field without selection; note that to use this way the mesh should be selected before invoking this operation). The edges formed by the corner nodes will appear in the table. To define the middle nodes for each edge, double-click on the respective field and input the number of the node (or pick the node in the viewer). For bi-quadratic and tri-quadratic elements, your also need to specify central nodes. As soon as all needed nodes are specified, a preview of a new quadratic element will be displayed in the 3D viewer. Then you will be able to click **Apply** or **Apply and Close** button to add the element to the mesh.

53
doc/salome/gui/SMESH/input/additional_hypo.rst
View File

@ -6,14 +6,14 @@ Additional Hypotheses
**Additional Hypotheses** can be applied as a supplement to the main hypotheses, introducing additional concepts to mesh creation.
An **Additional Hypothesis** can be defined in the same way as any main hypothesis in :ref:`create_mesh_anchor` or :ref:`constructing_submeshes_page` dialog.
An **Additional Hypothesis** can be defined in the same way as any main hypothesis in :ref:`Create Mesh <create_mesh_anchor>` or :ref:`Create Sub-Mesh <constructing_submeshes_page>` dialog.
The following additional hypothesis are available:
* :ref:`propagation_anchor` and :ref:`propagofdistribution_anchor` hypotheses are useful for creation of quadrangle and hexahedral meshes.
* :ref:`viscous_layers_anchor` and :ref:`viscous_layers_anchor` hypotheses allow creation of layers of highly stretched elements near mesh boundary, which is beneficial for high quality viscous computations.
* :ref:`Viscous Layers <viscous_layers_anchor>` and :ref:`Viscous Layers 2D <viscous_layers_anchor>` hypotheses allow creation of layers of highly stretched elements near mesh boundary, which is beneficial for high quality viscous computations.
* :ref:`quadratic_mesh_anchor` hypothesis allows generation of second order meshes.
* :ref:`quadrangle_preference_anchor` enables generation of quadrangles.
* :ref:`quadrangle_preference_anchor` hypothesis enables generation of quadrangles.
@ -32,10 +32,10 @@ whole geometry, and this propagation stops at an edge with other local
meshing parameters.
This hypothesis can be taken into account by
:ref:`a1d_algos_anchor` and
:ref:`a1d_algos_anchor` "Composite Side Discretization" algorithms.
:ref:`Wire Discretization <a1d_algos_anchor>` and
:ref:`Composite Side Discretization <a1d_algos_anchor>` algorithms.
**See Also** a sample TUI Script of a :ref:`tui_propagation` operation
**See Also** a sample TUI Script of a :ref:`Propagation hypothesis <tui_propagation>` operation
.. _propagofdistribution_anchor:
@ -50,10 +50,10 @@ relations between segment lengths, unless another hypothesis
has been locally defined on the opposite edge.
This hypothesis can be taken into account by
:ref:`a1d_algos_anchor` "Wire Discretization" and
:ref:`a1d_algos_anchor` "Composite Side Discretization" algorithms.
:ref:`Wire Discretization <a1d_algos_anchor>` and
:ref:`Composite Side Discretization <a1d_algos_anchor>` algorithms.
**See Also** a sample TUI Script of a :ref:`tui_propagation` operation
**See Also** a sample TUI Script of a :ref:`Propagation hypothesis <tui_propagation>` operation
.. _viscous_layers_anchor:
@ -80,24 +80,25 @@ computations.
* **Number of layers** - defines the number of element layers.
* **Stretch factor** - defines the growth factor of element height from the mesh boundary inwards.
* **Extrusion method** (available in 3D only) - defines how positions of nodes are found during prism construction and how the creation of distorted and intersecting prisms is prevented.
* **Surface offset + smooth** method extrudes nodes along the normal to the underlying geometrical surface. Smoothing of the internal surface of element layers is possible to avoid creation of invalid prisms.
* **Face offset** method extrudes nodes along the average normal of surrounding mesh faces to the intersection with a neighbor mesh face translated along its own normal by the thickness of layers. The thickness of layers can be limited to avoid creation of invalid prisms.
* **Node offset** method extrudes nodes along the average normal of surrounding mesh faces by the thickness of layers. The thickness of layers can be limited to avoid creation of invalid prisms.
* **Surface offset + smooth** method extrudes nodes along the normal to the underlying geometrical surface. Smoothing of the internal surface of element layers is possible to avoid creation of invalid prisms.
* **Face offset** method extrudes nodes along the average normal of surrounding mesh faces to the intersection with a neighbor mesh face translated along its own normal by the thickness of layers. The thickness of layers can be limited to avoid creation of invalid prisms.
* **Node offset** method extrudes nodes along the average normal of surrounding mesh faces by the thickness of layers. The thickness of layers can be limited to avoid creation of invalid prisms.
.. image:: ../images/viscous_layers_extrusion_method.png
:align: center
.. centered::
"Prisms created by the tree extrusion methods at the same other parameters"
Prisms created by the tree extrusion methods at the same other parameters
* **Specified Faces/Edges are** - defines how the shapes specified by the next parameter are used.
* **Faces/Edges with/without layers** - defines geometrical faces or edges on which element layers either should be or should not be constructed, depending on the value of the previous parameter (**Specified Faces/Edges are**). Faces (or edges) can be selected either in the Object Browser or in the VTK Viewer. **Add** button becomes active as soon as a suitable sub-shape is selected.
.. note::
A mesh shown in the 3D Viewer can prevent selection of faces and edges, just hide the mesh to avoid this. If a face, which should be selected, is hidden by other faces, consider creating a group of faces to be selected in the Geometry module. To avoid a long wait when a geometry with many faces (or edges) is displayed, the number of faces (edges) shown at a time is limited by the value of "Sub-shapes preview chunk size" preference (in Preferences/Mesh/General tab).
.. note::
A mesh shown in the 3D Viewer can prevent selection of faces and edges, just hide the mesh to avoid this. If a face, which should be selected, is hidden by other faces, consider creating a group of faces to be selected in the Geometry module. To avoid a long wait when a geometry with many faces (or edges) is displayed, the number of faces (edges) shown at a time is limited by the value of :ref:`Sub-shapes preview chunk size <chunk_size_pref>` preference (in Preferences/Mesh/General tab).
If faces/edges without layers are specified, the element layers are
If faces/edges without layers are specified, the element layers are
not constructed on geometrical faces shared by several solids in 3D
case and edges shared by several faces in 2D case. In other words,
in this mode the element layers can be constructed on boundary faces
@ -107,13 +108,13 @@ If faces/edges without layers are specified, the element layers are
boundary faces/edges of the shape of this sub-mesh, at same time
possibly being internal faces/edges within the whole model.
.. image:: ../images/viscous_layers_on_submesh.png
:align: center
.. image:: ../images/viscous_layers_on_submesh.png
:align: center
.. centered::
.. centered::
2D viscous layers constructed on boundary edges of a sub-mesh on a disk face.
If you use **several** hypotheses to define viscous layers on faces of
If you use **several** hypotheses to define viscous layers on faces of
one solid, keep in mind the following. Each hypothesis defines a set
of faces with viscous layers (even if you specify faces without
layers). The sets of faces with viscous layers defined by several
@ -144,9 +145,9 @@ links between element nodes are not straight but curved lines due to
presence of an additional mid-side node).
This 1D hypothesis can be taken into account by
:ref:`a1d_algos_anchor` "Wire Discretization" and
:ref:`a1d_algos_anchor` "Composite Side Discretization" algorithms. To create a quadratic mes assign this hypothesis at
:ref:`constructing_meshes_page`.
:ref:`Wire Discretization <a1d_algos_anchor>` and
:ref:`Composite Side Discretization <a1d_algos_anchor>` algorithms. To create a quadratic mes assign this hypothesis at
:ref:`mesh construction <constructing_meshes_page>`.
See :ref:`adding_quadratic_elements_page` for more information about quadratic meshes.
@ -159,8 +160,8 @@ Quadrangle Preference
This additional hypothesis can be used together with 2D triangulation algorithms.
It allows 2D triangulation algorithms to build quadrangular meshes.
Usage of this hypothesis with "Quadrangle: Mapping" meshing algorithm is obsolete since introducing :ref:`hypo_quad_params_anchor` "Quadrangle parameters" hypothesis.
Usage of this hypothesis with "Quadrangle: Mapping" meshing algorithm corresponds to specifying "Quadrangle Preference" transition type of :ref:`hypo_quad_params_anchor` "Quadrangle parameters" hypothesis.
Usage of this hypothesis with :ref:`Quadrangle: Mapping <quad_ijk_algo_page>` meshing algorithm is obsolete since introducing :ref:`Quadrangle parameters <hypo_quad_params_anchor>` hypothesis.
Usage of this hypothesis with :ref:`Quadrangle: Mapping <quad_ijk_algo_page>` meshing algorithm corresponds to specifying *Quadrangle Preference* transition type of :ref:`Quadrangle parameters <hypo_quad_params_anchor>` hypothesis.
.. note::
"Quadrangle Preference" transition type can be used only if the total quantity of segments on all sides of the face is even (divisible by 2), else "Standard" transition type is used.
*Quadrangle Preference* transition type can be used only if the total quantity of segments on all sides of the face is even (divisible by 2), else *Standard* transition type is used.

17
doc/salome/gui/SMESH/input/area.rst
View File

@ -5,19 +5,14 @@
Area
****
.. note:: **Area** mesh quality control is based on the algorithm of area
calculation of mesh faces.
**Area** mesh quality control is based on the algorithm of area calculation of mesh faces.
**To apply the Area quality control to your mesh:**
*To apply the Area quality control to your mesh:*
.. |img| image:: ../images/image35.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Area** or click **"Area"** button.
.. image:: ../images/image35.png
:align: center
.. centered::
**"Area" button**
#. Choose **Controls > Face Controls > Area** or click **"Area"** button |img|.
Your mesh will be displayed in the viewer with its faces colored
according to the applied mesh quality control criterion:
@ -26,5 +21,5 @@ according to the applied mesh quality control criterion:
:align: center
**See Also** a sample TUI Script of an :ref:`tui_area` operation.
**See Also** a sample TUI Script of an :ref:`tui_area` filter.

19
doc/salome/gui/SMESH/input/aspect_ratio.rst
View File

@ -17,24 +17,17 @@ The **Aspect Ratio** quality criterion for mesh elements reveals the degree of c
.. image:: ../images/formula5.png
:align: center
**To apply the Aspect Ratio quality criterion to your mesh:**
*To apply the Aspect Ratio quality criterion to your mesh:*
.. |img| image:: ../images/image37.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Aspect Ratio** or click **Aspect Ratio** button in the toolbar.
#. Choose **Controls > Face Controls > Aspect Ratio** or click *Aspect Ratio* button |img| in the toolbar.
.. image:: ../images/image37.png
:align: center
.. centered::
Aspect Ratio button
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/image94.jpg
:align: center
**See Also** a sample TUI Script of an :ref:`tui_aspect_ratio` operation.
**See Also** a sample TUI Script of an :ref:`tui_aspect_ratio` filter.

18
doc/salome/gui/SMESH/input/aspect_ratio_3d.rst
View File

@ -16,23 +16,17 @@ The **Aspect Ratio 3D** mesh quality criterion calculates the same parameter as
.. image:: ../images/formula2.png
:align: center
**To apply the Aspect Ratio 3D quality criterion to your mesh:**
*To apply the Aspect Ratio 3D quality criterion to your mesh:*
.. |img| image:: ../images/image144.png
#. Display your mesh in the viewer.
#. Choose **Controls > Volume Controls > Aspect Ratio 3D** or click **"Aspect Ratio 3D"** button of the toolbar.
#. Choose **Controls > Volume Controls > Aspect Ratio 3D** or click *"Aspect Ratio 3D"* button |img| of the toolbar.
.. image:: ../images/image144.png
:align: center
.. centered::
"Aspect Ratio 3D" button
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/image86.jpg
:align: center
**See Also** a sample TUI Script of a :ref:`tui_aspect_ratio_3d` operation.
**See Also** a sample TUI Script of a :ref:`tui_aspect_ratio_3d` filter.

3
doc/salome/gui/SMESH/input/bare_border_face.rst
View File

@ -12,5 +12,4 @@ color different from the color of shared faces.
.. image:: ../images/bare_border_faces_smpl.png
:align: center
**See also** A sample TUI Script making a group of faces highlighted in the picture is :ref:`tui_bare_border_faces`.
**See also** a sample :ref:`TUI Script <tui_bare_border_faces>` making a group of faces highlighted in the picture.

3
doc/salome/gui/SMESH/input/bare_border_volumes.rst
View File

@ -12,6 +12,5 @@ color different from the color of shared volumes.
.. image:: ../images/bare_border_volumes_smpl.png
:align: center
**See also** A sample TUI Script making a group of volumes highlighted in the
picture is :ref:`tui_bare_border_volumes`.
**See also** a sample :ref:`TUI Script <tui_bare_border_volumes>` making a group of volumes highlighted in the picture.

92
doc/salome/gui/SMESH/input/basic_meshing_algos.rst
View File

@ -6,74 +6,59 @@ Basic meshing algorithms
The MESH module contains a set of meshing algorithms, which are used for meshing entities (1D, 2D, 3D sub-shapes) composing geometrical objects.
.. note:: Algorithms added to the module as plug-ins are described in documentation of the plug-ins.
An algorithm represents either an implementation of a certain meshing technique or an interface to the whole meshing program generating elements of several dimensions.
.. _a1d_algos_anchor:
1D Entities
===========
* For meshing of 1D entities (**edges**):
* **Wire Discretization** meshing algorithm - splits an edge into a number of mesh segments following an 1D hypothesis.
* **Composite Side Discretization** algorithm - allows to apply a 1D hypothesis to a whole side of a geometrical face even if it is composed of several edges provided that they form C1 curve in all faces of the main shape.
* **Wire Discretization** meshing algorithm - splits an edge into a number of mesh segments following an 1D hypothesis.
* **Composite Side Discretization** algorithm - allows to apply a 1D hypothesis to a whole side of a geometrical face even if it is composed of several edges provided that they form C1 curve in all faces of the main shape.
* For meshing of 2D entities (**faces**):
* **Triangle: Mefisto** meshing algorithm - splits faces into triangular elements.
* :ref:`quad_ijk_algo_page` meshing algorithm - splits faces into quadrangular elements.
* **Triangle: Mefisto** meshing algorithm - splits faces into triangular elements.
* :ref:`Quadrangle: Mapping <quad_ijk_algo_page>` meshing algorithm - splits faces into quadrangular elements.
.. image:: ../images/image123.gif
:align: center
.. centered::
"Example of a triangular 2D mesh"
Example of a triangular 2D mesh
.. image:: ../images/image124.gif
:align: center
.. centered::
"Example of a quadrangular 2D mesh"
Example of a quadrangular 2D mesh
* For meshing of 3D entities (**solid objects**):
* For meshing of 3D entities (**solid objects**):
* **Hexahedron (i,j,k)** meshing algorithm - solids are split into hexahedral elements thus forming a structured 3D mesh. The algorithm requires that 2D mesh generated on a solid could be considered as a mesh of a box, i.e. there should be eight nodes shared by three quadrangles and the rest nodes should be shared by four quadrangles.
* **Hexahedron (i,j,k)** meshing algorithm - solids are split into hexahedral elements thus forming a structured 3D mesh. The algorithm requires that 2D mesh generated on a solid could be considered as a mesh of a box, i.e. there should be eight nodes shared by three quadrangles and the rest nodes should be shared by four quadrangles.
.. image:: ../images/hexa_ijk_mesh.png
:align: center
.. centered::
"Structured mesh generated by Hexahedron (i,j,k) on a solid bound by 16 faces"
.. centered::
Structured mesh generated by Hexahedron (i,j,k) on a solid bound by 16 faces
* :ref:`Body Fitting <cartesian_algo_page>` meshing algorithm - solids are split into hexahedral elements forming a Cartesian grid; polyhedra and other types of elements are generated where the geometrical boundary intersects Cartesian cells.
* :ref:`cartesian_algo_page` meshing algorithm - solids are split into hexahedral elements forming a Cartesian grid; polyhedra and other types of elements are generated where the geometrical boundary intersects Cartesian cells.
.. image:: ../images/image125.gif
:align: center
Some 3D meshing algorithms, such as Hexahedron(i,j,k) also can
generate 3D meshes from 2D meshes, working without geometrical objects.
.. centered::
"Example of a tetrahedral 3D mesh"
* There is also a number of more specific algorithms:
.. image:: ../images/image126.gif
:align: center
.. centered::
"Example of a hexahedral 3D mesh"
Some 3D meshing algorithms, such as Hexahedron(i,j,k) also can
generate 3D meshes from 2D meshes, working without geometrical
objects.
There is also a number of more specific algorithms:
* :ref:`prism_3d_algo_page` - for meshing prismatic 3D shapes with hexahedra and prisms.
* :ref:`quad_from_ma_algo_page` - for quadrangle meshing of faces with sinuous borders and rings.
* **Polygon per Face** meshing algorithm - generates one mesh face (either a triangle, a quadrangle or a polygon) per a geometrical face using all nodes from the face boundary.
* :ref:`projection_algos_page` - for meshing by projection of another mesh.
* :ref:`import_algos_page` - for meshing by importing elements from another mesh.
* :ref:`radial_prism_algo_page` - for meshing 3D geometrical objects with cavities with hexahedra and prisms.
* :ref:`radial_quadrangle_1D2D_algo_page` - for quadrangle meshing of disks and parts of disks.
* :ref:`use_existing_page` - to create a 1D or a 2D mesh in a python script.
* :ref:`segments_around_vertex_algo_page` - for defining the length of mesh segments around certain vertices.
* :ref:`Extrusion 3D <prism_3d_algo_page>` - for meshing prismatic 3D shapes with hexahedra and prisms.
* :ref:`Quadrangle: Medial Axis Projection <quad_from_ma_algo_page>` - for quadrangle meshing of faces with sinuous borders and rings.
* **Polygon per Face** meshing algorithm - generates one mesh face (either a triangle, a quadrangle or a polygon) per a geometrical face using all nodes from the face boundary.
* :ref:`Projection algorithms <projection_algos_page>` - for meshing by projection of another mesh.
* :ref:`Import algorithms <import_algos_page>` - for meshing by importing elements from another mesh.
* :ref:`Radial Prism <radial_prism_algo_page>` - for meshing 3D geometrical objects with cavities with hexahedra and prisms.
* :ref:`Radial Quadrangle 1D-2D <radial_quadrangle_1D2D_algo_page>` - for quadrangle meshing of disks and parts of disks.
* :ref:`Use Faces/Edges to be Created Manually <use_existing_page>` - to create a 1D or a 2D mesh in a python script.
* :ref:`Segments around Vertex <segments_around_vertex_algo_page>` - for defining the length of mesh segments around certain vertices.
:ref:`constructing_meshes_page` page describes in detail how to apply meshing algorithms.
@ -82,16 +67,17 @@ There is also a number of more specific algorithms:
.. toctree::
:maxdepth: 2
:maxdepth: 2
:hidden:
quad_ijk_algo.rst
cartesian_algo.rst
prism_3d_algo.rst
quad_from_ma_algo.rst
projection_algos.rst
use_existing_algos.rst
radial_prism_algo.rst
radial_quadrangle_1D2D_algo.rst
define_mesh_by_script.rst
segments_around_vertex_algo.rst
quad_ijk_algo.rst
cartesian_algo.rst
prism_3d_algo.rst
quad_from_ma_algo.rst
projection_algos.rst
use_existing_algos.rst
radial_prism_algo.rst
radial_quadrangle_1D2D_algo.rst
define_mesh_by_script.rst
segments_around_vertex_algo.rst

2
doc/salome/gui/SMESH/input/borders_at_multi_connection.rst
View File

@ -11,5 +11,5 @@ This mesh quality control highlights segments according to the number of element
In this picture the borders at multi-connection are displayed in blue.
**See Also** a sample TUI Script of a :ref:`tui_borders_at_multiconnection` operation.
**See Also** a sample TUI Script of a :ref:`tui_borders_at_multiconnection` filter.

3
doc/salome/gui/SMESH/input/borders_at_multi_connection_2d.rst
View File

@ -9,5 +9,4 @@ This mesh quality control highlights borders of faces (links between nodes) acco
.. image:: ../images/image127.gif
:align: center
**See Also** a sample TUI Script of a :ref:`tui_borders_at_multiconnection_2d` operation.
**See Also** a sample TUI Script of a :ref:`tui_borders_at_multiconnection_2d` filter.

34
doc/salome/gui/SMESH/input/building_compounds.rst
View File

@ -7,43 +7,37 @@ Building Compound Meshes
Compound Mesh is a combination of several meshes. All elements and groups present in input meshes are present in the compound mesh. However, it does not use geometry or hypotheses of the initial meshes.
The links between the input meshes and the compound mesh are not supported, consequently the modification of an input mesh does not lead to the update of the compound mesh.
**To Build a compound mesh:**
*To Build a compound mesh:*
From the **Mesh** menu select **Build Compound** or click **"Build Compound Mesh"** button in the toolbar.
.. |img| image:: ../images/image161.png
.. image:: ../images/image161.png
:align: center
**"Build Compound Mesh" button**
The following dialog box will appear:
From the **Mesh** menu select **Build Compound** or click *"Build Compound Mesh"* button |img| in the toolbar. The following dialog box will appear:
.. image:: ../images/buildcompound.png
:align: center
* **Name** - allows selecting the name of the resulting **Compound** mesh.
* **Meshes, sub-meshes, groups** - allows selecting the meshes, sub-meshes and groups to be concatenated. They can be chosen in the Object Browser while holding **Ctrl** button.
* **Processing identical groups** - allows selecting the method of processing the namesake groups existing in the input meshes. They can be either
* **Name** - allows selecting the name of the resulting **Compound** mesh.
* **Meshes, sub-meshes, groups** - allows selecting the meshes, sub-meshes and groups to be concatenated. They can be chosen in the Object Browser while holding **Ctrl** button.
* **Processing identical groups** - allows selecting the method of processing the namesake groups existing in the input meshes. They can be either
* **United** - all elements of **Group1** of **Mesh_1** and **Group1** of **Mesh_2** become the elements of **Group1** of the **Compound_Mesh**, or
* **Renamed** - **Group1** of **Mesh_1** becomes **Group1_1** and **Group1** of **Mesh_2** becomes **Group1_2**.
* **United** - all elements of *Group1* of *Mesh_1* and *Group1* of *Mesh_2* become the elements of *Group1* of the *Compound_Mesh*, or
* **Renamed** - *Group1* of *Mesh_1* becomes *Group1_1* and *Group1* of *Mesh_2* becomes *Group1_2*.
See :ref:`grouping_elements_page` for more information about groups.
* **Create groups from input objects** check-box permits to automatically create groups corresponding to every initial mesh.
See :ref:`grouping_elements_page` for more information about groups.
* **Create groups from input objects** check-box permits to automatically create groups corresponding to every initial mesh.
.. image:: ../images/buildcompound_groups.png
:align: center
.. centered::
"Groups created from input meshes 'Box_large' and 'Box_small'"
Groups created from input meshes 'Box_large' and 'Box_small'
* You can choose to additionally :ref:`merging_nodes_page`, :ref:`merging_elements_page` in the compound mesh, in which case it is possible to define the **Tolerance** for this operation.
* You can choose to additionally :ref:`Merge coincident nodes <merging_nodes_page>` :ref:`and elements <merging_elements_page>` in the compound mesh, in which case it is possible to define the **Tolerance** for this operation.
.. image:: ../images/image160.gif
:align: center
.. centered::
"Example of a compound of two meshed cubes"
Example of a compound of two meshed cubes
**See Also** a sample :ref:`tui_building_compound`.
**See Also** a sample script of :ref:`tui_building_compound`.

23
doc/salome/gui/SMESH/input/cartesian_algo.rst
View File

@ -13,16 +13,17 @@ boundary.
:align: center
.. centered::
"A sphere meshed by Body Fitting algorithm"
A sphere meshed by Body Fitting algorithm
The meshing algorithm is as follows.
#. Lines of a Cartesian structured grid defined by :ref:`cartesian_hyp_anchor` hypothesis are intersected with the geometry boundary, thus nodes lying on the boundary are found. This step also allows finding out for each node of the Cartesian grid if it is inside or outside the geometry.
#. Lines of a Cartesian structured grid defined by :ref:`Body Fitting Parameters <cartesian_hyp_anchor>` hypothesis are intersected with the geometry boundary, thus nodes lying on the boundary are found. This step also allows finding out for each node of the Cartesian grid if it is inside or outside the geometry.
#. For each cell of the grid, check how many of its nodes are outside of the geometry boundary. Depending on a result of this check
#. skip a cell, if all its nodes are outside
#. skip a cell, if it is too small according to **Size Threshold** parameter
#. add a hexahedron in the mesh, if all nodes are inside
#. add a polyhedron or another cell type in the mesh, if some nodes are inside and some outside.
* skip a cell, if all its nodes are outside
* skip a cell, if it is too small according to **Size Threshold** parameter
* add a hexahedron in the mesh, if all nodes are inside
* add a polyhedron or another cell type in the mesh, if some 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 add **Body Fitting Parameters** hypothesis. The following dialog will appear:
@ -35,7 +36,7 @@ Body Fitting Parameters hypothesis
:align: center
.. centered::
"Body Fitting Parameters hypothesis dialog"
Body Fitting Parameters hypothesis dialog
This dialog allows to define
@ -47,14 +48,12 @@ This dialog allows to define
:align: center
.. centered::
"Implement Edges switched off to the left and on to the right"
Implement Edges switched off to the left and on to the right
* **Definition mode** allows choosing how Cartesian structured grid is defined. Location of nodes along each grid axis is defined individually:
* You can specify the **Coordinates** of grid nodes. **Insert** button inserts a node at **Step** distance (negative or positive) from the selected node. **Delete** button removes the selected node. Double click on a coordinate in the list enables its edition.
.. note::
that node coordinates are measured along directions of axes that can differ from the directions of the Global Coordinate System.
* You can define the **Spacing** of a grid as an algebraic formula **f(t)** where *t* is a position along a grid axis normalized at [0.0,1.0]. **f(t)** must be non-negative at 0. <= *t* <= 1. The whole extent of geometry can be divided into ranges with their own spacing formulas to apply; a t varies between 0.0 and 1.0 within each **Range**. **Insert** button divides a selected range into two. **Delete** button adds the selected sub-range to the previous one. Double click on a range in the list enables edition of its right boundary. Double click on a function in the list enables its edition.
* You can specify the **Coordinates** of grid nodes. **Insert** button inserts a node at **Step** distance (negative or positive) from the selected node. **Delete** button removes the selected node. Double click on a coordinate in the list enables its edition. **Note** that node coordinates are measured along directions of axes that can differ from the directions of the Global Coordinate System.
* You can define the **Spacing** of a grid as an algebraic formula *f(t)* where *t* is a position along a grid axis normalized at [0.0,1.0]. *f(t)* must be non-negative at 0. <= *t* <= 1. The whole extent of geometry can be divided into ranges with their own spacing formulas to apply; a t varies between 0.0 and 1.0 within each **Range**. **Insert** button divides a selected range into two. **Delete** button adds the selected sub-range to the previous one. Double click on a range in the list enables edition of its right boundary. Double click on a function in the list enables its edition.
* **Fixed Point** group allows defining an exact location of a grid node in the direction defined by spacing. The following cases are possible:

18
doc/salome/gui/SMESH/input/changing_orientation_of_elements.rst
View File

@ -4,26 +4,22 @@
Changing orientation of elements
********************************
Orientation of an element is changed by changing the order of its nodes.
Orientation of an element is changed by changing the :doc:`order <connectivity>` of its nodes.
**To change orientation of elements:**
*To change orientation of elements:*
.. |img| image:: ../images/image79.png
#. Select a mesh (and display it in the 3D Viewer if you are going to pick elements by mouse).
#. In the **Modification** menu select the **Orientation** item or click **Orientation** button in the toolbar.
#. In the **Modification** menu select the **Orientation** item or click *Orientation* button |img| in the toolbar.
.. image:: ../images/image79.png
:align: center
.. centered::
**"Orientation" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/orientaation1.png
:align: center
* Select type of elements to reorient: **Face** or **Volume**.
* **The main list** shall contain the elements which will be reoriented. You can click on an element in the 3D viewer and it will be highlighted. After that click the **Add** button and the ID of this element will be added to the list. To remove a selected element or elements from the list click the **Remove** button. The **Sort** button allows to sort the list of elements IDs. The **Set filter** button allows to apply a definite :ref:`filtering_elements` "filter" to the selection of elements.
* **The main list** shall contain the elements which will be reoriented. You can click on an element in the 3D viewer and it will be highlighted. After that click the **Add** button and the ID of this element will be added to the list. To remove a selected element or elements from the list click the **Remove** button. The **Sort** button allows to sort the list of elements IDs. The **Set filter** button allows to apply a definite :ref:`filter <filtering_elements>` to the selection of elements.
* **Apply to all** radio button allows to modify the orientation of all elements of the selected mesh.
* *Select from** set of fields allows to choose a sub-mesh or an existing group whose elements can be added to the list.

42
doc/salome/gui/SMESH/input/clipping.rst
View File

@ -5,31 +5,33 @@ Clipping
********
**Clipping** allows creating cross-section views (clipping planes) of your mesh.
It is available as a sub-item in the context menu of an active mesh.
To create a clipping plane, click on the **New** button in the dialog and choose how it is defined: by **Absolute** or **Relative** coordinates.
**Absolute Coordinates**
It is available as a sub-item in the context menu of an active mesh in 3D Viewer.
To create a clipping plane, click on the **New** button in the dialog and choose how it is defined: by **Absolute** or **Relative** coordinates.
.. image:: ../images/Clipping_Absolute.png
* **Absolute Coordinates**
.. image:: ../images/Clipping_Absolute.png
:align: center
* **Base point** - allows defining the coordinates of the base point for the clipping plane.
* **Reset** - returns the base point to coordinate origin.
* **Direction** - allows defining the orientation of the clipping plane.
* **Invert** - allows selecting, which part of the object will be removed and which will remain after clipping.
* **Base point** - allows defining the coordinates of the base point for the clipping plane.
* **Reset** - returns the base point to the coordinate origin.
* **Direction** - allows defining the orientation of the clipping plane.
* **Invert** - allows selecting, which part of the object will be removed and which will remain after clipping.
**Relative mode**
* **Relative mode**
.. image:: ../images/Clipping_Relative.png
.. image:: ../images/Clipping_Relative.png
:align: center
* **Orientation** ( ||X-Y, ||X-Z or ||Y-Z).
* **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.
* **Rotation** (in angle degrees) **around X** (Y to Z) and **around Y** (X to Z) (depending on the chosen Orientation)
* **Orientation** ( ||X-Y, ||X-Z or ||Y-Z).
* **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.
* **Rotation** (in angle degrees) **around X** (Y to Z) and **around Y** (X to Z) (depending on the chosen Orientation)
.. image:: ../images/before_clipping_preview.png
:align: center
"The preview plane and the cut object"
.. centered::
The preview plane and the cut object
The other parameters are available in both modes :
@ -39,20 +41,20 @@ The other parameters are available in both modes :
* **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**.
It is also possible to interact with the clipping plane directly in 3D view using the mouse.
It is also possible to interact with the clipping plane directly in 3D view using the mouse.
To get a new object from **Clipping**, click **Apply**.
To get an object clipped, click **Apply**.
**Examples:**
.. image:: ../images/dataset_clipping.png
:align: center
"The cross-section using dataset"
.. centered::
The cross-section using dataset
.. image:: ../images/opengl_clipping.png
:align: center
"The OpenGL cross-section"
.. centered::
The OpenGL cross-section

6
doc/salome/gui/SMESH/input/colors_size.rst
View File

@ -13,7 +13,7 @@ The GUI elements in the "Properties" dialog box are grouped according to the ent
* **Nodes**:
* **Color** - color of nodes.
* **Type** and **Scale** - these options allow changing the nodes representation (see :ref:point_marker_page "Point Marker" page for more details).
* **Type** and **Scale** - these options allow changing the nodes representation (see :ref:`point_marker_page` page for more details).
* **Edges / wireframe**:
* **Color** - color of element borders in wireframe mode.
* **Width** - width of lines (edges and borders of elements in wireframe mode).
@ -39,3 +39,7 @@ The GUI elements in the "Properties" dialog box are grouped according to the ent
* **3D vectors** - allows to choose between 2D planar and 3D vectors.
* **Shrink coef.** - relative space of elements compared to gaps between them in shrink mode.
.. toctree::
:hidden:
point_marker.rst

234
doc/salome/gui/SMESH/input/constructing_meshes.rst
View File

@ -8,16 +8,22 @@ To create a mesh on geometry, it is necessary to create a mesh object by choosin
* a geometrical shape produced in the Geometry module (*main shape*);
* *meshing parameters*, including
* :ref:`basic_meshing_algos_page` and
* :ref:`about_hypo_page` specifying constraints to be taken into account by the chosen meshing algorithms.
Then you can launch mesh generation by invoking :ref:`compute_anchor` command.
* :ref:`meshing algorithms <basic_meshing_algos_page>` and
* :ref:`hypotheses <about_hypo_page>` specifying constraints to be taken into account by the chosen meshing algorithms.
Then you can launch mesh generation by invoking :ref:`Compute <compute_anchor>` command.
The generated mesh will be automatically shown in the Viewer. You can
switch off automatic visualization or limit mesh size until which it is
automatically shown in :ref:`mesh_preferences_page` (**Automatic update** entry).
automatically shown in :ref:`mesh_preferences_page` (*Automatic update* entry).
.. note::
Sometimes *hypotheses* term is used to refer to both algorithms and hypotheses.
Read more about meshing parameters:
.. toctree::
:maxdepth: 1
basic_meshing_algos.rst
about_hypo.rst
Mesh generation on the geometry is performed in the bottom-up
flow: nodes on vertices are created first, then edges are divided into
@ -37,21 +43,21 @@ re-computed).
An algorithm of a certain dimension chosen at mesh creation is applied
to discretize every sub-shape of this dimension. It is possible to
specify a different algorithm or hypothesis to be applied to one or
a group of sub-shapes by creating a :ref:`constructing_submeshes_page`.
a group of sub-shapes by creating a :ref:`sub-mesh <constructing_submeshes_page>`.
You can specify no algorithms at all at mesh object
creation and specify the meshing parameters on sub-meshes only; then
only the sub-shapes, for which an algorithm and a hypothesis (if any)
have been defined will be discretized.
.. note:: Construction of a mesh on a geometry includes at least two (:ref:`create_mesh_anchor` and :ref:`compute_anchor`) of the following steps:
Construction of a mesh on a geometry includes at least two (:ref:`mesh creation <create_mesh_anchor>` and :ref:`computing <compute_anchor>`) of the following steps:
* :ref:`create_mesh_anchor`, where you can specify meshing parameters to apply to all sub-shapes of the main shape.
* :ref:`constructing_submeshes_page`, (optional) where you can specify meshing parameters to apply to the selected sub-shapes.
* :ref:`evaluate_anchor` (optional) can be used to know an approximate number of elements before their actual generation.
* :ref:`preview_anchor` (optional) can be used to generate mesh of only lower dimension(s) in order to visually estimate it before full mesh generation, which can be much longer.
* :ref:`submesh_order_anchor` (optional) can be useful if there are concurrent sub-meshes defined.
* :ref:`compute_anchor` uses defined meshing parameters to generate mesh elements.
* :ref:`edit_anchor` (optional) can be used to :ref:`modifying_meshes_page` the mesh of a lower dimension before :ref:`compute_anchor` elements of an upper dimension.
* :ref:`create_mesh_anchor`, where you can specify meshing parameters to apply to all sub-shapes of the main shape.
* :ref:`Creation of sub-meshes <constructing_submeshes_page>`, (optional) where you can specify meshing parameters to apply to the selected sub-shapes.
* :ref:`evaluate_anchor` (optional) can be used to know an approximate number of elements before their actual generation.
* :ref:`preview_anchor` (optional) can be used to generate mesh of only lower dimension(s) in order to visually estimate it before full mesh generation, which can be much longer.
* :ref:`submesh_order_anchor` (optional) can be useful if there are concurrent sub-meshes defined.
* :ref:`compute_anchor` uses defined meshing parameters to generate mesh elements.
* :ref:`edit_anchor` (optional) can be used to :ref:`modify <modifying_meshes_page>` the mesh of a lower dimension before :ref:`computing <compute_anchor>` elements of an upper dimension.
.. _create_mesh_anchor:
@ -59,94 +65,80 @@ have been defined will be discretized.
Creation of a mesh object
#########################
**To construct a mesh:**
To construct a mesh:
.. |img| image:: ../images/image32.png
.. |sel| image:: ../images/image120.png
.. |add| image:: ../images/image121.png
.. |edt| image:: ../images/image122.png
.. |cmp| image:: ../images/image28.png
.. |prv| image:: ../images/mesh_precompute.png
#. Select a geometrical object for meshing.
#. In the **Mesh** menu select **Create Mesh** or click **"Create Mesh"** button in the toolbar.
#. In the **Mesh** menu select **Create Mesh** or click *"Create Mesh"* button |img| in the toolbar.
.. image:: ../images/image32.png
:align: center
.. centered::
**"Create Mesh" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/createmesh-inv.png
:align: center
#. To filter off irrelevant meshing algorithms, you can select **Mesh Type** in the corresponding list from **Any, Hexahedral, Tetrahedral, Triangular** and **Quadrilateral** (there can be less items for the geometry of lower dimensions). Selection of a mesh type hides all meshing algorithms that cannot generate elements of this type.
#. Apply :ref:`basic_meshing_algos_page` and :ref:`about_hypo_page` which will be used to compute this mesh.
#. Apply :ref:`meshing algorithms <basic_meshing_algos_page>` and :ref:`hypotheses <about_hypo_page>` which will be used to compute this mesh.
"Create mesh" dialog box contains several tab pages titled **3D**, **2D**, **1D** and **0D**. The title of each page reflects the dimension of the sub-shapes the algorithms listed on this page affect and the maximal dimension of elements the algorithms generate. For example, **3D** page lists the algorithms that affect 3D sub-shapes (solids) and generate 3D mesh elements (tetrahedra, hexahedra etc.)
"Create mesh" dialog box contains several tab pages titled **3D**, **2D**, **1D** and **0D**. The title of each page reflects the dimension of the sub-shapes the algorithms listed on this page affect and the maximal dimension of elements the algorithms generate. For example, **3D** page lists the algorithms that affect 3D sub-shapes (solids) and generate 3D mesh elements (tetrahedra, hexahedra etc.)
As soon as you have selected an algorithm, you can create a hypothesis (or select an already created one). A set of accessible hypotheses includes only the hypotheses that can be used by the selected algorithm.
As soon as you have selected an algorithm, you can create a hypothesis (or select an already created one). A set of accessible hypotheses includes only the hypotheses that can be used by the selected algorithm.
.. note::
* Some page(s) can be disabled if the geometrical object does not include shapes (sub-shapes) of the corresponding dimension(s). For example, if the input object is a geometrical face, **3D** page is disabled.
* Some algorithms affect the geometry of several dimensions, i.e. 1D+2D or 1D+2D+3D. If such an algorithm is selected, the dialog pages related to the corresponding lower dimensions are disabled.
* **0D** page refers to 0D geometry (vertices) rather than to 0D elements. Mesh module does not provide algorithms that produce 0D elements. Currently **0D** page provides only one algorithm "Segments around vertex" that allows specifying the required size of mesh edges about the selected vertex (or vertices).
.. note::
* Some page(s) can be disabled if the geometrical object does not include shapes (sub-shapes) of the corresponding dimension(s). For example, if the input object is a geometrical face, **3D** page is disabled.
* Some algorithms affect the geometry of several dimensions, i.e. 1D+2D or 1D+2D+3D. If such an algorithm is selected, the dialog pages related to the corresponding lower dimensions are disabled.
* **0D** page refers to 0D geometry (vertices) rather than to 0D elements. Mesh module does not provide algorithms that produce 0D elements. Currently **0D** page provides only one algorithm "Segments around vertex" that allows specifying the required size of mesh edges about the selected vertex (or vertices).
For example, you need to mesh a 3D object.
For example, you need to mesh a 3D object.
First, you can change a default name of your mesh in the **Name** box. Then check that the selected geometrical object indicated in **Geometry** field, is what you wish to mesh; if not, select the correct object in the Object Browser. Click "Select" button near **Geometry** field if the name of the object has not yet appeared in **Geometry** field.
.. image:: ../images/image120.png
:align: center
First, you can change a default name of your mesh in the **Name** box. Then check that the selected geometrical object indicated in **Geometry** field, is what you wish to mesh; if not, select the correct object in the Object Browser. Click "Select" button |sel| near **Geometry** field if the name of the object has not yet appeared in **Geometry** field.
.. centered::
**"Select" button**
Now you can define 3D Algorithm and 3D Hypotheses, which will be applied to discretize the solids of your geometrical object using 3D elements. Click the *"Add Hypothesis"* button |add| to create and add a hypothesis.
Now you can define 3D Algorithm and 3D Hypotheses, which will be applied to discretize the solids of your geometrical object using 3D elements. Click the **"Add Hypothesis"** button to create and add a hypothesis.
.. image:: ../images/image121.png
:align: center
Click the *"Plus"* button to enable adding more additional hypotheses.
.. centered::
**"Add Hypothesis" button**
Click the *"Edit Hypothesis"* button |edt| to change the values for the current hypothesis.
Click the **"Plus"** button to enable adding more additional hypotheses.
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:
Click the **"Edit Hypothesis"** button to change the values for the current hypothesis.
.. image:: ../images/image122.png
:align: center
* *\<Default\>* if the algorithm can work using default parameters.
* *\<None\>* if the algorithm requires a hypothesis defining its parameters.
* If the algorithm does not use hypotheses, this field is grayed.
.. centered::
**"Edit Hypothesis" button**
After selection of an algorithm **Add. Hypothesis** field can contain:
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:
* **\<Default\>** if the algorithm can work using default parameters.
* **\<None\>** if the algorithm requires a hypothesis defining its parameters.
* If the algorithm does not use hypotheses, this field is grayed.
After selection of an algorithm **Add. Hypothesis** field can contain:
* **\<None\>** if the algorithm can be tuned using an additional hypothesis.
* If the algorithm does not use additional hypotheses, this field is grayed.
* *\<None\>* if the algorithm can be tuned using an additional hypothesis.
* 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 will be used to mesh faces and edges of your geometry. (Note that any object has edges, even if their existence is not apparent, for example, a sphere has 4 edges). Note that the choice of hypotheses and lower dimension algorithms depends on the higher dimension algorithm.
Proceed in the same way with 2D and 1D Algorithms and Hypotheses that will be used to mesh faces and edges of your geometry. (Note that any object has edges, even if their existence is not apparent, for example, a sphere has 4 edges). Note that the choice of hypotheses and lower dimension algorithms depends on the higher dimension algorithm.
If you wish you can select other algorithms and/or hypotheses for meshing some sub-shapes of your CAD model by :ref:`constructing_submeshes_page`.
If you wish you can select other algorithms and/or hypotheses for meshing some sub-shapes of your CAD model by :ref:`constructing_submeshes_page`.
Some algorithms generate mesh of several dimensions, while others produce mesh of only one dimension. In the latter case there must be one Algorithm and zero or several Hypotheses for each dimension of your object, otherwise you will not get any mesh at all. Of course, if you wish to mesh a face, which is a 2D object, you do not need to define a 3D Algorithm and Hypotheses.
Some algorithms generate mesh of several dimensions, while others produce mesh of only one dimension. In the latter case there must be one Algorithm and zero or several Hypotheses for each dimension of your object, otherwise you will not get any mesh at all. Of course, if you wish to mesh a face, which is a 2D object, you do not need to define a 3D Algorithm and Hypotheses.
In the **Object Browser** the structure of the new mesh is displayed as follows:
In the **Object Browser** the structure of the new mesh is displayed as follows:
.. image:: ../images/image88.jpg
:align: center
It contains:
It contains:
* a mesh name (**Mesh_mechanic**);
* a reference to the geometrical object on the basis of which the mesh has been constructed (*mechanic*);
* **Applied hypotheses** folder containing the references to the hypotheses chosen at the construction of the mesh;
* **Applied algorithms** folder containing the references to the algorithms chosen at the construction of the mesh.
* **SubMeshes on Face** folder containing the sub-meshes defined on geometrical faces. There also can be folders for sub-meshes on vertices, edges, wires, shells, solids and compounds.
* **Groups of Faces** folder containing the groups of mesh faces. There also can be folders for groups of nodes, edges, volumes 0D elements and balls.
* a mesh name (*Mesh_mechanic*);
* a reference to the geometrical object on the basis of which the mesh has been constructed (*mechanic*);
* **Applied hypotheses** folder containing the references to the hypotheses chosen at the construction of the mesh;
* **Applied algorithms** folder containing the references to the algorithms chosen at the construction of the mesh.
* **SubMeshes on Face** folder containing the sub-meshes defined on geometrical faces. There also can be folders for sub-meshes on vertices, edges, wires, shells, solids and compounds.
* **Groups of Faces** folder containing the groups of mesh faces. There also can be folders for groups of nodes, edges, volumes 0D elements and balls.
There is an alternative way to assign Algorithms and Hypotheses by clicking **Assign a set of hypotheses** button and selecting among pre-defined sets of algorithms and hypotheses. In addition to the built-in 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 in the same way as ${SMESH_ROOT_DIR}/share/salome/resources/smesh/StdMeshers.xml file does (sets of hypotheses are enclosed between \<hypotheses-set-group\> tags). For example:
There is an alternative way to assign Algorithms and Hypotheses by clicking **Assign a set of hypotheses** button and selecting among pre-defined sets of algorithms and hypotheses. In addition to the built-in 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 in the same way as ${SMESH_ROOT_DIR}/share/salome/resources/smesh/StdMeshers.xml file does (sets of hypotheses are enclosed between \<hypotheses-set-group\> tags). For example:
::
<?xml version='1.0' encoding='us-ascii'?>
@ -159,26 +151,27 @@ Creation of a mesh object
</hypotheses-set-group>
</meshers>
If the file contents are incorrect, there can be an error at activation of Mesh module: **"fatal parsing error: error triggered by consumer in line ..."**
If the file contents are incorrect, there can be an error at activation of Mesh module: *"fatal parsing error: error triggered by consumer in line ..."*
.. image:: ../images/hypo_sets.png
:align: center
List of sets of hypotheses. Tag **[custom]** is automatically added to the sets defined by the user.
.. centered::
List of sets of hypotheses. Tag *[custom]* is automatically added to the sets defined by the user.
.. note::
* *"Automatic"* in the names of predefined sets of hypotheses does not actually mean that they are suitable for meshing any geometry.
* The list of sets of hypotheses can be shorter than in the above image depending on the geometry dimension.
.. note::
* *"Automatic"* in the names of predefined sets of hypotheses does not actually mean that they are suitable for meshing any geometry.
* The list of sets of hypotheses can be shorter than in the above image depending on the geometry dimension.
Consider trying a sample script for construction of a mesh from our :ref:`tui_creating_meshes_page` section.
Consider trying a sample script for construction of a mesh from our :ref:`TUI Scripts <tui_creating_meshes_page>` section.
.. _evaluate_anchor:
Evaluating mesh size
####################
After the mesh object is created and all hypotheses are assigned and before :ref:`compute_anchor` operation, it is possible to calculate the eventual mesh size. For this, select the mesh in the **Object Browser** and from the **Mesh** menu select **Evaluate**.
After the mesh object is created and all hypotheses are assigned and before :ref:`Compute <compute_anchor>` operation, it is possible to calculate the eventual mesh size. For this, select the mesh in the **Object Browser** and from the **Mesh** menu select **Evaluate**.
The result of evaluation will be displayed in the following information box:
.. image:: ../images/mesh_evaluation_succeed.png
@ -189,15 +182,9 @@ The result of evaluation will be displayed in the following information box:
Previewing the mesh
###################
Before :ref:`compute_anchor` , it is also possible to see the mesh preview. This operation allows to incrementally compute the mesh, dimension by dimension, and to discard an unsatisfactory mesh.
Before :ref:`the mesh computation <compute_anchor>`, it is also possible to see the mesh preview. This operation allows to incrementally compute the mesh, dimension by dimension, and to discard an unsatisfactory mesh.
For this, select the mesh in the Object Browser. From the **Mesh** menu select **Preview** or click "Preview" button in the toolbar or activate "Preview" item from the pop-up menu.
.. image:: ../images/mesh_precompute.png
:align: center
.. centered::
**"Preview" button**
For this, select the mesh in the Object Browser. From the **Mesh** menu select **Preview** or click "Preview" button |prv| in the toolbar or activate "Preview" item from the pop-up menu.
Select **1D mesh** or **2D mesh** preview mode in the Preview dialog.
@ -205,14 +192,14 @@ Select **1D mesh** or **2D mesh** preview mode in the Preview dialog.
:align: center
.. centered::
"1D mesh preview shows nodes computed on geometry edges"
1D mesh preview shows nodes computed on geometry edges
.. image:: ../images/preview_mesh_2D.png
:align: center
.. centered::
"2D mesh preview shows edge mesh elements, computed on geometry faces"
2D mesh preview shows edge mesh elements, computed on geometry faces
**Compute** button computes the whole mesh.
@ -230,33 +217,33 @@ These elements can be kept in the mesh.
Changing sub-mesh priority
##########################
If the mesh contains concurrent :ref:`constructing_submeshes_page`, it is possible to change the priority of their computation, i.e. to change the priority of applying algorithms to the shared sub-shapes of the Mesh shape.
If the mesh contains concurrent :ref:`sub-meshes <constructing_submeshes_page>`, it is possible to change the priority of their computation, i.e. to change the priority of applying algorithms to the shared sub-shapes of the Mesh shape.
**To change sub-mesh priority:**
*To change sub-mesh priority:*
Choose "Change sub-mesh priority" from the Mesh menu or a pop-up menu. The opened dialog shows a list of sub-meshes in the order of their priority.
Choose **Change sub-mesh priority** from the **Mesh** menu or a pop-up menu. The opened dialog shows a list of sub-meshes in the order of their priority.
There is an example of sub-mesh order modifications taking a Mesh created on a Box shape. The main Mesh object:
* *1D* **Wire discretisation** with **Number of Segments** =20
* *1D* **Wire discretisation** with **Number of Segments** = 20
* *2D* **Triangle: Mefisto** with Hypothesis **Max Element Area**
The first sub-mesh **Submesh_1** created on **Face_1** is:
* *1D* **Wire discretisation** with **Number of Segments** =4
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** =1200
* *1D* **Wire discretisation** with **Number of Segments** = 4
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
The second sub-mesh **Submesh_2** created on **Face_2** is:
* *1D* **Wire discretisation** with **Number of Segments** =8
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** =1200
* *1D* **Wire discretisation** with **Number of Segments** = 8
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
And the last sub-mesh **Submesh_3** created on **Face_3** is:
* *1D* **Wire discretisation** with **Number of Segments** =12
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** =1200
* *1D* **Wire discretisation** with **Number of Segments** = 12
* *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
The sub-meshes become concurrent if they share sub-shapes that can be meshed with different algorithms (or different hypotheses). In the example, we have three sub-meshes with concurrent algorithms, because they have different hypotheses.
@ -267,14 +254,14 @@ The first mesh computation is made with:
:align: center
.. centered::
**"Mesh order SubMesh_1, SubMesh_2, SubMesh_3"**
Mesh order SubMesh_1, SubMesh_2, SubMesh_3
.. image:: ../images/mesh_order_123_res.png
:align: center
.. centered::
**"Result mesh with order SubMesh_1, SubMesh_2, SubMesh_3 "**
Result mesh with order SubMesh_1, SubMesh_2, SubMesh_3
The next mesh computation is made with:
@ -282,13 +269,13 @@ The next mesh computation is made with:
:align: center
.. centered::
**"Mesh order SubMesh_2, SubMesh_1, SubMesh_3"**
Mesh order SubMesh_2, SubMesh_1, SubMesh_3
.. image:: ../images/mesh_order_213_res.png
:align: center
.. centered::
**"Result mesh with order SubMesh_2, SubMesh_1, SubMesh_3 "**
Result mesh with order SubMesh_2, SubMesh_1, SubMesh_3
And the last mesh computation is made with:
@ -296,14 +283,14 @@ And the last mesh computation is made with:
:align: center
.. centered::
**"Mesh order SubMesh_3, SubMesh_2, SubMesh_1"**
Mesh order SubMesh_3, SubMesh_2, SubMesh_1
.. image:: ../images/mesh_order_321_res.png
:align: center
.. centered::
**"Result mesh with order SubMesh_3, SubMesh_2, SubMesh_1 "**
Result mesh with order SubMesh_3, SubMesh_2, SubMesh_1
As we can see, each mesh computation has a different number of result
elements and a different mesh discretization on the shared edges (the edges
@ -318,7 +305,7 @@ modifying the order of sub-meshes.
:align: center
.. centered::
**"Preview with sub-mesh priority list box"**
Preview with sub-mesh priority list box
If there are no concurrent sub-meshes under the Mesh object, the user
will see the following information.
@ -327,7 +314,7 @@ will see the following information.
:align: center
.. centered::
**"No concurrent submeshes detected"**
No concurrent submeshes detected
.. _compute_anchor:
@ -335,17 +322,11 @@ will see the following information.
Computing the mesh
##################
It is equally possible to skip :ref:`evaluate_anchor`
and :ref:`preview_anchor` and to **Compute** the mesh after
It is equally possible to skip :ref:`Evaluation <evaluate_anchor>`
and :ref:`Preview <preview_anchor>` and to **Compute** the mesh after
the hypotheses are assigned. For this, select your mesh in
the **Object Browser**. From the **Mesh** menu or the context menu
select **Compute** or click *"Compute"* button of the toolbar.
.. image:: ../images/image28.png
:align: center
.. centered::
**"Compute" button**
the Object Browser. From the **Mesh** menu or the context menu
select **Compute** or click *"Compute"* button |cmp| of the toolbar.
After the mesh computation finishes, the Mesh Computation information
box appears. If you close this box and click "Compute" button again,
@ -356,9 +337,6 @@ with the same contents. (To fully re-compute the mesh, invoke
.. _meshing_result_anchor:
Meshing Results
===============
If the mesh computation has been a success, the box shows information on the number of entities of different types in the mesh.
.. image:: ../images/meshcomputationsucceed.png
@ -366,9 +344,6 @@ If the mesh computation has been a success, the box shows information on the num
.. _meshing_failed_anchor:
Meshing Failed
==============
If the mesh computation has failed, the information about the cause of the failure is provided in **Errors** table.
.. image:: ../images/meshcomputationfail.png
@ -405,31 +380,26 @@ the visualization of faces and volumes (if any).
Edges bounding a hole in the surface are shown in magenta using **Show bad Mesh** button
.. note::
Mesh Computation Information box does not appear if you set :ref:`show_comp_result_pref` preference to the "Never" value. This option gives the possibility to control mesh computation reporting. There are the following possibilities: always show the information box, show only if an error occurs or never. By default, the information box is always shown after mesh computation operation.
Mesh Computation Information box does not appear if you set :ref:`Mesh computation/Show a computation result notification <show_comp_result_pref>` preference to the "Never" value. This option gives the possibility to control mesh computation reporting. There are the following possibilities: always show the information box, show only if an error occurs or never. By default, the information box is always shown after mesh computation operation.
.. _edit_anchor:
Editing the mesh
################
It is possible to :ref:`modifying_meshes_page` of a
It is possible to :ref:`edit the mesh <modifying_meshes_page>` of a
lower dimension before generation of the mesh of a higher dimension.
For example you can generate a 2D mesh, modify it using e.g. :ref:`pattern_mapping_page`, and then generate a 3D mesh basing on the modified 2D mesh. The workflow is as follows:
For example you can generate a 2D mesh, modify it using e.g. :ref:`Pattern mapping <pattern_mapping_page>`, and then generate a 3D mesh basing on the modified 2D mesh. The workflow is as follows:
* Define 1D and 2D meshing algorithms.
* Compute the mesh. 2D mesh is generated.
* Apply :ref:`pattern_mapping_page`.
* Apply :ref:`Pattern mapping <pattern_mapping_page>`.
* Define 3D meshing algorithms without modifying 1D and 2D algorithms and hypotheses.
* Compute the mesh. 3D mesh is generated.
* Compute the mesh. 3D mesh is generated basing on a modified 2D mesh.
.. note::
Nodes and elements added :ref:`adding_nodes_and_elements_page` cannot be used in this workflow because the manually created entities are not attached to any geometry and thus (usually) cannot be found by the mesher paving a geometry.
Nodes and elements added :ref:`manually <adding_nodes_and_elements_page>` cannot be used in this workflow because the manually created entities are not attached to any geometry and thus (usually) cannot be found by the mesher paving a geometry.
**See Also** a sample TUI Script demonstrates the possibility of :ref:`tui_editing_while_meshing`.
.. toctree::
:maxdepth: 2
basic_meshing_algos.rst
about_hypo.rst

66
doc/salome/gui/SMESH/input/constructing_submeshes.rst
View File

@ -6,6 +6,9 @@ Constructing sub-meshes
.. contents:: `Table of contents`
What the sub-mesh is for
########################
By purpose, the sub-mesh is an object used to assign to a sub-shape
different meshing parameters than those assigned to the main shape.
@ -30,10 +33,10 @@ How to get a sub-shape for sub-mesh construction
A sub-shape to create a sub-mesh on should be retrieved from the main shape
in one of the following ways:
* In Geometry module, via **New Entity > Explode** menu.
* In Geometry module, by creation of a group (**New Entity > Group > Create Group** menu).
* In Mesh module, by :ref:`subshape_by_mesh_elem` generated on a sub-shape of interest. This way is accessible if the mesh is already computed.
* In Mesh module, by clicking **Publish Sub-shape** button in a dialog showing :ref:`meshing_failed_anchor`.
* In Geometry module, via **New Entity > Explode** menu.
* In Geometry module, by creation of a group (**New Entity > Group > Create Group** menu).
* In Mesh module, by :ref:`selecting a mesh element <subshape_by_mesh_elem>` generated on a sub-shape of interest. This way is accessible if the mesh is already computed.
* In Mesh module, by clicking **Publish Sub-shape** button in a dialog showing :ref:`meshing errors <meshing_failed_anchor>`.
.. :submesh_priority:
@ -47,15 +50,15 @@ compound of solids, starts from searching an algorithm, 1D as for the
edge. The following sub-shapes are sequentially checked for presence
of a sub-mesh where 1D algorithm is assigned:
* the **edge** itself
* **groups of edges** containing the edge, if any
* **wires** sharing the edge
* **faces** sharing the edge
* **groups of faces** sharing the edge, if any
* **shells** sharing the edge
* **solids** sharing the edge
* **groups of solids** sharing the edge, if any
* the **main shape**
* the **edge** itself
* **groups of edges** containing the edge, if any
* **wires** sharing the edge
* **faces** sharing the edge
* **groups of faces** sharing the edge, if any
* **shells** sharing the edge
* **solids** sharing the edge
* **groups of solids** sharing the edge, if any
* the **main shape**
(This sequence of sub-shapes defines the priority of sub-meshes. Thus more
local, i.e. assigned to sub-shape of lower dimension, algorithms and
@ -73,7 +76,7 @@ same priority.
If meshing parameters are defined on sub-meshes of the same priority,
for example, different 1D hypotheses are assigned to two faces sharing
an edge, the hypothesis assigned to a sub-shape with a lower ID will
be used for meshing. You can :ref:`submesh_order_anchor` mutual
be used for meshing. You can :ref:`change <submesh_order_anchor>` mutual
priority of such concurrent sub-meshes.
.. _submesh_definition:
@ -81,35 +84,31 @@ priority of such concurrent sub-meshes.
How to construct a sub-mesh
###########################
.. note:: Construction of a sub-mesh consists of:
* Selecting a mesh which will encapsulate the sub-mesh
* Selecting a sub-shape for meshing
* Applying one or several :ref:`about_hypo_page` and :ref:`basic_meshing_algos_page` which will be used for discretization of this sub-shape.
Construction of a sub-mesh consists of:
* Selecting a mesh which will encapsulate the sub-mesh.
* Selecting a sub-shape for meshing.
* Selecting a :ref:`meshing algorithm <basic_meshing_algos_page>` which will be used for discretization of this sub-shape.
* Creating or selecting one or several :ref:`hypotheses <about_hypo_page>`.
**To construct a sub-mesh:**
From the **Mesh** menu select **Create Sub-mesh** or click **"Create Sum-mesh"** button in the toolbar.
*To construct a sub-mesh:*
.. image:: ../images/image33.gif
:align: center
.. |img| image:: ../images/image33.gif
.. centered::
**"Create Sub-mesh" button**
From the **Mesh** menu select **Create Sub-mesh** or click *"Create Sum-mesh"* button |img| in the toolbar.
The following dialog box will appear:
.. image:: ../images/createmesh-inv2.png
:align: center
It allows to define the **Name**, the parent **Mesh** and the **Geometry** (e.g. a face if the parent mesh has been built on box) of the sub-mesh. You can define meshing algorithms and hypotheses in the same way as in :ref:`constructing_meshes_page` dialog.
It allows to define the **Name**, the parent **Mesh** and the **Geometry** (e.g. a face if the parent mesh has been built on box) of the sub-mesh. You can define meshing algorithms and hypotheses in the same way as in :ref:`Create mesh <constructing_meshes_page>` dialog.
Later you can change the applied hypotheses or their parameters in :ref:`editing_meshes_page` dialog. Mesh entities generated using changed hypotheses are automatically removed.
Later you can change the applied hypotheses or their parameters in :ref:`Edit mesh/sub-mesh <editing_meshes_page>` dialog. Mesh entities generated using changed hypotheses are automatically removed.
.. _subshape_by_mesh_elem:
Subshape by mesh element
========================
If the parent mesh is already computed, then you can define the **Geometry** by picking mesh elements computed on a sub-shape of interest in the 3D Viewer, i.e. you do not have to extract this sub-shape in Geometry module beforehand. To start element selection, press *Selection* button to the right of **Geometry** label. If this button is already down, then click it to release and then click it again. The following pop-up menu allowing to choose a way of geometry definition will appear.
.. image:: ../images/choose_geom_selection_way.png
@ -135,10 +134,11 @@ In the Object Browser the structure of the new sub-mesh will be displayed as fol
:align: center
It contains:
* a sub-mesh name (*SubMeshFace1*)
* a reference to the geometrical object on the basis of which the sub-mesh has been constructed (**Cylindrical Face_1**);
* **Applied hypotheses** folder containing references to hypotheses assigned to the sub-mesh;
* **Applied algorithms** folder containing references to algorithms assigned to the sub-mesh.
* a sub-mesh name (*SubMeshFace1*)
* a reference to the geometrical object on the basis of which the sub-mesh has been constructed (*Cylindrical Face_1*);
* *Applied hypotheses* folder containing references to hypotheses assigned to the sub-mesh;
* *Applied algorithms* folder containing references to algorithms assigned to the sub-mesh.
**See Also** a sample TUI Script of a :ref:`tui_construction_submesh` operation.

20
doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.rst
View File

@ -11,26 +11,22 @@ This functionality allows transforming linear meshes (or sub-meshes) to quadrati
See :ref:`adding_quadratic_elements_page` for more information about quadratic meshes.
**To produce a conversion:**
*To produce a conversion:*
.. |img| image:: ../images/image154.png
#. Select a mesh or a sub-mesh in the Object Browser or in the Viewer.
#. From the Modification menu or from the contextual menu in the Object Browser choose **Convert to/from Quadratic Mesh** item, or click **"Convert to/from quadratic"** button in the toolbar.
#. From the Modification menu or from the contextual menu in the Object Browser choose **Convert to/from Quadratic Mesh** item, or click *"Convert to/from quadratic"* button |img| in the toolbar.
.. image:: ../images/image154.png
:align: center
.. centered::
**"Convert to/from quadratic" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/convert.png
:align: center
#. In this dialog box specify:
* If it is necessary to convert a linear mesh to quadratic or a quadratic mesh to linear. **Convert to bi-quadratic** creates some types of quadratic elements with additional central nodes: TRIA7, QUAD9 and HEXA27 elements instead of TRIA6, QUAD8, and HEXA20 elements respectively.
* If it is necessary to place **medium nodes** of the quadratic mesh **on the geometry** (meshed shape). This option is relevant for conversion to quadratic provided that the mesh is based on a geometry (not imported from file).
* If it is necessary to convert a linear mesh to quadratic or a quadratic mesh to linear. **Convert to bi-quadratic** creates some types of quadratic elements with additional central nodes: TRIA7, QUAD9 and HEXA27 elements instead of TRIA6, QUAD8, and HEXA20 elements respectively.
* If it is necessary to place **medium nodes** of the quadratic mesh **on the geometry** (meshed shape). This option is relevant for conversion to quadratic provided that the mesh is based on a geometry (not imported from file).
.. image:: ../images/image156.gif
:align: center
@ -46,7 +42,7 @@ See :ref:`adding_quadratic_elements_page` for more information about quadratic m
Quadratic mesh
* Click the **Apply** or **Apply and Close** button.
#. Click the **Apply** or **Apply and Close** button.
**See Also** a sample TUI Script of a :ref:`tui_quadratic` operation.

30
doc/salome/gui/SMESH/input/copy_mesh.rst
View File

@ -6,15 +6,11 @@ Copy Mesh
A mesh can be created by copying a part of or the whole other mesh.
**To make a copy of a mesh:**
*To make a copy of a mesh:*
From the contextual menu in the Object Browser of from the **Mesh** menu select **Copy Mesh** or click **"Copy Mesh"** button in the toolbar.
.. |img| image:: ../images/copy_mesh_icon.png
.. image:: ../images/copy_mesh_icon.png
:align: center
.. centered::
**"Copy Mesh" button**
From the contextual menu in the Object Browser of from the **Mesh** menu select **Copy Mesh** or click *"Copy Mesh"* button |img| in the toolbar.
The following dialog box will appear:
@ -24,20 +20,20 @@ The following dialog box will appear:
In the dialog:
* specify the part of mesh to copy:
* specify the part of mesh to copy:
* **Select whole mesh, sub-mesh or group** by mouse 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 **Source Element IDs** directly in this 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.
* **Select whole mesh, sub-mesh or group** by mouse 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 **Source Element IDs** directly in this 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` page.
* specify the **New Mesh Name**;
* specify the conditions of copying:
* specify the **New Mesh Name**;
* specify the conditions of copying:
* activate **Generate groups** checkbox to copy the groups of the source mesh to the newly created mesh.
* activate **Generate groups** checkbox to copy the groups of the source mesh to the newly created mesh.
* Click **Apply** or **Apply and Close** button to confirm the operation.
* Click **Apply** or **Apply and Close** button to confirm the operation.
**See Also** a sample :ref:`tui_copy_mesh`.
**See Also** a sample script of :ref:`tui_copy_mesh`.

4
doc/salome/gui/SMESH/input/create_groups_from_geometry.rst
View File

@ -9,7 +9,7 @@ This operation allows creating groups on geometry on all selected shapes. Only t
The type of each new group is defined automatically by the nature of the **Geometry**.
The group names will be the same as the names of geometrical objects.
.. warning:: It's impossible to create a group of **0D elements** or **ball elements** with this operation. For this, it is necessary to use :ref:`creating_groups_page` operation.
.. warning:: It's impossible to create a group of *0D elements* or *ball elements* with this operation. For this, it is necessary to use :ref:`Create group <creating_groups_page>` operation.
To use this operation, select in the **Mesh** menu or in the contextual menu in the Object browser **Create Groups from Geometry** item.
@ -19,4 +19,4 @@ To use this operation, select in the **Mesh** menu or in the contextual menu in
In this dialog **Elements** group contains a list of shapes, on which groups of elements will be created; **Nodes** group contains a list of shapes, on which groups of nodes will be created.
**See Also** a sample TUI Script of a :ref:`tui_create_group_on_geometry` operation.

23
doc/salome/gui/SMESH/input/creating_groups.rst
View File

@ -4,7 +4,7 @@
Creating groups
***************
In MESH you can create a :ref:`grouping_elements_page` of elements of a certain type. The main way to create a group, is to
In MESH you can create a group of elements of a certain type. The main way to create a group, is to
select in the **Mesh** menu **Create Group** item (also available in the context menu of the mesh).
To create a group you should define the following:
@ -32,7 +32,7 @@ Mesh module distinguishes between the three Group types:
the following ways:
* By adding all entities of the chosen type existing in the mesh. For this, turn on the **Select All** check-box. In this mode all controls, which allow selecting the entities, are disabled.
* By choosing entities manually with the mouse in the 3D Viewer. For this, turn on the **Enable manual edition** check box. You can click on an element in the 3D viewer and it will be highlighted. After that click the **Add** button and the ID of this element will be added to the list. The **Set filter** button allows to define the filter for selection of the elements for your group. See more about filters on the :ref:`selection_filter_library_page` "Selection filter library" page.
* By choosing entities manually with the mouse in the 3D Viewer. For this, turn on the **Enable manual edition** check box. You can click on an element in the 3D viewer and it will be highlighted. After that click the **Add** button and the ID of this element will be added to the list. The **Set filter** button allows to define the filter for selection of the elements for your group. See more about filters on the :ref:`selection_filter_library_page` page.
* By adding entities from either a sub-mesh or another group. For this, turn on the **Enable manual edition** check box. **Select from** fields group allows to select a sub-mesh or a group of the appropriate type and to **Add** their elements to the group.
In the **manual edition** mode you can
@ -54,13 +54,13 @@ For example, to create a new group containing all faces of an existing group and
* Click **Apply** button to create the new group.
Please note that the new group does not have references to the source group. It contains only the list of face IDs. So if the source group is changed, the new one is not updated accordingly.
.. note:: The new group does not have references to the source group. It contains only the list of face IDs. So if the source group is changed, the new one is not updated accordingly.
.. image:: ../images/image130.gif
:align: center
.. centered::
In this picture the brown cells belong to a group defined manually.
Brown cells belong to a group defined manually
**See Also** a sample TUI Script of a :ref:`tui_create_standalone_group` operation.
@ -70,15 +70,17 @@ Please note that the new group does not have references to the source group. It
"Group on Geometry"
###################
.. |sel| image:: ../images/image120.png
To create a group on geometry check **Group on geometry** in the **Group** **type** field. The group on geometry contains the elements of a certain type generated on the selected geometrical object. Group contents are dynamically updated if the mesh is modified. The group on geometry can be created only if the mesh is based on geometry.
To define a group, click the *Selection* button and choose
To define a group, click the *Selection* button |sel| and choose
* **Direct geometry selection** to select a shape in the Object Browser or in the Viewer;
* **Find geometry by mesh element selection** to activate a dialog which retrieves a shape by the selected element generated on this shape.
* *Direct geometry selection* to select a shape in the Object Browser or in the Viewer;
* *Find geometry by mesh element selection* to activate a dialog which retrieves a shape by the selected element generated on this shape.
.. note::
that this choice is available only if the mesh elements are already generated.
This choice is available only if the mesh elements are already generated.
.. image:: ../images/a-creategroup.png
:align: center
@ -88,7 +90,8 @@ After confirmation of the operation a new group of mesh elements will be created
.. image:: ../images/image132.gif
:align: center
In this picture the cells which belong to a certain geometrical face are selected in green.
.. centered::
Cells belonging to a certain geometrical face are selected in green
**See Also** a sample TUI Script of a :ref:`tui_create_group_on_geometry` operation.
@ -108,5 +111,3 @@ To define a group, click the **Set filter** button and define criteria of the fi
:align: center
**See Also** a sample TUI Script of a :ref:`tui_create_group_on_filter` operation.

21
doc/salome/gui/SMESH/input/cut_mesh_by_plane.rst
View File

@ -21,17 +21,16 @@ Syntax::
MeshCut input.med output.med resuMeshName aboveGroup belowGroup nx ny nz px py pz T
where::
where:
input.med = name of the original mesh file in med format
output.med = name of the result mesh file in med format
resuMeshName = name of the result mesh
aboveGroup = name of the group of volumes above the cut plane
belowGroups = name of the group of volumes below the cut plane
nx ny nz = vector normal to the cut plane
px py pz = a point of the cut plane
T = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to the cut plane if their distance from the plane is inferior to L*T,
where L is the mean edge size of the tetrahedron
* **input.med** = name of the original mesh file in med format
* **output.med** = name of the result mesh file in med format
* **resuMeshName** = name of the result mesh
* **aboveGroup** = name of the group of volumes above the cut plane
* **belowGroups** = name of the group of volumes below the cut plane
* **nx ny nz** = vector normal to the cut plane
* **px py pz** = a point of the cut plane
* **T** = 0 < T < 1 : vertices of a tetrahedron are considered as belonging to the cut plane if their distance from the plane is inferior to L*T, where L is the mean edge size of the tetrahedron
.. _meshcut_plugin:
@ -53,7 +52,7 @@ The following dialog box will appear:
:align: center
.. centered::
"MeshCut Plugin dialog box"
MeshCut Plugin dialog box
See above for the meaning of the parameters.

42
doc/salome/gui/SMESH/input/cutting_quadrangles.rst
View File

@ -6,47 +6,43 @@ Cutting quadrangles
This operation allows cutting one or several quadrangle elements into two or four triangles.
**To cut quadrangles:**
*To cut quadrangles:*
1. Select a mesh (and display it in the 3D Viewer if you are going to pick elements by mouse).
2. In the **Modification** menu select the **Cutting of quadrangles** item or click **"Cutting of quadrangles"** button in the toolbar.
.. |img| image:: ../images/image82.png
.. image:: ../images/image82.png
:align: center
#. Select a mesh (and display it in the 3D Viewer if you are going to pick elements by mouse).
#. In the **Modification** menu select the **Cutting of quadrangles** item or click *"Cutting of quadrangles"* button |img| in the toolbar.
.. centered::
**"Cutting of quadrangles" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/a-cuttingofquadrangles.png
:align: center
.. image:: ../images/a-cuttingofquadrangles.png
:align: center
* 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):
* 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 **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 **Remove** button.
* **Sort list** button allows sorting the list of IDs.
* **Filter** button allows applying a definite :ref:`filtering_elements` "filter" to the selection of quadrangles.
* **Apply to all** check box allows cutting all quadrangles of the selected mesh.
* **Preview** provides a preview of cutting in the viewer. It is disabled for **Cut into 4 triangles** as this cutting way implies no ambiguity.
* **Criterion** defines the way of cutting:
* **Filter** button allows applying a definite :ref:`filter <filtering_elements>` to the selection of quadrangles.
* **Apply to all** check box allows cutting all quadrangles of the selected mesh.
* **Preview** provides a preview of cutting in the viewer. It is disabled for **Cut into 4 triangles** as this cutting way implies no ambiguity.
* **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 then can be added to the main list.
* **Aspect Ratio** cuts by the diagonal splitting the quadrangle into triangles with :ref:`Aspect Ratio <aspect_ratio_page>` closer to 1
* **Minimum Angle** cuts by the diagonal splitting the quadrangle into triangles with :ref:`Minimum Angle <minimum_angle_page>` closer to 60 degrees.
* **Skew** cuts by the diagonal splitting the quadrangle into triangles with :ref:`Skew <skew_page>` closer to 0.0 degrees.
* **Select from** allows choosing a sub-mesh or an existing group, whose quadrangle elements then can be added to the main list.
3. Click the **Apply** or **Apply and Close** button to confirm the operation.
#. Click the **Apply** or **Apply and Close** button to confirm the operation.
.. image:: ../images/image52.jpg
:align: center
.. centered::
"The chosen quadrangular element"
The chosen quadrangular element
|
@ -54,7 +50,7 @@ The following dialog box will appear:
:align: center
.. centered::
"Two resulting triangular elements"
Two resulting triangular elements
**See Also** a sample TUI Script of a :ref:`tui_cutting_quadrangles` operation.

14
doc/salome/gui/SMESH/input/define_mesh_by_script.rst
View File

@ -4,25 +4,23 @@
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.
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
#. create a mesh object, assign a 1D algorithm,
#. invoke **Compute** command, which computes a 1D mesh,
#. assign **Use Faces to be Created Manually** and a 3D algorithm,
#. run your python code, which creates a 2D mesh,
#. invoke **Compute** command, which computes a 3D mesh.
.. 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.
.. 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` algorithm for construction of a 2D mesh using Python commands.
Consider trying a sample script demonstrating the usage of :ref:`Use Faces to be Created Manually <tui_use_existing_faces>` algorithm for construction of a 2D mesh using Python commands.
.. image:: ../images/use_existing_face_sample_mesh.png
:align: center
**Mesh computed by** :ref:`tui_use_existing_faces` shown in a Shrink mode.
.. figure:: ../images/use_existing_face_sample_mesh.png
:align: center
**See also** :ref:`the sample script <tui_use_existing_faces>` creating the mesh shown in the image in a Shrink mode.

3
doc/salome/gui/SMESH/input/deleting_groups.rst
View File

@ -12,7 +12,6 @@ Then click **Apply and Close** button to remove the selected groups and close th
.. image:: ../images/deletegroups.png
:align: center
.. note::
Please, note that this operation removes groups **with their elements**. To delete a group and leave its elements intact, right-click on the group in the Object Browser and select **Delete** in the pop-up menu or select the group and choose **Edit -> Delete** in the main menu.
.. note:: This operation removes groups **with their elements**. To delete a group and leave its elements intact, right-click on the group in the Object Browser and select **Delete** in the pop-up menu or select the group and choose **Edit -> Delete** in the main menu.

14
doc/salome/gui/SMESH/input/diagonal_inversion_of_elements.rst
View File

@ -7,15 +7,11 @@ Diagonal inversion of two triangles
In MESH you can inverse the diagonal (edge) of a pseudo-quadrangle
formed by two neighboring triangles with one common edge.
**To inverse the diagonal:**
*To inverse the diagonal:*
#. From the **Modification** menu choose the **Diagonal inversion** item or click **"Diagonal Inversion"** button in the toolbar.
#. From the **Modification** menu choose the **Diagonal inversion** item or click *"Diagonal Inversion"* |img| button in the toolbar.
.. image:: ../images/image70.png
:align: center
.. centered::
**"Diagonal Inversion" button**
.. |img| image:: ../images/image70.png
The following dialog box shall appear:
@ -29,13 +25,13 @@ The following dialog box shall appear:
:align: center
.. centered::
"The selected edge"
The selected edge
.. image:: ../images/image36.jpg
:align: center
.. centered::
"The inverted edge"
The inverted edge
**See Also** a sample TUI Script of a :ref:`tui_diagonal_inversion` operation.

4
doc/salome/gui/SMESH/input/double_elements_control.rst
View File

@ -11,6 +11,4 @@ These mesh quality controls highlight the mesh elements basing on the same set o
In this picture some faces are coincident after copying all elements with translation with subsequent Merge of nodes.
*A sample TUI Script of a* :ref:`filter_double_elements`:.
**See also** a sample TUI Script of a :ref:`filter_double_elements` filters.

7
doc/salome/gui/SMESH/input/double_nodes_control.rst
View File

@ -4,13 +4,12 @@
Double nodes
************
This mesh quality control highlights the nodes which are coincident with other nodes (within a given tolerance). Distance at which two nodes are considered coincident is defined by :ref:`dbl_nodes_tol_pref` preference.
This mesh quality control highlights the nodes which are coincident with other nodes (within a given tolerance). Distance at which two nodes are considered coincident is defined by :ref:`Quality Controls/Double nodes tolerance <dbl_nodes_tol_pref>` preference.
.. image:: ../images/double_nodes.png
:align: center
In this picture some nodes are coincident after copying all elements with translation.
.. centered::
Some nodes are coincident after copying all elements with translation.
**See also**: A sample TUI Script of a :ref:`tui_double_nodes_control` filter.

38
doc/salome/gui/SMESH/input/double_nodes_page.rst
View File

@ -8,16 +8,11 @@ This operation allows duplicating mesh nodes or/and elements, which can be usefu
Duplication consists in creation of mesh elements "equal" to existing ones.
**To duplicate nodes or/and elements:**
*To duplicate nodes or/and elements:*
#. From the **Modification** menu choose **Transformation** -> **Duplicate Nodes or/and Elements** item or click **"Duplicate Nodes or/and Elements"** button in the toolbar.
.. image:: ../images/duplicate_nodes.png
:align: center
.. centered::
"Duplicate Nodes or/and Elements button"
.. |img| image:: ../images/duplicate_nodes.png
#. From the **Modification** menu choose **Transformation** -> **Duplicate Nodes or/and Elements** item or click *"Duplicate Nodes or/and Elements"* button |img| in the toolbar.
#. Check in the dialog box one of four radio buttons corresponding to the type of duplication operation you would like to perform.
#. Fill the other fields available in the dialog box (depending on the chosen operation mode).
#. Click the **Apply** or **Apply and Close** button to perform the operation of duplication.
@ -42,9 +37,9 @@ Duplicate nodes only
Parameters to be defined in this mode:
* **Group of nodes to duplicate** (**mandatory**): these nodes will be duplicated.
* **Group of elements to replace nodes with new ones** (**optional**): the new nodes will replace the duplicated nodes within these elements.
* **Construct group with newly created nodes** option (**checked by default**): if checked - the group with newly created nodes will be built.
* **Group of nodes to duplicate** (*mandatory*): these nodes will be duplicated.
* **Group of elements to replace nodes with new ones** (*optional*): the new nodes will replace the duplicated nodes within these elements. **Generate** button tries to automatically find such elements and creates a group of them. This button becomes active as soon as **Group of nodes to duplicate** is selected.
* **Construct group with newly created nodes** option (*checked by default*): if checked - the group with newly created nodes will be built.
A schema below illustrates how the crack is emulated using the node duplication.
@ -52,7 +47,7 @@ A schema below illustrates how the crack is emulated using the node duplication.
:align: center
.. centered::
"Crack emulation"
Crack emulation
This schema shows a virtual crack in a 2D mesh created using this duplication mode:
@ -74,11 +69,11 @@ Duplicate nodes and border elements
Parameters to be defined in this mode:
* **Group of elements to duplicate** (**mandatory**): these elements will be duplicated.
* **Group of nodes not to duplicate** (**optional**): group of nodes at crack bottom which will not be duplicated.
* **Group of elements to replace nodes with new ones** (**mandatory**): the new nodes will replace the nodes to duplicate within these elements.
* **Construct group with newly created elements** option (**checked by default**): if checked - the group of newly created elements will be built.
* **Construct group with newly created nodes** option (**checked by default**): if checked - the group of newly created nodes will be built.
* **Group of elements to duplicate** (*mandatory*): these elements will be duplicated.
* **Group of nodes not to duplicate** (*optional*): group of nodes at crack bottom which will not be duplicated.
* **Group of elements to replace nodes with new ones** (*mandatory*): the new nodes will replace the nodes to duplicate within these elements. **Generate** button tries to automatically find such elements and creates a group of them. This button becomes active as soon as **Group of elements to duplicate** is selected.
* **Construct group with newly created elements** option (*checked by default*): if checked - the group of newly created elements will be built.
* **Construct group with newly created nodes** option (*checked by default*): if checked - the group of newly created nodes will be built.
A schema below explains the crack emulation using the node duplication with border elements.
@ -87,7 +82,7 @@ A schema below explains the crack emulation using the node duplication with bord
:align: center
.. centered::
"Crack emulation"
Crack emulation
This schema shows a virtual crack in a 2D mesh created using this duplication mode. In this schema:
@ -117,8 +112,8 @@ This mode duplicates the given elements, i.e. creates new elements with the same
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 newly created elements will be built. The name of the created group starts from "DoubleElements".
* **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 newly created elements will be built. The name of the created group starts from "DoubleElements".
.. _mode_group_boundary_anchor:
@ -129,13 +124,12 @@ Duplicate nodes on group boundaries
This mode duplicates nodes located on boundaries between given groups of volumes.
.. image:: ../images/duplicate04.png
:align: center
Parameters to be defined in this mode:
* **Groups (faces or volumes)** (**mandatory**): list of mesh groups. These groups should be disjoint, i.e. should not have shared elements.
* **Groups (faces or volumes)** (*mandatory*): list of mesh groups. These groups should be disjoint, i.e. should not have shared elements.
* 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. Correspondingly 2D joint elements (null area faces) are generated where edges are shared by two faces. The created flat volumes (or faces) 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 flat elements are gathered into the group named "joints3D" (correspondingly "joints2D"). The flat elements of multiple junctions between the simple junction are stored in a group named "jointsMultiples".
* If **On all boundaries** option is activated, the volumes (or faces), which are not included into **Groups** input, are considered as another group and thus the nodes on the boundary between **Groups** and the remaining mesh are also duplicated.

27
doc/salome/gui/SMESH/input/editing_groups.rst
View File

@ -4,24 +4,20 @@
Editing groups
**************
**To edit an existing group of elements:**
*To edit an existing group of elements:*
#. Select your group in the Object Browser and in the **Mesh** menu click the **Edit Group** item or **"Edit Group"** button in the toolbar.
.. |img| image:: ../images/image74.gif
.. image:: ../images/image74.gif
:align: center
#. Select your group in the Object Browser and in the **Mesh** menu click the **Edit Group** item or *"Edit Group"* button |img| in the toolbar.
.. centered::
**"Edit Group" button**
The following dialog box will appear (if the selected group is **standalone**, else this dialog looks different):
The following dialog box will appear (if the selected group is **standalone**, else this dialog looks different):
.. image:: ../images/editgroup.png
:align: center
In this dialog box you can modify the name and the color of your group despite of its type. You can add or remove the elements composing a **standalone group**. You can change criteria of the filter of a **group on filter**. For more information see :ref:`creating_groups_page`:"Creating Groups" page.
In this dialog box you can modify the name and the color of your group despite of its type. You can add or remove the elements composing a **standalone group**. You can change criteria of the filter of a **group on filter**. For more information see :ref:`creating_groups_page` page.
#. Click the **Apply** or **Apply and Close** button to confirm modification of the group.
@ -31,18 +27,15 @@ Editing groups
Convert to stanalone group
==========================
**To convert an existing group on geometry or a group on filer into a standalone group and modify its contents:**
*To convert an existing group on geometry or a group on filer into a standalone group and modify its contents:*
#. Select your group on geometry or on filter in the Object Browser and in the **Mesh** menu click the **Edit Group as Standalone** item.
.. |edit| image:: ../images/image74.gif
.. image:: ../images/image74.gif
:align: center
.. centered::
**"Edit Group as Standalone" button**
#. Select your group on geometry or on filter in the Object Browser and in the **Mesh** menu click the **Edit Group as Standalone** item |edit|.
The selected group will be converted into a standalone group and its contents can be modified.
The selected group will be converted into a standalone group and its contents can be modified.
#. Click the **Apply** or **Apply and Close** button to confirm modification of the group.

21
doc/salome/gui/SMESH/input/editing_meshes.rst
View File

@ -4,21 +4,16 @@
Editing Meshes
**************
After you have created a mesh or sub-mesh with definite applied meshing algorithms and hypotheses you can edit your mesh by **assigning** other
algorithms and/or hypotheses or **unassigning** the applied hypotheses and algorithms. The editing proceeds in the same way as
:ref:`create_mesh_anchor`:"Mesh Creation".
After you have created a mesh or sub-mesh with definite applied meshing algorithms and hypotheses you can edit your mesh by **assigning** other algorithms and/or hypotheses or **unassigning** the applied hypotheses and algorithms. The editing proceeds in the same way as
:ref:`Mesh Creation <create_mesh_anchor>`.
.. image:: ../images/createmesh-inv3.png
:align: center
.. |img| image:: ../images/image122.png
You can also change values for the current hypothesis by clicking the
**"Edit Hypothesis"** button.
.. image:: ../images/image122.png
:align: center
.. centered::
**"Edit Hypothesis" button**
*"Edit Hypothesis"* |img| button.
Mesh entities generated before using changed hypotheses are automatically removed.
@ -29,15 +24,15 @@ changes if we apply different meshing parameters to it.
:align: center
.. centered::
"Example of a mesh with Max. Element area 2D hypothesis roughly corresponding to 1D hypotheses on edges"
Example of a mesh with Max. Element area 2D hypothesis roughly corresponding to 1D hypotheses on edges
.. image:: ../images/edit_mesh_change_value_hyp.png
:align: center
.. centered::
"And now the Max Element area is greatly reduced"
And now the Max Element area is greatly reduced
**See Also** a sample TUI Script of an :ref:`tui_editing_mesh` operation.
**See Also** a sample TUI Script of an :ref:`Edit Mesh <tui_editing_mesh>` operation.

70
doc/salome/gui/SMESH/input/extrusion.rst
View File

@ -4,13 +4,13 @@
Extrusion
*********
Extrusion is used to build mesh elements of plus one dimension than the input ones. Boundary elements around generated mesh of plus one dimension are additionally created. All created elements can be automatically grouped. Extrusion can be used to create a :ref:`extrusion_struct`:"structured mesh from scratch".
Extrusion is used to build mesh elements of plus one dimension than the input ones. Boundary elements around generated mesh of plus one dimension are additionally created. All created elements can be automatically grouped. Extrusion can be used to create a :ref:`structured mesh from scratch <extrusion_struct>`.
.. image:: ../images/extrusion_box.png
:align: center
.. centered::
"If you extrude several quadrangles, you get exactly the same mesh as if you meshed a geometrical box (except for that the initial quadrangles can be incorrectly oriented): quadrangles and segments are created on the boundary of the generated mesh"
If you extrude several quadrangles, you get exactly the same mesh as if you meshed a geometrical box (except for that the initial quadrangles can be incorrectly oriented): quadrangles and segments are created on the boundary of the generated mesh
Any node, segment or 2D element can be extruded. Each type of elements is extruded into a corresponding type of result elements:
@ -37,40 +37,31 @@ When 2D elements are extruded, in addition to 3D elements segments are created o
:align: center
.. centered::
"Two triangles extruded: no vertical rib segments generated from nodes #2 and #3 as they are shared by both triangles"
Two triangles extruded: no vertical rib segments generated from nodes #2 and #3 as they are shared by both triangles
**To use extrusion:**
*To use extrusion:*
#. From the **Modification** menu choose the **Extrusion** item or click **"Extrusion"** button in the toolbar.
.. |img| image:: ../images/image91.png
.. |sel_img| image:: ../images/image120.png
.. image:: ../images/image91.png
:align: center
#. From the **Modification** menu choose the **Extrusion** item or click *"Extrusion"* button |img| in the toolbar.
.. centered::
**"Extrusion" button**
The following dialog will appear:
The following dialog will appear:
.. image:: ../images/extrusionalongaline1.png
:align: center
#. In this dialog:
* Use *Selection* button to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
.. image:: ../images/image120.png
:align: center
.. centered::
**"Selection" button**
* Use *Selection* button |sel_img| to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
* Specify **Nodes**, **Edges** and **Faces**, which will be extruded, by one of following means:
* **Select the whole mesh, sub-mesh or group** activating the corresponding check-box.
* Choose mesh elements with the mouse in the 3D Viewer. It is possible to select a whole area with a mouse frame.
* Input the element IDs directly in **Node IDs**, **Edge IDs** and **Face IDs** fields. The selected elements will be highlighted in the viewer, if the mesh is shown there.
* Apply Filters. **Set filter** button allows to apply a filter to the selection of elements. See more about filters in the :ref:`filtering_elements`:"Selection filters" page.
* Apply Filters. **Set filter** button allows to apply a filter to the selection of elements. See more about filters in the :ref:`filtering_elements` page.
* If the **Extrusion to Distance** radio button is selected
* specify the translation vector by which the elements will be extruded.
@ -101,44 +92,33 @@ When 2D elements are extruded, in addition to 3D elements segments are created o
:align: center
.. centered::
"'Along average normal' activated (to the left) and deactivated (to the right)"
'Along average normal' activated (to the left) and deactivated (to the right)
* **Use only input elements** check-box specifies what elements will be used to compute the average normal.
* If it is *activated* only selected faces, among faces sharing the node, are used to compute the average normal at the node.
* Else all faces sharing the node are used.
The picture below shows a cross-section of a 2D mesh the upper plane of which is extruded with **Use only input elements** activated (to the left) and deactivated (to the right).
* If it is *activated* only selected faces, among faces sharing the node, are used to compute the average normal at the node.
* Else all faces sharing the node are used.
The picture below shows a cross-section of a 2D mesh the upper plane of which is extruded with **Use only input elements** activated (to the left) and deactivated (to the right).
.. image:: ../images/extrusionbynormal_useonly.png
:align: center
.. centered::
"'Use only input elements' activated (to the left) and deactivated (to the right)"
'Use only input elements' activated (to the left) and deactivated (to the right)
.. |add| image:: ../images/add.png
.. |rm| image:: ../images/remove.png
* Specify the **Number of steps**.
* Optionally specify **Scale Factors**. Each scale factor in the list is applied to nodes of a corresponding extrusion step unless **Linear Variation of Scale Factors** is checked, is which case the scale factors are spread over all extrusion steps.
* **Scaling Center** can be defined either using spin boxes or by picking a node in the Viewer or by picking a geometrical vertex in the Object Browser.
* **Add** button adds a scale factor to the list.
.. image:: ../images/add.png
:align: center
.. centered::
**"Add" button**
* **Remove** button removes selected scale factors from the list.
.. image:: ../images/remove.png
:align: center
.. centered::
**"Remove" button**
* **Add** button |add| adds a scale factor to the list.
* **Remove** button |rm| removes selected scale factors from the list.
* If you activate **Generate Groups** check-box, the **result elements** created from **selected elements** contained in groups will be included into new groups named by pattern "<old group name>_extruded" and "<old group name>_top". For example if a selected quadrangle is included in *g_Faces* group (see figures below) then result hexahedra will be included in *g_Faces_extruded* group and a quadrangle created at the "top" of extruded mesh will be included in *g_Faces_top group*.
@ -148,7 +128,7 @@ When 2D elements are extruded, in addition to 3D elements segments are created o
.. image:: ../images/extrusion_groups_res.png
:align: center
This check-box is active only if there are some groups in the mesh.
This check-box is active only if there are some groups in the mesh.
@ -163,19 +143,19 @@ Example: creation of a structured mesh from scratch
:align: center
.. centered::
"A node is extruded into a line of segments"
A node is extruded into a line of segments
.. image:: ../images/image76.jpg
:align: center
.. centered::
"The line of segments is extruded into a quadrangle mesh"
The line of segments is extruded into a quadrangle mesh
.. image:: ../images/image77.jpg
:align: center
.. centered::
"The quadrangle mesh is revolved into a hexahedral mesh"
The quadrangle mesh is revolved into a hexahedral mesh
**See Also** a sample TUI Script of an :ref:`tui_extrusion` operation.

44
doc/salome/gui/SMESH/input/extrusion_along_path.rst
View File

@ -63,13 +63,13 @@ In this example the path mesh has been built on a wire containing 3 edges. Node
:align: center
.. centered::
**Meshed wire**
Meshed wire
.. image:: ../images/extr_along_wire_after.png
:align: center
.. centered::
**The resulting extrusion**
The resulting extrusion
Extrusion of 2d elements along a closed path
############################################
@ -95,30 +95,20 @@ Extrusion of 2d elements along a closed path
The same, but using angles {45, -45, 45, -45, 45, -45, 45, -45}
**To use Extrusion along Path:**
*To use Extrusion along Path:*
#. From the **Modification** menu choose the **Extrusion along a path** item or click **"Extrusion along a path"** button in the toolbar.
.. |img| image:: ../images/image101.png
.. |sel| image:: ../images/image120.png
.. image:: ../images/image101.png
:align: center
#. From the **Modification** menu choose the **Extrusion along a path** item or click *"Extrusion along a path"* button |img| in the toolbar.
.. centered::
**"Extrusion along a path" button**
The following dialog will appear:
The following dialog will appear:
.. image:: ../images/extrusion_along_path_dlg.png
#. In this dialog:
* Use *Selection* button to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
.. image:: ../images/image120.png
:align: center
.. centered::
**"Selection" button**
* Use *Selection* button |sel| to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
* Specify **Nodes**, **Edges** and **Faces**, which will be extruded, by one of following means:
@ -148,23 +138,15 @@ Extrusion of 2d elements along a closed path
#. There are two optional parameters, which can be very useful:
#. If the path of extrusion is curvilinear, at each iteration the extruded elements are rotated to keep its initial angularity to the curve. By default, the **Base Point** around which the elements are rotated is the mass center of the elements (note that it can differ from the gravity center computed by *Geometry* module for the underlying shape), however, you can specify any point as the **Base Point** and the elements will be rotated with respect to this point. 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.
* If the path of extrusion is curvilinear, at each iteration the extruded elements are rotated to keep its initial angularity to the curve. By default, the **Base Point** around which the elements are rotated is the mass center of the elements (note that it can differ from the gravity center computed by *Geometry* module for the underlying shape), however, you can specify any point as the **Base Point** and the elements will be rotated with respect to this point. 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.
#. 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 right, add them to the list of angles at the left by pressing the **"Add"** button and remove them from the list by pressing the **"Remove"** button.
.. |add| image:: ../images/add.png
.. |rem| image:: ../images/remove.png
.. image:: ../images/add.png
:align: center
* 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 right, add them to the list of angles at the left by pressing the *"Add"* button |add| and remove them from the list by pressing the *"Remove"* button |rem|.
.. centered::
**"Add" button**
.. image:: ../images/remove.png
:align: center
.. centered::
**"Remove" button**
**Linear variation of the angles** option allows defining the angle of gradual rotation for the whole path. At each step the elements will be rotated by *( angle / nb. of steps )*.
**Linear variation of the angles** option allows defining the angle of gradual rotation for the whole path. At each step the elements will be rotated by *( angle / nb. of steps )*.

16
doc/salome/gui/SMESH/input/find_element_by_point.rst
View File

@ -6,17 +6,15 @@ Find Element by Point
This functionality allows you to find all mesh elements to which belongs a certain point.
**To find the elements:**
*To find the elements:*
.. |img| image:: ../images/findelement3.png
#. Select a mesh or a group
#. Select from the Mesh menu or from the context menu the Find Element by Point item.
#. Select from the Mesh menu or from the context menu the Find Element by Point item |img|.
.. image:: ../images/findelement3.png
:align: center
.. centered::
**"Find Element by Point" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/findelement2.png
:align: center
@ -25,7 +23,7 @@ This functionality allows you to find all mesh elements to which belongs a certa
#. In this dialog box you should select:
* the coordinates of the point;
* the type of elements to be found; it is also possible to find elements of all types related to the reference point. Choose type "All" to find elements of any type except for nodes and 0D elements.
#. Click the **Find** button.
#. Click the **Find** button. IDs of found entities will be shown.
.. image:: ../images/findelement1.png
:align: center

2
doc/salome/gui/SMESH/input/free_borders.rst
View File

@ -11,6 +11,6 @@ This mesh quality control highlights 1D elements (segments) belonging to one ele
In this picture the free borders are displayed in red. (Faces are explicitly shown via **Display Entity** menu as all elements but segments are hidden upon this control activation).
**See Also** a sample TUI Script of a :ref:`tui_free_borders` operation.
**See Also** a sample TUI Script of a :ref:`tui_free_borders` filter.

6
doc/salome/gui/SMESH/input/free_edges.rst
View File

@ -10,8 +10,6 @@ This mesh quality control highlights borders of faces (links between nodes, not
:align: center
.. centered::
In this picture some elements of mesh have been deleted and the "holes" are outlined in red.
**See Also** a sample TUI Script of a :ref:`tui_free_edges` operation.
Some elements of mesh have been deleted and the "holes" are outlined in red.
**See Also** a sample TUI Script of a :ref:`tui_free_edges` filter.

4
doc/salome/gui/SMESH/input/free_faces.rst
View File

@ -11,6 +11,4 @@ This mesh quality control highlights the faces connected to less than two mesh v
In this picture some volume mesh elements have been removed, 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` operation.
**See also:** A sample TUI Script of a :ref:`tui_free_faces` filter.

4
doc/salome/gui/SMESH/input/free_nodes.rst
View File

@ -11,6 +11,4 @@ This mesh quality control highlights the nodes which are not connected to any m
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` operation.
**See also:** A sample TUI Script of a :ref:`tui_free_nodes` filter.

31
doc/salome/gui/SMESH/input/grouping_elements.rst
View File

@ -9,10 +9,11 @@ In Mesh module it is possible to create groups of mesh entities: nodes, edges, f
There are three types of groups different by their internal organization:
#. **Standalone group** is a static set of mesh entities. Its contents can be explicitly controlled by the user. Upon removal of the entities included into the group, e.g. due to modification of meshing parameter, the group becomes empty and its content can be restored only manually. Hence it is reasonable to create standalone groups when the mesh generation is finished and mesh quality is verified.
.. warning:: Creation and edition of large standalone groups in :ref:`creating_groups_page` dialog using manual edition is problematic due to poor performance of the dialog.
.. warning:: Creation and edition of large standalone groups in :ref:`Create group <creating_groups_page>` dialog using manual edition is problematic due to poor performance of the dialog.
#. **Group on geometry** is associated to a sub-shape or a group of sub-shapes of the main shape and includes mesh entities generated on these geometrical entities. The association to a geometry is established at group construction and cannot be changed. The group contents are always updated automatically, hence the group can be created even before mesh elements generation.
#. **Group on filter** encapsulates a :ref:`filters_page`, which is used to select mesh entities composing the group from the whole mesh. Criteria of the filter can be changed at any time. The group contents are always updated automatically, hence the group can be created even before mesh elements generation.
#. **Group on filter** encapsulates a :ref:`filter <filters_page>`, which is used to select mesh entities composing the group from the whole mesh. Criteria of the filter can be changed at any time. The group contents are always updated automatically, hence the group can be created even before mesh elements generation.
The group on geometry and group on filter can be converted to a standalone group.
@ -20,26 +21,23 @@ The group on geometry and group on filter can be converted to a standalone group
:align: center
.. centered::
"Groups of different types look differently in the Object Browser"
Groups of different types look differently in the Object Browser
The following ways of group creation are possible:
* :ref:`creating_groups_page` dialog allows creation of a group of any type:
:ref:`standalone_group`,
:ref:`group_on_geom` and
:ref:`group_on_filter` using dedicated tabs.
* :ref:`create_groups_from_geometry_page` dialog allows creation of several groups on geometry at once.
* :ref:`Create group <creating_groups_page>` dialog allows creation of a group of any type: :ref:`Standalone group<standalone_group>`, :ref:`Group on geometry <group_on_geom>` and :ref:`Group on filter <group_on_filter>` using dedicated tabs.
* :ref:`Create Groups from Geometry <create_groups_from_geometry_page>` dialog allows creation of several groups on geometry at once.
* Standalone groups of all nodes and elements of the chosen sub-mesh (type of elements depends on dimension of sub-mesh geometry) can be created using **Mesh -> Construct Group** menu item (available from the context menu as well).
* Standalone groups of any element type can be created basing on nodes of other groups - using :ref:`group_of_underlying_elements_page` dialog.
* Standalone groups can be created by applying :ref:`using_operations_on_groups_page` to other groups.
* Creation of standalone groups is an option of many :ref:`modifying_meshes_page` operations.
* Standalone groups of any element type can be created basing on nodes of other groups - using :ref:`Group based on nodes of other groups <group_of_underlying_elements_page>` dialog.
* Standalone groups can be created by applying :ref:`Boolean operations <using_operations_on_groups_page>` to other groups.
* Creation of standalone groups is an option of many :ref:`mesh modification <modifying_meshes_page>` operations.
The created groups can be later:
* :ref:`editing_groups_page`
* :ref:`deleting_groups_page`, either as an object or together with contained elements.
* The group on geometry and group on filter can be :ref:`convert_to_standalone` group.
* :ref:`importing_exporting_meshes_page` into a file as a whole mesh.
* :ref:`Edited <editing_groups_page>`
* :ref:`Deleted <deleting_groups_page>`, either as an object or together with contained elements.
* The group on geometry and group on filter can be :ref:`converted into the standalone <convert_to_standalone>` group.
* :ref:`Exported <importing_exporting_meshes_page>` into a file as a whole mesh.
In the Object Browser, if an item contains more than one child group, it is possible to sort the groups by name in ascending order using **Sort children** context menu item.
@ -47,10 +45,11 @@ In the Object Browser, if an item contains more than one child group, it is poss
:align: center
.. centered::
"Sorting groups"
Sorting groups
An important tool, providing filters for creation of standalone groups and groups on filter is :ref:`selection_filter_library_page`.
**Table of Contents**
.. toctree::
:maxdepth: 2

29
doc/salome/gui/SMESH/input/importing_exporting_meshes.rst
View File

@ -5,9 +5,18 @@
Importing and exporting meshes
******************************
In MESH there is a functionality allowing import/export of meshes from/to **MED**, **UNV** (I-DEAS 10), **DAT** (simple ascii format), **STL**, **GMF** (internal format of DISTENE products, namely MG-CADSurf, MG-Tetra and MG-Hexa algorithms) and **CGNS** format files. You can also export a group as a whole mesh.
In MESH there is a functionality allowing import/export of meshes in follwing formats:
**To import a mesh:**
* **MED**,
* **UNV** (I-DEAS 10),
* **DAT** (simple ascii format),
* **STL**,
* **GMF** (internal format of DISTENE products from the MeshGems suite),
* **CGNS**.
You can also export a group as a whole mesh.
*To import a mesh:*
#. From the **File** menu choose the **Import** item, from its sub-menu select the corresponding format (MED, UNV, STL, GMF and CGNS) of the file containing your mesh.
#. In the standard **Search File** dialog box find the file for import. It is possible to select multiple files to be imported all at once.
@ -16,7 +25,7 @@ In MESH there is a functionality allowing import/export of meshes from/to **MED*
.. image:: ../images/meshimportmesh.png
:align: center
**To export a mesh or a group:**
*To export a mesh or a group:*
#. Select the object you wish to export.
#. From the **File** menu choose the **Export** item, from its sub-menu select the format (MED, UNV, DAT, STL, GMF and CGNS) of the file which will contain your exported mesh.
@ -31,20 +40,18 @@ If you try to export a group, the warning will be shown:
.. image:: ../images/meshexportgroupwarning.png
:align: center
* **Don't show this warning anymore** check-box allows to switch off the warning. You can re-activate the warning in :ref:`group_export_warning_pref`.
* **Don't show this warning anymore** check-box allows to switch off the warning. You can re-activate the warning in :ref:`Preferences <group_export_warning_pref>`.
There are additional parameters available at export to MED and SAUV format files.
.. _export_auto_groups:
Auto Groups
===========
* **Automatically create groups** check-box specifies whether to create groups of all mesh entities of available dimensions or not. The created groups have names like "Group_On_All_Nodes", "Group_On_All_Faces", etc. A default state of this check-box can be set in :ref:`Preferences <export_auto_groups_pref>`.
* **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 of a lower dimension in the following cases, provided that this check-box is checked:
* **Automatically create groups** check-box specifies whether to create groups of all mesh entities of available dimensions or not. The created groups have names like "Group_On_All_Nodes", "Group_On_All_Faces", etc. A default state of this check-box can be set in :ref:`export_auto_groups_pref`.
* **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 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 in XOY coordinate plane.
* **1D**: if all mesh nodes lie on OX coordinate axis.
* **2D**: if all mesh nodes lie in XOY coordinate plane.
**See Also** a sample TUI Script of an :ref:`tui_export_mesh` operation.
**See Also** a sample TUI Script of an :ref:`Export Mesh <tui_export_mesh>` operation.

69
doc/salome/gui/SMESH/input/index.rst
View File

@ -3,23 +3,58 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to SMESH's documentation!
=================================
***************************
Introduction to Mesh module
***************************
.. image:: ../images/a-viewgeneral.png
:align: center
**Mesh** module of SALOME is destined for:
* :ref:`creating meshes <about_meshes_page>` in different ways:
* by meshing geometrical models previously created or imported by the Geometry component;
* bottom-up, using :ref:`mesh edition <modifying_meshes_page>`, especially :ref:`extrusion <extrusion_page>` and :ref:`revolution <revolution_page>`;
* by generation of the 3D mesh from the 2D mesh not based on the geometry (:ref:`imported <importing_exporting_meshes_page>` for example);
* :ref:`importing and exporting meshes <importing_exporting_meshes_page>` in various formats;
* :ref:`modifying meshes <modifying_meshes_page>` with a vast array of dedicated operations;
* :ref:`creating groups <grouping_elements_page>` of mesh elements;
* filtering mesh entities (nodes or elements) using :ref:`Filters <filters_page>` functionality for :ref:`creating groups <grouping_elements_page>` and applying :ref:`mesh modifications <modifying_meshes_page>`;
* :ref:`viewing meshes <viewing_meshes_overview_page>` in the VTK viewer and :ref:`getting info <mesh_infos_page>` on mesh and its sub-objects;
* applying to meshes :ref:`Quality Controls <quality_page>`, allowing to highlight important elements;
* taking various :ref:`measurements <measurements_page>` of the mesh objects.
There is a set of :ref:`tools <tools_page>` plugged-in the module to extend the basic functionality listed above.
Almost all mesh module functionalities are accessible via :ref:`smeshpy_interface_page`.
It is possible to use the variables predefined in :ref:`Salome notebook <using_notebook_mesh_page>` to set parameters of operations.
Mesh module preferences are described in the :ref:`mesh_preferences_page` section of SALOME Mesh Help.
.. image:: ../images/image7.jpg
:align: center
.. centered::
Example of MESH module usage for engineering tasks
**Table of Contents**
.. toctree::
:maxdepth: 3
introduction.rst
about_meshes.rst
modifying_meshes.rst
grouping_elements.rst
about_filters.rst
viewing_meshes_overview.rst
about_quality_controls.rst
measurements.rst
using_notebook_smesh_page.rst
mesh_preferences.rst
smeshpy_interface.rst
tools.rst
:titlesonly:
:maxdepth: 3
about_meshes
modifying_meshes
grouping_elements
about_filters
about_quality_controls
measurements
viewing_meshes_overview
smeshpy_interface
tools
mesh_preferences
using_notebook_smesh_page

50
doc/salome/gui/SMESH/input/introduction.rst
View File

@ -1,50 +0,0 @@
***************************
Introduction to Mesh module
***************************
.. image:: ../images/a-viewgeneral.png
:align: center
**Mesh** module of SALOME is destined for:
* :ref:`creating meshes <about_meshes_page>` in different ways:
* by meshing geometrical models previously created or imported by the Geometry component;
* bottom-up, using :ref:`modifying_meshes_page`, especially :ref:`extrusion_page` and :ref:`revolution_page`;
* by generation of the 3D mesh from the 2D mesh not based on the geometry (:ref:`importing_exporting_meshes_page` for example);
* :ref:`importing_exporting_meshes_page` in various formats;
* :ref:`modifying_meshes_page` with a vast array of dedicated operations;
* :ref:`grouping_elements_page` of mesh elements;
* filtering mesh entities (nodes or elements) using :ref:`filters_page` functionality for :ref:`grouping_elements_page` and applying :ref:`modifying_meshes_page`;
* :ref:`viewing_meshes_overview_page` in the VTK viewer and :ref:`mesh_infos_page` on mesh and its sub-objects;
* applying to meshes :ref:`quality_page`, allowing to highlight important elements;
* taking various :ref:`measurements_page` of the mesh objects.
It is possible to use the variables predefined in :ref:`using_notebook_mesh_page` to set parameters of operations.
Mesh module preferences are described in the :ref:`mesh_preferences_page` section of SALOME Mesh Help.
Almost all mesh module functionalities are accessible via :ref:`smeshpy_interface_page`.
There is a set of :ref:`tools_page` plugged-in the module to extend the basic functionality listed above.
.. image:: ../images/image7.jpg
:align: center
.. centered::
"Example of MESH module usage for engineering tasks"
.. toctree::
:maxdepth: 3
:hidden:
about_meshes.rst
modifying_meshes.rst
grouping_elements.rst
about_filters.rst
viewing_meshes_overview.rst
about_quality_controls.rst
measurements.rst
using_notebook_smesh_page.rst
mesh_preferences.rst
smeshpy_interface.rst
tools.rst

2
doc/salome/gui/SMESH/input/length.rst
View File

@ -9,5 +9,5 @@ Length quality control criterion returns a value of length of edge.
.. image:: ../images/length-crit.png
:align: center
**See Also** a sample TUI Script of a :ref:`tui_length_1d` operation.
**See Also** a sample TUI Script of a :ref:`tui_length_1d` filter.

15
doc/salome/gui/SMESH/input/length_2d.rst
View File

@ -6,16 +6,13 @@ Length 2D
This quality control criterion consists of calculation of length of the links between corner nodes of mesh faces.
**To apply the Length 2D quality criterion to your mesh:**
*To apply the Length 2D quality criterion to your mesh:*
.. |img| image:: ../images/image34.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Length 2D** or click **"Length 2D"** button in the toolbar.
#. Choose **Controls > Face Controls > Length 2D** or click *"Length 2D"* button |img| in the toolbar.
.. image:: ../images/image34.png
:align: center
.. centered::
**"Length 2D" button**
Your mesh will be displayed in the viewer with links colored according to the applied mesh quality control criterion:
@ -23,6 +20,4 @@ Your mesh will be displayed in the viewer with links colored according to the ap
:align: center
**See Also** a sample TUI Script of a :ref:`tui_length_2d` operation.
**See Also** a sample TUI Script of a :ref:`tui_length_2d` filter.

22
doc/salome/gui/SMESH/input/make_2dmesh_from_3d.rst
View File

@ -10,35 +10,29 @@ This functionality allows to generate mesh elements on the borders of elements o
:align: center
.. centered::
"Missing 2D elements were generated"
Missing 2D elements were generated
**To generate border elements:**
*To generate border elements:*
.. |img| image:: ../images/2d_from_3d_ico.png
#. Select a mesh or group in the Object Browser or in the 3D Viewer
#. From the Modification menu choose "Create boundary elements" item, or click "Create boundary elements" button in the toolbar
#. From the **Modification** menu choose **Create boundary elements** item, or click "Create boundary elements" button |img| in the toolbar
.. image:: ../images/2d_from_3d_ico.png
:align: center
.. centered::
"Create boundary elements icon"
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/2d_from_3d_dlg.png
:align: center
.. centered::
"Create boundary elements dialog box".
Create boundary elements dialog box
#. Check in the dialog box one of two radio buttons corresponding to the type of operation you would like to perform.
#. Fill the other fields available in the dialog box.
#. Click the **Apply** or **Apply and Close** button to perform the operation.
"Create boundary elements" dialog allows creation of boundary elements of two types.
*Create boundary elements* dialog allows creation of boundary elements of two types.
* **2D from 3D** creates missing mesh faces on free facets of volume elements
* **1D from 2D** creates missing mesh edges on free edges of mesh faces

18
doc/salome/gui/SMESH/input/max_element_length_2d.rst
View File

@ -6,22 +6,16 @@ Element Diameter 2D
This quality control criterion consists in calculation of the maximal length of edges and diagonals of 2D mesh elements (triangles and quadrangles). For polygons the value is always zero.
**To apply the Element Diameter 2D quality criterion to your mesh:**
*To apply the Element Diameter 2D quality criterion to your mesh:*
.. |img| image:: ../images/image42.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Element Diameter 2D** or click **"Element Diameter 2D"** button in the toolbar.
#. Choose **Controls > Face Controls > Element Diameter 2D** or click *"Element Diameter 2D"* button |img| in the toolbar.
.. image:: ../images/image42.png
:align: center
.. centered::
**"Element Diameter 2D" button**
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/max_element_length_2d.png
:align: center
**See Also** a sample TUI Script of a :ref:`tui_max_element_length_2d` operation.
**See Also** a sample TUI Script of a :ref:`tui_max_element_length_2d` filter.

18
doc/salome/gui/SMESH/input/max_element_length_3d.rst
View File

@ -6,23 +6,17 @@ Element Diameter 3D
This quality control criterion consists in calculation of the maximal length of edges and diagonals of 3D mesh elements (tetrahedrons, pyramids, etc). For polyhedra the value is always zero.
**To apply the Element Diameter 3D quality criterion to your mesh:**
*To apply the Element Diameter 3D quality criterion to your mesh:*
.. |img| image:: ../images/image43.png
#. Display your mesh in the viewer.
#. Choose **Controls > Volume Controls > Element Diameter 3D** or click **"Element Diameter 3D"** button in the toolbar.
#. Choose **Controls > Volume Controls > Element Diameter 3D** or click *"Element Diameter 3D"* button |img| in the toolbar.
.. image:: ../images/image43.png
:align: center
.. centered::
**"Element Diameter 3D" button**
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/max_element_length_3d.png
:align: center
**See Also** a sample TUI Script of a :ref:`tui_max_element_length_3d` operation.
**See Also** a sample TUI Script of a :ref:`tui_max_element_length_3d` filter.

30
doc/salome/gui/SMESH/input/merging_elements.rst
View File

@ -10,7 +10,7 @@ This functionality allows to merge coincident elements of a mesh. Two elements a
:align: center
.. centered::
"Merge elements menu button"
*"Merge elements"* menu button
To merge elements choose in the main menu **Modification** -> **Transformation** -> **Merge elements** item. The following dialog box shall appear:
@ -19,9 +19,10 @@ To merge elements choose in the main menu **Modification** -> **Transformation**
In this dialog:
* Name is the name of the mesh object whose elements will be merged.
* **Name** is the name of the mesh object whose elements will be merged.
* **Automatic** or **Manual** Mode allows choosing how the elements are processed. In the **Automatic** Mode all elements created on the same nodes will be merged. In **Manual** mode you can adjust groups of coincident elements detected by the program.
If the **Manual** Mode is selected, additional controls are available:
If the **Manual** Mode is selected, additional controls are available:
.. image:: ../images/mergeelems.png
:align: center
@ -35,30 +36,27 @@ In this dialog:
* **Show double elements IDs** check-box shows/hides identifiers of elements of the selected groups in the 3D viewer.
* **Edit selected group of coincident elements** list allows editing the selected group:
.. image:: ../images/add.png
:align: center
.. image:: ../images/add.png
:align: center
.. centered::
adds to the group the elements selected in the viewer.
* adds to the group the elements selected in the viewer.
.. image:: ../images/remove.png
:align: center
.. image:: ../images/remove.png
:align: center
.. centered::
removes the selected elements from the group.
* removes the selected elements from the group.
.. image:: ../images/sort.png
:align: center
.. image:: ../images/sort.png
:align: center
.. centered::
moves the selected element to the first position in the group in order to keep it in the mesh.
* moves the selected element to the first position in the group in order to keep it in the mesh.
* To confirm your choice click **Apply** or **Apply and Close** button.
In this picture you see a triangle which coincides with one of the elements of the mesh. After we apply **Merge Elements** functionality, the triangle will be completely merged with the mesh.
In the following picture you see a triangle which coincides with one of the elements of the mesh. After we apply **Merge Elements** functionality, the triangle will be completely merged with the mesh.
.. image:: ../images/meshtrianglemergeelem1.png
:align: center

39
doc/salome/gui/SMESH/input/merging_nodes.rst
View File

@ -10,9 +10,9 @@ This functionality allows user to detect groups of coincident nodes with specifi
:align: center
.. centered::
"Merge nodes menu button"
*"Merge nodes"* menu button
**To merge nodes of your mesh:**
*To merge nodes of your mesh:*
#. Choose **Modification** -> **Transformation** -> **Merge nodes** menu item. The following dialog box shall appear:
@ -53,37 +53,32 @@ This functionality allows user to detect groups of coincident nodes with specifi
* **Edit selected group of coincident nodes** list allows editing the selected group:
.. image:: ../images/add.png
:align: center
.. image:: ../images/add.png
:align: center
.. centered::
adds to the group the nodes selected in the viewer.
* adds to the group the nodes selected in the viewer.
.. image:: ../images/remove.png
:align: center
.. image:: ../images/remove.png
:align: center
.. centered::
removes from the group the selected nodes.
* removes from the group the selected nodes.
.. image:: ../images/sort.png
:align: center
.. image:: ../images/sort.png
:align: center
.. centered::
moves the selected node to the first position in the group in order to keep it in the mesh.
* moves the selected node to the first position in the group in order to keep it in the mesh.
#. To confirm your choice click **Apply** or **Apply and Close** button.
.. image:: ../images/merging_nodes1.png
:align: center
.. figure:: ../images/merging_nodes1.png
:align: center
.. centered::
The initial object. Nodes 25, 26 and 5 are added to **Nodes to keep during the merge** group.
The initial object. Nodes 25, 26 and 5 are added to **Nodes to keep during the merge** group.
.. image:: ../images/merging_nodes2.png
:align: center
.. figure:: ../images/merging_nodes2.png
:align: center
.. centered::
The object has been merged
The object has been merged
**See Also** a sample TUI Script of a :ref:`tui_merging_nodes` operation.

42
doc/salome/gui/SMESH/input/mesh_infos.rst
View File

@ -6,27 +6,24 @@ Mesh Information
The user can obtain information about the selected mesh object (mesh, sub-mesh or group) using **Mesh Information** dialog box.
To view the **Mesh Information**, select your mesh, sub-mesh or group in the **Object Browser** and invoke **Mesh Information** item from the **Mesh** menu or from the context menu, or click **"Mesh Information"** button in the toolbar.
.. |img| image:: ../images/image49.png
.. image:: ../images/image49.png
:align: center
To view the **Mesh Information**, select your mesh, sub-mesh or group in the **Object Browser** and invoke **Mesh Information** item from the **Mesh** menu or from the context menu, or click *"Mesh Information"* button |img| in the toolbar.
.. centered::
**"Mesh Information" button**
The **Mesh Information** dialog box provides three tab pages:
* :ref:`advanced_mesh_infos_anchor` - to show base and quantitative information about the selected mesh object.
* :ref:`mesh_element_info_anchor` - to show detailed information about the selected mesh nodes or elements.
* :ref:`mesh_addition_info_anchor` - to show additional information available for the selected mesh, sub-mesh or group object.
* :ref:`mesh_quality_info_anchor` - to show overall quality information about the selected mesh, sub-mesh or group object.
* :ref:`Base Info <advanced_mesh_infos_anchor>` - to show base and quantitative information about the selected mesh object.
* :ref:`Element Info <mesh_element_info_anchor>` - to show detailed information about the selected mesh nodes or elements.
* :ref:`Additional Info <mesh_addition_info_anchor>` - to show additional information available for the selected mesh, sub-mesh or group object.
* :ref:`Quality Info <mesh_quality_info_anchor>` - to show overall quality information about the selected mesh, sub-mesh or group object.
.. _dump_mesh_infos:
Dump Mesh Infos
###############
The button **Dump** allows printing the information displayed in the dialog box to a .txt file. The dialog for choosing a file also allows to select which tab pages to dump via four check-boxes. The default state of the check-boxes can be changed via :ref:`mesh_information_pref` preferences.
The button **Dump** allows printing the information displayed in the dialog box to a .txt file. The dialog for choosing a file also allows to select which tab pages to dump via four check-boxes. The default state of the check-boxes can be changed via :ref:`Mesh information <mesh_information_pref>` preferences.
.. _advanced_mesh_infos_anchor:
@ -39,7 +36,7 @@ The **Base Info** tab page of the dialog box provides general information on the
:align: center
.. centered::
**"Base Info" page**
*"Base Info"* page
.. _mesh_element_info_anchor:
@ -59,7 +56,7 @@ The **Element Info** tab page of the dialog box gives detailed information about
:align: center
.. centered::
**"Element Info" page, node information**
*"Element Info"* page, node information
* For an element:
@ -75,13 +72,14 @@ The **Element Info** tab page of the dialog box gives detailed information about
:align: center
.. centered::
**"Element Info" page, element information**
*"Element Info"* page, element information
The user can either input the ID of a node or element he wants to analyze directly in the dialog box or select the node(s) or element(s) in the 3D viewer.
If **Show IDs** is activated, IDs of selected nodes or elements are displayed in the 3D viewer.
.. note::
The information about the groups, to which the node or element belongs, can be shown in a short or in a detailed form. By default, for performance rasons, this information is shown in a short form (group names only). The detailed information on groups can be switched on via :ref:`group_detail_info_pref` option of :ref:`mesh_preferences_page`.
The information about the groups, to which the node or element belongs, can be shown in a short or in a detailed form. By default, for performance rasons, this information is shown in a short form (group names only). The detailed information on groups can be switched on via :ref:`Show details on groups in element information tab <group_detail_info_pref>` option of :ref:`mesh_preferences_page`.
.. _mesh_addition_info_anchor:
@ -103,7 +101,7 @@ For a mesh object, the following information is shown:
:align: center
.. centered::
**"Additional Info" page, mesh information**
*"Additional Info"* page, mesh information
For a sub-mesh object, the following information is shown:
@ -116,7 +114,7 @@ For a sub-mesh object, the following information is shown:
:align: center
.. centered::
**"Additional Info" page, sub-mesh information**
*"Additional Info"* page, sub-mesh information
.. _mesh_addition_info_group_anchor:
@ -138,11 +136,11 @@ For a group object, the following information is shown:
:align: center
.. centered::
**"Additional Info" page, group information**
*"Additional Info"* page, group information
.. note::
For the performance reasons, the number of underlying nodes is computed only by demand. For this, the user should press the "Compute" button (see picture). Also, the number of underlying nodes is automatically calculated if the size of the group does not exceed the :ref:`nb_nodes_limit_pref` preference value (zero value means no limit).
For the performance reasons, the number of underlying nodes is computed only by demand. For this, the user should press the "Compute" button (see picture). Also, the number of underlying nodes is automatically calculated if the size of the group does not exceed the :ref:`Automatic nodes compute limit <nb_nodes_limit_pref>` preference value (zero value means no limit).
.. _mesh_quality_info_anchor:
@ -171,18 +169,18 @@ The **Quality Info** tab provides overall information about mesh quality control
:align: center
.. centered::
**"Quality Info" page**
*"Quality Info"* page
.. note::
It is possible to change **Double nodes tolerance**, which will be used upon consequent pressing *Compute* button. The default value of the tolerance can be set via the :ref:`dbl_nodes_tol_pref` preferences.
It is possible to change **Double nodes tolerance**, which will be used upon consequent pressing *Compute* button. The default value of the tolerance can be set via the :ref:`Quality controls <dbl_nodes_tol_pref>` preferences.
.. 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 :ref:`auto_control_limit_pref` set via the :ref:`mesh_information_pref` preferences (zero value means that there is no limit).
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 :ref:`Automatic controls compute limit <auto_control_limit_pref>` set via the :ref:`Mesh information <mesh_information_pref>` preferences (zero value means that there is no limit).
.. note::
The plot functionality is available only if the GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
See the :ref:`tui_viewing_mesh_infos`.
See the :ref:`TUI Example <tui_viewing_mesh_infos>`.

186
doc/salome/gui/SMESH/input/mesh_preferences.rst
View File

@ -14,142 +14,111 @@ General Preferences
.. _automatic_update_pref:
Automatic Update
=================
* **Automatic Update**
* **Automatic Update** - if activated, the mesh in your viewer will be automatically updated after it's computation, depending on values of additional preferences specified below.
* **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 :ref:`compute_anchor` operation. Zero value means "no limit". Default value is 500 000 mesh elements.
* **Incremental limit check** - if activated, 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.
* **Automatic Update** - if activated, the mesh in your viewer will be automatically updated after it's computation, depending on values of additional preferences specified below.
* **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 :ref:`Compute <compute_anchor>` operation. Zero value means "no limit". Default value is 500 000 mesh elements.
* **Incremental limit check** - if activated, 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.
.. _display_mode_pref:
Display mode
============
* **Display mode**
* **Default display mode** - allows to set Wireframe, Shading, Nodes or Shrink :ref:`display_mode_page` as default.
* **Default display mode** - allows to set Wireframe, Shading, Nodes or Shrink :ref:`presentation mode <display_mode_page>` as default.
.. _quadratic_2d_mode_pref:
Quadratic 2D preferences
========================
* **Representation of the 2D quadratic elements**
* **Default mode of the 2D quadratic elements** - allows to select either *Lines* or *Arcs* as a default :ref:`quadratic_2d_mode` of 1D and 2D :ref:`adding_quadratic_elements_page`.
* **Maximum Angle** - maximum deviation angle used by the application to build arcs.
* **Default mode of the 2D quadratic elements** - allows to select either *Lines* or *Arcs* as a default :ref:`representation <quadratic_2d_mode>` of 1D and 2D :ref:`quadratic elements <adding_quadratic_elements_page>`.
* **Maximum Angle** - maximum deviation angle used by the application to build arcs.
* **Quality Controls**
* **Display entity** - if activated, only currently :ref:`quality_page` entities are displayed in the viewer and other entities are temporarily hidden. For example if you activate :ref:`length_page` quality control, which controls the length of mesh segments, then only mesh segments are displayed and faces and volumes are hidden.
* **Use precision** - if activated, all quality controls will be computed at precision defined by **Number of digits after point** - as integers by default.
* **Display entity** - if activated, only currently :ref:`controlled <quality_page>` entities are displayed in the viewer and other entities are temporarily hidden. For example if you activate :ref:`Length <length_page>` quality control, which controls the length of mesh segments, then only mesh segments are displayed and faces and volumes are hidden.
* **Use precision** - if activated, all quality controls will be computed at precision defined by **Number of digits after point** - as integers by default.
.. _dbl_nodes_tol_pref:
Double nodes tolerance
======================
* **Double nodes tolerance** - defines the maximal distance between two mesh nodes, at which they are considered coincident by :ref:`double_nodes_control_page` quality control. This value is also used in :ref:`mesh_quality_info_anchor` tab page of :ref:`mesh_infos_page` dialog.
* **Double nodes tolerance** - defines the maximal distance between two mesh nodes, at which they are considered coincident by :ref:`Double nodes <double_nodes_control_page>` quality control. This value is also used in :ref:`Quality Info <mesh_quality_info_anchor>` tab page of :ref:`Mesh Information <mesh_infos_page>` dialog.
* **Mesh export**
.. _export_auto_groups_pref:
Automatically create groups for MED export
==========================================
* **Automatically create groups for MED export** - defines a default state of a corresponding check-box in :ref:`export_auto_groups` dialog.
* **Automatically create groups for MED export** - defines a default state of a corresponding check-box in :ref:`MED Export <export_auto_groups>` dialog.
.. _group_export_warning_pref:
Show warning when exporting group
=================================
* **Show warning when exporting group** - if activated, a warning is displayed when exporting a group.
* **Show warning when exporting group** - if activated, a warning is displayed when exporting a group.
.. _show_comp_result_pref:
Mesh computation
================
* **Mesh computation**
* **Show a computation result notification** - allows to select the notification mode about a :ref:`compute_anchor` result. There are 3 possible modes:
* **Never** - not to show the :ref:`meshing_result_anchor` at all;
* **Show a computation result notification** - allows to select the notification mode about a :ref:`mesh computation <compute_anchor>` result. There are 3 possible modes:
* **Never** - not to show the :ref:`result dialog <meshing_result_anchor>` at all;
* **Errors only** - the result dialog will be shown if there were some errors during a mesh computation;
* **Always** - show the result dialog after each mesh computation. This is a default mode.
.. _mesh_information_pref:
Mesh information
================
* **Mesh information**
* **Mesh element information** - allows changing the way :ref:`mesh_element_info_anchor` is shown:
* **Mesh element information** - allows changing the way :ref:`mesh element information <mesh_element_info_anchor>` is shown:
* **Simple** - as a plain text
* **Tree** - in a tree-like form
.. _nb_nodes_limit_pref:
Automatic nodes compute limit
=============================
* **Automatic nodes compute limit** - allows defining the size limit for the :ref:`mesh_addition_info_group_anchor` 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 nodes compute limit** - allows defining the size limit for the :ref:`mesh groups <mesh_addition_info_group_anchor>` 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.
.. _auto_control_limit_pref:
Automatic controls compute limit
================================
* **Automatic controls compute limit** - allows defining a maximal number of mesh elements for which the quality controls in the :ref:`mesh_quality_info_anchor` tab page are calculated automatically. If the number of mesh elements exceeds the value set in the preferences, it is necessary to press **Compute** button explicitly to calculate a quality measure. Zero value means "no limit". By default the value is set to 3 000 mesh elements.
* **Automatic controls compute limit** - allows defining a maximal number of mesh elements for which the quality controls in the :ref:`Quality Information <mesh_quality_info_anchor>` tab page are calculated automatically. If the number of mesh elements exceeds the value set in the preferences, it is necessary to press **Compute** button explicitly to calculate a quality measure. Zero value means "no limit". By default the value is set to 3 000 mesh elements.
.. _group_detail_info_pref:
Detailed info for groups
========================
* **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` tab of "Mesh Information" dialog box. If this option is switched on, the detailed information on groups is shown.
* **Dump base information** - allows dumping base mesh information to the file, see :ref:`dump_mesh_infos`.
* **Dump element information** - allows dumping element information to the file, see :ref:`dump_mesh_infos`.
* **Dump additional information** - allows dumping additional mesh information to the file, see :ref:`dump_mesh_infos`.
* **Dump controls information** - allows dumping quality mesh information to the file, see :ref:`dump_mesh_infos`.
* **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:`Element Info <mesh_element_info_anchor>` tab of "Mesh Information" dialog box. If this option is switched on, the detailed information on groups is shown.
* **Dump base information** - allows dumping base mesh information to the file, see :ref:`Mesh Information <dump_mesh_infos>`.
* **Dump element information** - allows dumping element information to the file, see :ref:`Mesh Information <dump_mesh_infos>`.
* **Dump additional information** - allows dumping additional mesh information to the file, see :ref:`Mesh Information <dump_mesh_infos>`.
* **Dump controls information** - allows dumping quality mesh information to the file, see :ref:`Mesh Information <dump_mesh_infos>`.
* **Automatic Parameters**
.. _diagonal_size_ratio_pref:
Ratio Bounding Box Diagonal
===========================
* **Ratio Bounding Box Diagonal / Max Size** - defines the ratio between the bounding box of the meshed object and the Max Size of segments. It is used as a default value of :ref:`a1d_meshing_hypo_page` defining length of segments, especially by :ref:`max_length_anchor` hypothesis.
* **Ratio Bounding Box Diagonal / Max Size** - defines the ratio between the bounding box of the meshed object and the Max Size of segments. It is used as a default value of :ref:`1D Meshing Hypotheses <a1d_meshing_hypo_page>` defining length of segments, especially by :ref:`Max Size <max_length_anchor>` hypothesis.
.. _nb_segments_pref:
Default Number of Segments
==========================
* **Default Number of Segments** - defines the default number of segments in :ref:`number_of_segments_anchor` hypothesis.
* **Default Number of Segments** - defines the default number of segments in :ref:`Number of Segments <number_of_segments_anchor>` hypothesis.
* **Mesh loading**
* **No mesh loading from study file at hypothesis modification** - if activated, 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.
* **No mesh loading from study file at hypothesis modification** - if activated, 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.
* **Input fields precision** - allows to adjust input precision of different parameters. The semantics of the precision values is described in detail in **Using input widgets** chapter of GUI documentation (Introduction to Salome Platform / Introduction to GUI / Using input widgets). In brief: **positive** precision value is the maximum allowed number of digits after the decimal point in the fixed-point format; **negative** precision value is the maximum allowed number of significant digits in mantissa in either the fixed-point or scientific format.
* **Length precision** - allows to adjust input precision of coordinates and dimensions.
* **Angular precision** - allows to adjust input precision of angles.
* **Length tolerance precision** - allows to adjust input precision of tolerance of coordinates and dimensions.
* **Parametric precision** - allows to adjust input precision of parametric values.
* **Area precision** - allows to adjust input precision of mesh element area.
* **Volume precision** - allows to adjust input precision of mesh element volume.
* **Length precision** - allows to adjust input precision of coordinates and dimensions.
* **Angular precision** - allows to adjust input precision of angles.
* **Length tolerance precision** - allows to adjust input precision of tolerance of coordinates and dimensions.
* **Parametric precision** - allows to adjust input precision of parametric values.
* **Area precision** - allows to adjust input precision of mesh element area.
* **Volume precision** - allows to adjust input precision of mesh element volume.
* **Preview**
* **Sub-shapes preview chunk size** - allows to limit the number of previewed sub-shapes shown in the hypotheses creation dialog boxes, for example "Reverse Edges" parameter of :ref:`number_of_segments_anchor` hypothesis.
.. _chunk_size_pref:
* **Sub-shapes preview chunk size** - allows to limit the number of previewed sub-shapes shown in the hypotheses creation dialog boxes, for example "Reverse Edges" parameter of :ref:`Number of Segments <number_of_segments_anchor>` hypothesis.
* **Python Dump**
* **Historical python dump** - allows switching between *Historical* and *Snapshot* dump mode:
* In *Historical* mode, Python Dump script includes all commands performed by SMESH engine.
* In *Snapshot* mode, the commands relating to objects removed from the Study as well as the commands not influencing the current state of meshes are excluded from the script.
* **Historical python dump** - allows switching between *Historical* and *Snapshot* dump mode:
* In *Historical* mode, Python Dump script includes all commands performed by SMESH engine.
* In *Snapshot* mode, the commands relating to objects removed from the Study as well as the commands not influencing the current state of meshes are excluded from the script.
.. _mesh_tab_preferences:
@ -161,40 +130,45 @@ Mesh Preferences
.. image:: ../images/pref22.png
:align: center
* **Nodes** - allows to define default parameters for nodes, which will be applied for a newly created mesh only. Existing meshes can be customized using :ref:`colors_size_page` available from the context menu of a mesh.
* **Color** - allows to select the color of nodes. Click on the downward arrow near the colored line to access to the **Select Color** dialog box.
* **Type of marker** - allows to define the shape of nodes.
* **Scale of marker** - allows to define the size of nodes.
* **Nodes** - allows to define default parameters for nodes, which will be applied for a newly created mesh only. Existing meshes can be customized using :ref:`Properties dialog box <colors_size_page>` available from the context menu of a mesh.
* **Elements** - allows to define default parameters for different elements, which will be applied to a newly created mesh only. Existing meshes can be customized using :ref:`colors_size_page` available from the context menu of a mesh.
* **Surface color** - allows to select the surface color of 2D elements (seen in Shading mode). Click on the downward arrow near the colored line to access to the **Select Color** dialog box.
* **Back surface color** - allows to select the back surface color of 2D elements. This is useful to differ 2d elements with reversed orientation. Use the slider to select the color generated basing on the **Surface color** by changing its brightness and saturation.
* **Volume color** - allows to select the surface color of 3D elements (seen in Shading mode).
* **Reversed volume color** - allows to select the surface color of reversed 3D elements. Use the slider to select the color generated basing on the **Volume color** by changing its brightness and saturation.
* **0D element color** - allows to choose color of 0D mesh elements.
* **Ball color** - allows to choose color of discrete mesh elements (balls).
* **Outline color** - allows to select the color of element borders.
* **Wireframe color** - allows to select the color of borders of elements in the wireframe mode.
* **Preview color** - allows to select the preview color of the elements, which is used while :ref:`adding_nodes_and_elements_page`.
* **Size of 0D elements** - specifies default size of 0D elements.
* **Size of ball elements** - specifies default size of discrete elements (balls).
* **Scale factor of ball elements** - specifies default scale factor of discrete elements (balls) allowing to adjust their size in the Viewer.
* **Line width** - allows to define the width of 1D elements (segments).
* **Outline width** - allows to define the width of borders of 2D and 3D elements (shown in the Shading mode).
* **Shrink coef.** - allows to define relative size of a shrunk element compared a non-shrunk element in percents in the shrink mode.
* **Color** - allows to select the color of nodes. Click on the downward arrow near the colored line to access to the **Select Color** dialog box.
* **Type of marker** - allows to define the shape of nodes.
* **Scale of marker** - allows to define the size of nodes.
* **Elements** - allows to define default parameters for different elements, which will be applied to a newly created mesh only. Existing meshes can be customized using :ref:`Properties dialog box <colors_size_page>` available from the context menu of a mesh.
* **Surface color** - allows to select the surface color of 2D elements (seen in Shading mode). Click on the downward arrow near the colored line to access to the **Select Color** dialog box.
* **Back surface color** - allows to select the back surface color of 2D elements. This is useful to differ 2d elements with reversed orientation. Use the slider to select the color generated basing on the **Surface color** by changing its brightness and saturation.
* **Volume color** - allows to select the surface color of 3D elements (seen in Shading mode).
* **Reversed volume color** - allows to select the surface color of reversed 3D elements. Use the slider to select the color generated basing on the **Volume color** by changing its brightness and saturation.
* **0D element color** - allows to choose color of 0D mesh elements.
* **Ball color** - allows to choose color of discrete mesh elements (balls).
* **Outline color** - allows to select the color of element borders.
* **Wireframe color** - allows to select the color of borders of elements in the wireframe mode.
* **Preview color** - allows to select the preview color of the elements, which is used while :ref:`manual creation of elements <adding_nodes_and_elements_page>`.
* **Size of 0D elements** - specifies default size of 0D elements.
* **Size of ball elements** - specifies default size of discrete elements (balls).
* **Scale factor of ball elements** - specifies default scale factor of discrete elements (balls) allowing to adjust their size in the Viewer.
* **Line width** - allows to define the width of 1D elements (segments).
* **Outline width** - allows to define the width of borders of 2D and 3D elements (shown in the Shading mode).
* **Shrink coef.** - allows to define relative size of a shrunk element compared a non-shrunk element in percents in the shrink mode.
* **Groups**
* **Names color** - specifies color of group names to be used in the 3D viewer.
* **Default color** - specifies the default group color, which is used to create a new mesh group (see :ref:`creating_groups_page`).
* **Names color** - specifies color of group names to be used in the 3D viewer.
* **Default color** - specifies the default group color, which is used to create a new mesh group (see :ref:`Create Group dialog box <creating_groups_page>`).
* **Numbering** allows to define properties of numbering functionality:
* **Nodes** - specifies text properties of nodes numbering (font family, size, attributes, color).
* **Elements** - same for elements.
* **Orientation of Faces** - allows to define default properties of orientation vectors. These preferences will be applied to the newly created meshes only; properties of existing meshes can be customized using :ref:`colors_size_page` available from the context menu of a mesh.
* **Color** - allows to define the color of orientation vectors;
* **Scale** - allows to define the size of orientation vectors;
* **3D Vector** - allows to choose between 2D planar and 3D vectors.
* **Nodes** - specifies text properties of nodes numbering (font family, size, attributes, color).
* **Elements** - same for elements.
* **Orientation of Faces** - allows to define default properties of orientation vectors. These preferences will be applied to the newly created meshes only; properties of existing meshes can be customized using :ref:`Properties dialog box <colors_size_page>` available from the context menu of a mesh.
* **Color** - allows to define the color of orientation vectors;
* **Scale** - allows to define the size of orientation vectors;
* **3D Vector** - allows to choose between 2D planar and 3D vectors.
Selection Preferences
#####################
@ -203,11 +177,13 @@ Selection Preferences
:align: center
* **Selection** - performed with mouse-indexing (preselection) and left-clicking on an object, whose appearance changes as defined in the **Preferences**.
* **Object color** - allows to select the color of mesh (edges and borders of meshes) of the selected entity. Click on the colored line to access to the **Select Color** dialog box.
* **Element color** - allows to select the color of surface of selected elements (seen in Shading mode). Click on the colored line to access to the **Select Color** dialog box.
* **Object color** - allows to select the color of mesh (edges and borders of meshes) of the selected entity. Click on the colored line to access to the **Select Color** dialog box.
* **Element color** - allows to select the color of surface of selected elements (seen in Shading mode). Click on the colored line to access to the **Select Color** dialog box.
* **Preselection** - performed with mouse-indexing on an object, whose appearance changes as defined in the **Preferences**.
* **Highlight color** - allows to select the color of mesh (edges and borders of meshes) of the entity. Click on the colored line to access to the **Select Color** dialog box.
* **Highlight color** - allows to select the color of mesh (edges and borders of meshes) of the entity. Click on the colored line to access to the **Select Color** dialog box.
* **Precision** - in this menu you can set the value of precision used for **Nodes**, **Elements** and **Objects**.
@ -218,7 +194,7 @@ Scalar Bar Preferences
:align: center
.. note::
The following settings are default and will be applied to a newly created mesh only. Existing meshes can be customized using local :ref:`scalar_bar_dlg` available from the context menu of a mesh.
The following settings are default and will be applied to a newly created mesh only. Existing meshes can be customized using local :ref:`Scalar Bar Properties dialog box <scalar_bar_dlg>` available from the context menu of a mesh.
* **Font** - in this menu you can set type, face and color of the font of **Title** and **Labels**.

17
doc/salome/gui/SMESH/input/mesh_through_point.rst
View File

@ -5,33 +5,34 @@ Moving nodes
************
In mesh you can define a node at a certain point either
* by movement of the node closest to the point or
* by movement of a selected node to the point.
**To displace a node:**
*To displace a node:*
#. From the **Modification** menu choose the **Move node** item or click **"Move Node"** button in the toolbar.
#. From the **Modification** menu choose the **Move node** item or click *"Move Node"* button in the toolbar.
.. image:: ../images/image67.png
:align: center
.. centered::
**"Move Node" button**
*"Move Node"* button
The following dialog will appear:
The following dialog will appear:
.. image:: ../images/meshtopass1.png
:align: center
.. centered::
"Manual node selection"
Manual node selection
.. image:: ../images/meshtopass2.png
:align: center
.. centered::
"Automatic node selection"
Automatic node selection
@ -45,13 +46,13 @@ In mesh you can define a node at a certain point either
:align: center
.. centered::
"The initial mesh"
The initial mesh
.. image:: ../images/moving_nodes2.png
:align: center
.. centered::
"The modified mesh"
The modified mesh
**See Also** a sample TUI Script of a :ref:`tui_moving_nodes` operation.

16
doc/salome/gui/SMESH/input/minimum_angle.rst
View File

@ -6,21 +6,17 @@ Minimum angle
**Minimum angle** mesh quality criterion consists of calculation of the minimum value of angle between two adjacent sides of a 2D meshing element (triangle or quadrangle).
**To apply the Minimum angle quality criterion to your mesh:**
*To apply the Minimum angle quality criterion to your mesh:*
.. |img| image:: ../images/image38.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Minimum angle** or click **"Minimum Angle"** button.
#. Choose **Controls > Face Controls > Minimum angle** or click *"Minimum Angle"* button |img|.
.. image:: ../images/image38.png
:align: center
.. centered::
**"Minimum Angle" button**
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/image92.jpg
:align: center
**See Also** a sample TUI Script of a :ref:`tui_minimum_angle` operation.
**See Also** a sample TUI Script of a :ref:`tui_minimum_angle` filter.

117
doc/salome/gui/SMESH/input/modifying_meshes.rst
View File

@ -6,75 +6,76 @@ Modifying meshes
Salome provides a vast specter of mesh modification and transformation operations, giving the possibility to:
* :ref:`adding_nodes_and_elements_page` mesh elements from nodes to polyhedrons at an arbitrary place in the mesh.
* :ref:`adding_quadratic_elements_page` mesh elements from quadratic segments to quadratic hexahedrons at an arbitrary place in the mesh.
* :ref:`removing_nodes_and_elements_page` any existin" mesh elements and nodes.
* :ref:`translation_page` in the indicated direction the mesh or some of its elements.
* :ref:`rotation_page` by the indicated axis and angle the mesh or some of its elements.
* :ref:`scale_page` the mesh or some of its elements.
* :ref:`symmetry_page` the mesh through a point, a vector or a plane of symmetry.
* :ref:`Add <adding_nodes_and_elements_page>` mesh elements from nodes to polyhedrons at an arbitrary place in the mesh.
* :ref:`Add quadratic <adding_quadratic_elements_page>` mesh elements from quadratic segments to quadratic hexahedrons at an arbitrary place in the mesh.
* :ref:`Remove <removing_nodes_and_elements_page>` any existin" mesh elements and nodes.
* :ref:`Translate <translation_page>` in the indicated direction the mesh or some of its elements.
* :ref:`Rotate <rotation_page>` by the indicated axis and angle the mesh or some of its elements.
* :ref:`Scale <scale_page>` the mesh or some of its elements.
* :ref:`Mirror <symmetry_page>` the mesh through a point, a vector or a plane of symmetry.
* :ref:`double_nodes_page`. Duplication of nodes can be useful to emulate a crack in the model.
* Unite meshes by :ref:`sewing_meshes_page` free borders, border to side or side elements.
* :ref:`merging_nodes_page`, coincident within the indicated tolerance.
* :ref:`merging_elements_page` based on the same nodes.
* :ref:`mesh_through_point_page` to an arbitrary location with consequent transformation of all adjacent elements.
* :ref:`diagonal_inversion_of_elements_page` between neighboring triangles.
* :ref:`uniting_two_triangles_page`.
* :ref:`uniting_set_of_triangles_page`.
* :ref:`changing_orientation_of_elements_page` of the selected elements.
* :ref:`reorient_faces_page` by several means.
* :ref:`cutting_quadrangles_page` into two triangles.
* :ref:`split_to_tetra_page` volumic elements into tetrahedra or prisms.
* :ref:`split_biquad_to_linear_page` elements into linear ones without creation of additional nodes.
* :ref:`smoothing_page` elements, reducung distortions in them by adjusting the locations of nodes.
* Create an :ref:`extrusion_page` along a vector or by normal to a discretized surface.
* Create an :ref:`extrusion_along_path_page`.
* Create elements by :ref:`revolution_page` of the selected nodes and elements.
* Apply :ref:`pattern_mapping_page`.
* :ref:`convert_to_from_quadratic_mesh_page`, or vice versa.
* :ref:`make_2dmesh_from_3d_page`.
* Unite meshes by :ref:`sewing <sewing_meshes_page>` free borders, border to side or side elements.
* :ref:`Merge Nodes<merging_nodes_page>` coincident within the indicated tolerance.
* :ref:`Merge Elements <merging_elements_page>` based on the same nodes.
* :ref:`Move Nodes <mesh_through_point_page>` to an arbitrary location with consequent transformation of all adjacent elements.
* :ref:`Invert an edge <diagonal_inversion_of_elements_page>` between neighboring triangles.
* :ref:`Unite two triangles <uniting_two_triangles_page>`.
* :ref:`Unite several adjacent triangles <uniting_set_of_triangles_page>`.
* :ref:`Change orientation <changing_orientation_of_elements_page>` of the selected elements.
* :ref:`Orient faces <reorient_faces_page>` by several means.
* :ref:`Cut a quadrangle <cutting_quadrangles_page>` into two triangles.
* :ref:`Split <split_to_tetra_page>` volumic elements into tetrahedra or prisms.
* :ref:`Split bi-quadratic <split_biquad_to_linear_page>` elements into linear ones without creation of additional nodes.
* :ref:`Smooth <smoothing_page>` elements, reducung distortions in them by adjusting the locations of nodes.
* Create an :ref:`extrusion <extrusion_page>` along a vector or by normal to a discretized surface.
* Create an :ref:`extrusion along a path <extrusion_along_path_page>`.
* Create elements by :ref:`revolution <revolution_page>` of the selected nodes and elements.
* Apply :ref:`pattern mapping <pattern_mapping_page>`.
* :ref:`Convert linear mesh to quadratic <convert_to_from_quadratic_mesh_page>`, or vice versa.
* :ref:`Generate boundary elements <make_2dmesh_from_3d_page>`.
* :ref:`generate_flat_elements_page`.
* :ref:`cut_mesh_by_plane_page`.
.. note::
It is possible to :ref:`edit_anchor` of a lower dimension before generation of the mesh of a higher dimension.
It is possible to :ref:`modify the mesh <edit_anchor>` of a lower dimension before generation of the mesh of a higher dimension.
.. note::
It is possible to use the variables defined in the SALOME **NoteBook** to specify the numerical parameters used for modification of any object.
**Table of Contents**
.. toctree::
:maxdepth: 2
:titlesonly:
adding_nodes_and_elements.rst
adding_quadratic_elements.rst
removing_nodes_and_elements.rst
translation.rst
rotation.rst
scale.rst
symmetry.rst
double_nodes_page.rst
sewing_meshes.rst
merging_nodes.rst
merging_elements.rst
mesh_through_point.rst
diagonal_inversion_of_elements.rst
uniting_two_triangles.rst
uniting_set_of_triangles.rst
changing_orientation_of_elements.rst
reorient_faces.rst
cutting_quadrangles.rst
split_to_tetra.rst
split_biquad_to_linear.rst
smoothing.rst
extrusion.rst
extrusion_along_path.rst
revolution.rst
pattern_mapping.rst
convert_to_from_quadratic_mesh.rst
make_2dmesh_from_3d.rst
generate_flat_elements.rst
cut_mesh_by_plane.rst
adding_nodes_and_elements.rst
adding_quadratic_elements.rst
removing_nodes_and_elements.rst
translation.rst
rotation.rst
scale.rst
symmetry.rst
double_nodes_page.rst
sewing_meshes.rst
merging_nodes.rst
merging_elements.rst
mesh_through_point.rst
diagonal_inversion_of_elements.rst
uniting_two_triangles.rst
uniting_set_of_triangles.rst
changing_orientation_of_elements.rst
reorient_faces.rst
cutting_quadrangles.rst
split_to_tetra.rst
split_biquad_to_linear.rst
smoothing.rst
extrusion.rst
extrusion_along_path.rst
revolution.rst
pattern_mapping.rst
convert_to_from_quadratic_mesh.rst
make_2dmesh_from_3d.rst
generate_flat_elements.rst
cut_mesh_by_plane.rst

1344
doc/salome/gui/SMESH/input/modules.rst
View File

File diff suppressed because it is too large Load Diff

11
doc/salome/gui/SMESH/input/numbering.rst
View File

@ -9,7 +9,7 @@ Displaying node numbers
In MESH you can display the ID numbers of all nodes of your mesh in the viewer.
**To display ID numbers of nodes:**
*To display ID numbers of nodes:*
#. Display your mesh in the viewer
#. Right-click on the mesh in the 3D viewer and from the associated pop-up menu choose **Numbering > Display Nodes #**.
@ -18,7 +18,7 @@ In MESH you can display the ID numbers of all nodes of your mesh in the viewer.
:align: center
.. centered::
"Displayed node numbers"
Displayed node numbers
Displaying element numbers
@ -26,7 +26,7 @@ Displaying element numbers
In MESH you can display the ID numbers of all meshing elements composing your mesh in the viewer.
**To display ID numbers of elements:**
*To display ID numbers of elements:*
#. Display your mesh in the viewer
#. Right-click on the mesh in the 3D viewer and from the associated pop-up menu choose **Numbering > Display Elements #**.
@ -35,7 +35,4 @@ In MESH you can display the ID numbers of all meshing elements composing your me
:align: center
.. centered::
"Displayed element numbers"
Displayed element numbers

2
doc/salome/gui/SMESH/input/over_constrained_faces.rst
View File

@ -15,7 +15,7 @@ the free border of the 2D mesh are highlighted.
:align: center
.. centered::
In this picture the over-constrained face is displayed in red.
Over-constrained face is displayed in red
**See Also** a sample TUI Script of a :ref:`tui_over_constrained_faces` filter.

4
doc/salome/gui/SMESH/input/over_constrained_volumes.rst
View File

@ -14,8 +14,6 @@ In other words, the volumes having all their nodes on the external border of the
:align: center
.. centered::
In this picture the over-constrained volume is displayed in red.
Over-constrained volume is displayed in red.
**See Also** a sample TUI Script of a :ref:`tui_over_constrained_volumes` filter.

11
doc/salome/gui/SMESH/input/pattern_mapping.rst
View File

@ -85,16 +85,13 @@ The image below provides a preview of the above pattern:
Application of pattern mapping
##############################
**To apply pattern mapping to a geometrical object or mesh elements:**
*To apply pattern mapping to a geometrical object or mesh elements:*
.. |img| image:: ../images/image98.png
From the **Modification** menu choose the **Pattern Mapping** item or click
**"Pattern mapping"** button in the toolbar.
*"Pattern mapping"* button |img| in the toolbar.
.. image:: ../images/image98.png
:align: center
.. centered::
**"Pattern mapping" button**
The following dialog box will appear:

13
doc/salome/gui/SMESH/input/point_marker.rst
View File

@ -8,7 +8,8 @@ You can change the representation of points in
the 3D viewer either by selecting one of the predefined
shapes or by loading a custom texture from an external file.
- Standard point markers
Standard point markers
----------------------
The Mesh module provides a set of predefined point marker shapes
which can be used to display points in the 3D viewer.
@ -23,9 +24,10 @@ form) and scale factor (defines shape size).
:align: center
.. centered::
"Mesh presentation with standard point markers"
Mesh presentation with standard point markers
- Custom point markers
Custom point markers
--------------------
It is also possible to load a point marker shape from an external file.
This file should provide a description of the point texture as a set
@ -57,7 +59,4 @@ Here is a texture file sample:
:align: center
.. centered::
"Mesh presentation with custom point markers"
Mesh presentation with custom point markers

26
doc/salome/gui/SMESH/input/prism_3d_algo.rst
View File

@ -12,7 +12,7 @@ edges. These two faces should be connected by quadrangle "side" faces.
:align: center
.. centered::
"Clipping view of a mesh of a prism with non-planar base and top faces"
Clipping view of a mesh of a prism with non-planar base and top faces
The prism is allowed to have sides composed of several faces. (A prism
side is a row of faces (or one face) connecting the corresponding edges of
@ -24,7 +24,7 @@ picture below.
:align: center
.. centered::
"A suitable and an unsuitable prism"
A suitable and an unsuitable prism
In this picture, the left prism is suitable for meshing with 3D
extrusion algorithm: it has six sides, two of which are split
@ -36,17 +36,19 @@ The algorithm can propagate 2D mesh not only between horizontal
(i.e. base and top) faces of one prism but also between faces of prisms
organized in a stack and between stacks sharing prism sides.
.. _prism_stacks:
.. image:: ../images/prism_stack.png
:align: center
.. centered::
"Prism stacks"
Prism stacks
This picture shows four neighboring prism stacks, each comprising two prisms.
The shown sub-mesh is used by the algorithm to mesh
all eight prisms in the stacks.
To use **Extrusion 3D** algorithm you need to assign algorithms
To use *Extrusion 3D* algorithm you need to assign algorithms
and hypotheses of lower dimensions as follows.
(A sample picture below shows algorithms and hypotheses used to
mesh a cylinder with prismatic volumes).
@ -63,20 +65,19 @@ The **Global** algorithms and hypotheses to be chosen at
The **Local** algorithms and hypotheses to be chosen at
:ref:`constructing_submeshes_page` are:
* 1D and 2D algorithms and hypotheses that will be applied for meshing the top and the base prism :ref:`submesh_shape_section`. These faces can be meshed with any type of 2D elements: quadrangles, triangles, polygons or their mix. It is enough to define a sub-mesh on either the top or the base face. In the sample picture above, "NETGEN_1D2D" algorithm meshes "bottom disk" face with triangles. (1D algorithm is not assigned as "NETGEN_1D2D" does not require divided edges to create a 2D mesh.)
* 1D and 2D algorithms and hypotheses that will be applied for meshing the top and the base prism :ref:`faces <submesh_shape_section>`. These faces can be meshed with any type of 2D elements: quadrangles, triangles, polygons or their mix. It is enough to define a sub-mesh on either the top or the base face. In the sample picture above, "NETGEN_1D2D" algorithm meshes "bottom disk" face with triangles. (1D algorithm is not assigned as "NETGEN_1D2D" does not require divided edges to create a 2D mesh.)
* Optionally you can define a 1D sub-mesh on some vertical :ref:`submesh_shape_section` of stacked prisms, which will override the global 1D hypothesis mentioned above. In the **Prism stacks** picture, the vertical division is not equidistant on the whole length because a "Number Of Segments" hypothesis with Scale Factor=3 is assigned to the highlighted edge.
* Optionally you can define a 1D sub-mesh on some vertical :ref:`edges <submesh_shape_section>` of stacked prisms, which will override the global 1D hypothesis mentioned above. In the :ref:`Prism stacks <prism_stacks>` picture, the vertical division is not equidistant on the whole length because a "Number Of Segments" hypothesis with Scale Factor=3 is assigned to the highlighted edge.
If **Extrusion 3D** algorithm is assigned to a sub-mesh in a mesh
If *Extrusion 3D* algorithm is assigned to a sub-mesh in a mesh
with multiple sub-meshes, the described above approach may not work as
expected. For example the bottom face may be meshed by other algorithm
before **Extrusion 3D** have a chance to project a mesh from the
before *Extrusion 3D* have a chance to project a mesh from the
base face. This thing can happen with vertical edges as well. All
these can lead to either a meshing failure or to an incorrect meshing.
In such a case, it's necessary to explicitly define algorithms
that **Extrusion 3D** implicitly applies in a simple case:
that *Extrusion 3D* implicitly applies in a simple case:
* assign :ref:`projection_1D2D` algorithm to the top face and
* assign a 1D algorithm to a group of all vertical edges.
@ -85,9 +86,8 @@ that **Extrusion 3D** implicitly applies in a simple case:
:align: center
.. centered::
"Prism with Extrusion 3D meshing. Vertical division is different on neighbor edges because several local 1D hypotheses are assigned."
Prism with Extrusion 3D meshing. Vertical division is different on neighbor edges because several local 1D hypotheses are assigned
**See Also** a sample TUI Script of
:ref:`tui_prism_3d_algo`.
**See Also** a sample TUI Script of :ref:`tui_prism_3d_algo`.

6
doc/salome/gui/SMESH/input/projection_algos.rst
View File

@ -30,7 +30,7 @@ by the projection of another already meshed edge (or group of edges).
To apply this algorithm select the edge to be meshed (indicated in
the field **Geometry** of **Create mesh** dialog box),
**Projection1D** in the list of 1D algorithms and click the
**"Add Hypothesis"** button.
*"Add Hypothesis"* button.
The following dialog box will appear:
.. image:: ../images/projection_1d.png
@ -41,7 +41,7 @@ In this dialog you can define
* the **Name** of the algorithm,
* the already meshed **Source Edge** and
* the **Source Mesh** (It can be omitted only when projecting a sub-mesh on another one of the same Mesh).
* It could also be necessary to define the orientation of edges, which is done by indicating the **Source Vertex** being the first point of the **Source Edge **and the **Target Vertex** being the first point of the edge being meshed.
* It could also be necessary to define the orientation of edges, which is done by indicating the **Source Vertex** being the first point of the **Source Edge** and the **Target Vertex** being the first point of the edge being meshed.
For a group of edges, **Source** and **Target** vertices should be
@ -64,7 +64,7 @@ segments as corresponding edges of the source face.
To apply this algorithm select the face to be meshed (indicated in the
field **Geometry** of **Create mesh** dialog box), **Projection
2D** in the list of 2D algorithms and click the **"Add Hypothesis"** button. The following dialog box will appear:
2D** in the list of 2D algorithms and click the *"Add Hypothesis"* button. The following dialog box will appear:
.. image:: ../images/projection_2d.png
:align: center

24
doc/salome/gui/SMESH/input/python_api.rst
View File

@ -1,24 +0,0 @@
=====================
Mesh Python interface
=====================
smeshstudytools module
======================
.. automodule:: smeshstudytools
:members:
StdMeshersBuilder module
========================
.. automodule:: StdMeshersBuilder
:members:
smeshBuilder module
===================
.. automodule:: smeshBuilder
:members:
smesh_algorithm module
======================
.. automodule:: smesh_algorithm
:members:

9
doc/salome/gui/SMESH/input/quad_from_ma_algo.rst
View File

@ -10,14 +10,14 @@ difficult to define 1D hypotheses such that to obtain a good shape of
resulting quadrangles. The algorithm can be also applied to faces with ring
topology, which can be viewed as a closed 'channel'. In the latter
case radial discretization of a ring can be specified by
using **Number of Layers** or **Distribution of Layers**
using *Number of Layers* or *Distribution of Layers*
hypothesis.
.. image:: ../images/quad_from_ma_mesh.png
:align: center
.. centered::
"A mesh of a river model to the left and of a ring-face to the right"
A mesh of a river model to the left and of a ring-face to the right
The algorithm provides proper shape of quadrangles by constructing Medial
Axis between sinuous borders of the face and using it to
@ -28,7 +28,7 @@ locations where opposite sides of a 'channel' are far from being parallel.)
:align: center
.. centered::
"Medial Axis between two blue sinuous borders"
Medial Axis between two blue sinuous borders
The Medial Axis is used in two ways:
@ -39,5 +39,4 @@ The Medial Axis is used in two ways:
:align: center
.. centered::
"Mesh depends on defined sub-meshes: to the left - sub-meshes on both wires, to the right - a sub-mesh on internal wire only"
Mesh depends on defined sub-meshes: to the left - sub-meshes on both wires, to the right - a sub-mesh on internal wire only

10
doc/salome/gui/SMESH/input/quad_ijk_algo.rst
View File

@ -20,7 +20,7 @@ validity depend on two factors:
.. centered::
"Invalid mesh on quadrilateral concave faces"
The algorithm uses **Transfinite Interpolation** technique in the
The algorithm uses *Transfinite Interpolation* technique in the
parametric space of a face to locate nodes inside the face.
The algorithm treats any face as quadrangle. If a face is bound by
@ -34,7 +34,7 @@ quadrangle.
:align: center
.. centered::
"Algorithm generates a structured mesh on complex faces provided that edges are properly discretized"
Algorithm generates a structured mesh on complex faces provided that edges are properly discretized
To get an all-quadrangle mesh you have to carefully define 1D
hypotheses on edges of a face. To get a **structured** mesh you have to provide
@ -51,7 +51,5 @@ of segments on one pair of opposite sides.
The following hypotheses help to create quadrangle meshes.
* :ref:`propagation_anchor` additional 1D hypotheses help to get an equal number of segments on the opposite sides of a quadrilateral face.
* :ref:`a1d_algos_anchor` algorithm is useful to discretize several C1 continuous edges as one quadrangle side.
* :ref:`Propagation <propagation_anchor>` additional 1D hypotheses help to get an equal number of segments on the opposite sides of a quadrilateral face.
* :ref:`Composite Side Discretization <a1d_algos_anchor>` algorithm is useful to discretize several C1 continuous edges as one quadrangle side.

15
doc/salome/gui/SMESH/input/radial_prism_algo.rst
View File

@ -7,7 +7,7 @@ Radial Prism
This algorithm applies to the meshing of a hollow 3D shape,
i.e. such shape should be composed of two meshed shells: an outer
shell and an internal shell without intersection with the outer
shell. One of the shells should be a 2D Projection of the other
shell. One of the shells should be a :ref:`2D Projection <projection_2D>` of the other
shell. The meshes of the shells can consist both of triangles and
quadrangles.
@ -18,17 +18,26 @@ with prisms.
:align: center
.. centered::
"Cut-view of a hollow sphere meshed by Radial Prism algorithm"
Cut-view of a hollow sphere meshed by Radial Prism algorithm
This algorithm also needs the information concerning the number and
distribution of mesh layers between the inner and the outer shapes.
This information can be defined using either of two hypotheses:
.. image:: ../images/number_of_layers.png
:align: center
Distribution of layers can be set with any of 1D Hypotheses.
.. centered::
*"Number of layers"* hypothesis
.. image:: ../images/distribution_of_layers.png
:align: center
.. centered::
*"Distribution of layers"* hypothesis
*Distribution of layers* hypothesis allows using any of
:ref:`1D Hypotheses <a1d_meshing_hypo_page>` to define
the distribution of mesh layers.
**See also** a sample :ref:`TUI script <tui_radial_prism>`.

8
doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.rst
View File

@ -24,7 +24,7 @@ If no own hypothesis of the algorithm is assigned, any local or global
hypothesis is used by the algorithm to discretize edges.
If no 1D hypothesis is assigned to an edge,
:ref:`nb_segments_pref` preferences
:ref:`Default Number of Segments <nb_segments_pref>` preferences
parameter is used to discretize the edge.
.. image:: ../images/hypo_radquad_dlg.png
@ -34,14 +34,14 @@ parameter is used to discretize the edge.
:align: center
.. centered::
"Radial Quadrangle 2D mesh on the top and the bottom faces of a cylinder"
Radial Quadrangle 2D mesh on the top and the bottom faces of a cylinder
.. image:: ../images/mesh_radquad_02.png
:align: center
.. centered::
"Radial Quadrangle 2D mesh on a part of circle"
Radial Quadrangle 2D mesh on a part of circle
**See also** A sample :ref:`tui_radial_quadrangle`.
**See also** a sample :ref:`TUI Script <tui_radial_quadrangle>`.

86
doc/salome/gui/SMESH/input/removing_nodes_and_elements.rst
View File

@ -20,28 +20,23 @@ Removing nodes
**To remove a node:**
.. |rmn| image:: ../images/remove_nodes_icon.png
#. Select your mesh in the Object Browser or in the 3D viewer.
#. From the **Modification** menu choose **Remove** and from the associated submenu select the **Nodes**, or just click **"Remove nodes"** button in the toolbar.
.. image:: ../images/remove_nodes_icon.png
:align: center
.. centered::
**"Remove nodes" button**
The following dialog box will appear:
#. From the **Modification** menu choose **Remove** and from the associated submenu select the **Nodes**, or just click *"Remove nodes"* button |rmn| in the toolbar.
The following dialog box will appear:
.. image:: ../images/removenodes.png
:align: center
In this dialog box you can specify one or several nodes:
#. choose mesh nodes with the mouse in the 3D Viewer. It is possible to select a whole area with a mouse frame; or
#. input the node IDs directly in **ID Elements** field. The selected nodes will be highlighted in the viewer; or
#. apply Filters. **Set filter** button allows to apply a filter to the selection of nodes. See more about filters in the :ref:`selection_filter_library_page` page.
In this dialog box you can specify one or several nodes:
* choose mesh nodes with the mouse in the 3D Viewer. It is possible to select a whole area with a mouse frame; or
* input the node IDs directly in **ID Elements** field. The selected nodes will be highlighted in the viewer; or
* apply Filters. **Set filter** button allows to apply a filter to the selection of nodes. See more about filters in the :ref:`selection_filter_library_page` page.
#. Click **Apply** or **Apply and Close** to confirm deletion of the specified nodes.
.. note::
Be careful while removing nodes because if you remove a definite node of your mesh all adjacent elements will be also deleted.
@ -54,24 +49,18 @@ Removing orphan nodes
There is a quick way to remove all orphan (free) nodes.
**To remove orphan nodes:**
*To remove orphan nodes:*
.. |rmon| image:: ../images/remove_orphan_nodes_icon.png
#. Select your mesh in the Object Browser or in the 3D viewer.
#. From the **Modification** menu choose **Remove** and from the associated submenu select **Orphan Nodes**, or just click **"Remove orphan nodes"** button in the toolbar.
.. image:: ../images/remove_orphan_nodes_icon.png
:align: center
.. centered::
**"Remove orphan nodes" button**
The following Warning message box will appear:
#. From the **Modification** menu choose **Remove** and from the associated submenu select **Orphan Nodes**, or just click *"Remove orphan nodes"* button |rmon| in the toolbar.
The following Warning message box will appear:
.. image:: ../images/removeorphannodes.png
:align: center
Confirm nodes removal by pressing "Yes" button.
#. Confirm nodes removal by pressing "Yes" button.
.. _removing_elements_anchor:
@ -79,40 +68,37 @@ Confirm nodes removal by pressing "Yes" button.
Removing elements
#################
**To remove an element:**
*To remove an element:*
.. |rme| image:: ../images/remove_elements_icon.png
#. Select your mesh in the Object Browser or in the 3D viewer.
#. From the **Modification** menu choose **Remove** and from the associated submenu select the **Elements**, or just click **"Remove elements"** button in the toolbar.
#. From the **Modification** menu choose **Remove** and from the associated submenu select the **Elements**, or just click *"Remove elements"* button |rme| in the toolbar.
.. image:: ../images/remove_elements_icon.png
:align: center
.. centered::
**"Remove elements" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/removeelements.png
:align: center
In this dialog box you can specify one or several elements
In this dialog box you can specify one or several elements:
* 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` page.
#. 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` page.
#. Click **Apply** or **Apply and Close** to confirm deletion of the specified elements.
.. image:: ../images/remove_nodes1.png
:align: center
.. centered::
"The initial mesh"
The initial mesh
.. image:: ../images/remove_nodes2.png
:align: center
.. centered::
"The mesh with some elements removed"
The mesh with some elements removed
.. _clear_mesh_anchor:
@ -120,21 +106,17 @@ Removing elements
Clearing Mesh Data
##################
**To remove all nodes and all types of cells in your mesh at once:**
*To remove all nodes and all types of cells in your mesh at once:*
.. |clr| image:: ../images/mesh_clear.png
#. Select your mesh in the Object Browser or in the 3D viewer.
#. From the Modification menu choose Remove and from the associated submenu select the Clear Mesh Data, or just click **"Clear Mesh Data"** button in the toolbar. You can also right-click on the mesh in the Object Browser and select Clear Mesh Data in the pop-up menu.
.. image:: ../images/mesh_clear.png
:align: center
.. centered::
**"Clear Mesh Data" button**
#. From the **Modification** menu choose **Remove** and from the associated submenu select the **Clear Mesh Data**, or just click *"Clear Mesh Data"* button |clr| in the toolbar. You can also right-click on the mesh in the Object Browser and select **Clear Mesh Data** in the pop-up menu.
.. note::
This command works in a different way in different situations:
* if the mesh is computed on a geometry, then "Clear Mesh Data" removes all elements and nodes.
* if the mesh is not based on a geometry (imported, compound, created from scratch etc.), then "Clear Mesh Data" removes only the elements and nodes computed by algorithms. If no such elements or nodes have been created, can remove nothing.
This command works in a different way in different situations:
* if the mesh is computed on a geometry, then *Clear Mesh Data* removes all elements and nodes.
* if the mesh is not based on a geometry (imported, compound, created from scratch etc.), then *Clear Mesh Data* removes only the elements and nodes computed by algorithms. If no such elements or nodes have been created, can remove nothing.
**See Also** a sample TUI Script of a :ref:`tui_removing_nodes_and_elements` operation.

32
doc/salome/gui/SMESH/input/reorient_faces.rst
View File

@ -14,21 +14,15 @@ This operation allows fixing the orientation of a set of faces in the following
The orientation of a face is changed by reverting the order of its nodes.
**To set orientation of faces:**
#. In the **Modification** menu select **Reorient faces** item or click **Reorient faces** button in the toolbar.
.. image:: ../images/reorient_faces_face.png
:align: center
.. centered::
**"Reorient faces" button**
*To set orientation of faces:*
.. |img| image:: ../images/reorient_faces_face.png
#. In the **Modification** menu select **Reorient faces** item or click *"Reorient faces"* button |img| in the toolbar.
#. In the "Reorient faces" dialog box
#. Select the **Object** (mesh, sub-mesh or group) containing faces to reorient, in the Object Browser or in the 3D Viewer.
#. To reorient by direction of the face normal:
* Select the **Object** (mesh, sub-mesh or group) containing faces to reorient, in the Object Browser or in the 3D Viewer.
* To reorient by direction of the face normal:
* Specify the coordinates of the **Point** by which the control face will be found. You can specify the **Point** by picking a node in the 3D Viewer or selecting a vertex in the Object Browser.
* Set up the **Direction** vector to be compared with the normal of the control face. There are following options:
@ -41,27 +35,27 @@ The orientation of a face is changed by reverting the order of its nodes.
:align: center
.. centered::
"The orientation of adjacent faces is chosen according to a vector. The control face is found by point."
The orientation of adjacent faces is chosen according to a vector. The control face is found by point.
* In the second mode it is possible to pick the **Face** by mouse in the 3D Viewer or directly input the **Face** ID in the corresponding field.
* In the second mode it is possible to pick the **Face** by mouse in the 3D Viewer or directly input the **Face** ID in the corresponding field.
.. image:: ../images/reorient_2d_face.png
:align: center
.. centered::
"The orientation of adjacent faces is chosen according to a vector. The control face is explicitly given."
The orientation of adjacent faces is chosen according to a vector. The control face is explicitly given.
* In the third mode, the faces can be reoriented according to volumes:
* In the third mode, the faces can be reoriented according to volumes:
* Select an object (mesh, sub-mesh or group) containing reference **Volumes**, in the Object Browser or in the 3D Viewer.
* Specify whether face normals should point outside or inside the reference volumes using **Face normal outside volume** check-box.
* Select an object (mesh, sub-mesh or group) containing reference **Volumes**, in the Object Browser or in the 3D Viewer.
* Specify whether face normals should point outside or inside the reference volumes using **Face normal outside volume** check-box.
.. image:: ../images/reorient_2d_volume.png
:align: center
.. centered::
"The orientation of faces is chosen relatively to adjacent volumes."
The orientation of faces is chosen relatively to adjacent volumes.
#. Click the **Apply** or **Apply and Close** button to confirm the operation.

29
doc/salome/gui/SMESH/input/revolution.rst
View File

@ -8,21 +8,18 @@ Revolution is used to build mesh elements of plus one
dimension than the input ones. Boundary elements around generated
mesh of plus one dimension are additionally created. All created
elements can be automatically grouped. Revolution can be used to create
a :ref:`extrusion_struct`.
a :ref:`structured mesh from scratch <extrusion_struct>`.
See :ref:`extrusion_page` page for general information on Revolution,
which can be viewed as extrusion along a circular path.
**To apply revolution:**
*To apply revolution:*
.. |img| image:: ../images/image92.png
.. |sel| image:: ../images/image120.png
#. From the **Modification** menu choose the **Revolution** item or click **"Revolution"** button in the toolbar.
.. image:: ../images/image92.png
:align: center
.. centered::
**"Revolution" button**
The following dialog will appear:
The following dialog will appear:
.. image:: ../images/revolution1.png
:align: center
@ -30,13 +27,7 @@ which can be viewed as extrusion along a circular path.
#. In this dialog:
* Use *Selection* button to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
.. image:: ../images/image120.png
:align: center
.. centered::
**"Selection" button**
* Use *Selection* button |sel| to specify what you are going to select at a given moment, **Nodes**, **Edges** or **Faces**.
* Specify **Nodes**, **Edges** and **Faces**, which will be revolved, by one of following means:
* **Select the whole mesh, sub-mesh or group** activating this check-box.
@ -56,7 +47,7 @@ which can be viewed as extrusion along a circular path.
:align: center
.. centered::
"Example of Revolution with Angle by Step. Angle=30 and Number of Steps=3"
Example of Revolution with Angle by Step. Angle=30 and Number of Steps=3
* **Total Angle** - the elements are revolved by the specified angle only once and the number of steps defines the number of iterations (i.e. for Angle=30 and Number of Steps=3, the elements will be revolved by 30/3=10 degrees twice for a total of 30).
@ -64,7 +55,7 @@ which can be viewed as extrusion along a circular path.
:align: center
.. centered::
"Example of Revolution with Total Angle. Angle=30 and Number of Steps=3"
Example of Revolution with Total Angle. Angle=30 and Number of Steps=3
@ -84,5 +75,3 @@ which can be viewed as extrusion along a circular path.
#. Click **Apply** or **Apply and Close** button to confirm the operation.
**See Also** a sample TUI Script of a :ref:`tui_revolution` operation.

17
doc/salome/gui/SMESH/input/rotation.rst
View File

@ -6,17 +6,12 @@ Rotation
This operation allows to rotate in space the mesh or some of its elements.
**To rotate the mesh:**
*To rotate the mesh:*
#. From the **Modification** menu choose **Transformation** -> **Rotation** item or click **"Rotation"** button in the toolbar.
.. |img| image:: ../images/rotation_ico.png
.. image:: ../images/rotation_ico.png
:align: center
.. centered::
"Rotation button"
The following dialog will appear:
#. From the **Modification** menu choose **Transformation** -> **Rotation** item or click *"Rotation"* button |img| in the toolbar.
The following dialog will appear:
.. image:: ../images/rotation.png
:align: center
@ -51,13 +46,13 @@ This operation allows to rotate in space the mesh or some of its elements.
:align: center
.. centered::
"The initial mesh"
The initial mesh
.. image:: ../images/rotation2.png
:align: center
.. centered::
"The rotated mesh"
The rotated mesh
**See Also** a sample TUI Script of a :ref:`tui_rotation` operation.

5
doc/salome/gui/SMESH/input/scalar_bar.rst
View File

@ -27,8 +27,3 @@ In this dialog you can specify the properties of the scalar bar
* **Distribution** - in this menu you can Show/Hide distribution histogram of the values of the **Scalar Bar** and specify histogram properties
* **Multicolor** the histogram is colored as **Scalar Bar**
* **Monocolor** the histogram is colored as selected with **Distribution color** selector

21
doc/salome/gui/SMESH/input/scale.rst
View File

@ -6,17 +6,18 @@ Scale
This geometrical operation allows to scale in space your mesh or some of its elements.
**To scale a mesh:**
*To scale a mesh:*
#. From the **Modification** menu choose **Transformation** -> **Scale Transform** item.
One of the following dialogs will appear:
With one scale factor:
The following dialogs will appear, where you can select how to scale:
* with one scale factor:
.. image:: ../images/scale01.png
:align: center
Or with different scale factors for axes:
* or with different scale factors for axes:
.. image:: ../images/scale02.png
:align: center
@ -50,7 +51,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scaleinit01.png
:align: center
and union 3 faces (along axis Z) to group "gr_faces"
and union 3 faces (along axis Z) to group "gr_faces"
.. image:: ../images/scaleinit02.png
:align: center
@ -62,7 +63,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scale03.png
:align: center
result after operation:
result after operation:
.. image:: ../images/scaleres03.png
:align: center
@ -72,7 +73,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scale04.png
:align: center
result after operation:
result after operation:
.. image:: ../images/scaleres04.png
:align: center
@ -82,7 +83,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scale06.png
:align: center
result after operation:
result after operation:
.. image:: ../images/scaleres06.png
:align: center
@ -94,7 +95,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scale07.png
:align: center
result after operation:
result after operation:
.. image:: ../images/scaleres07.png
:align: center
@ -106,7 +107,7 @@ This geometrical operation allows to scale in space your mesh or some of its ele
.. image:: ../images/scale09.png
:align: center
result after operation:
result after operation:
.. image:: ../images/scaleres09.png
:align: center

4
doc/salome/gui/SMESH/input/segments_around_vertex_algo.rst
View File

@ -11,8 +11,8 @@ vertex. If we assign this algorithm to a geometrical object of higher
dimension, it applies to all its vertices.
Length of segments near vertex is defined by **Length Near Vertex** hypothesis.
This hypothesis is used by :ref:`a1d_algos_anchor` "Wire Discretization" or
:ref:`a1d_algos_anchor` "Composite Side Discretization" algorithms as
This hypothesis is used by :ref:`Wire Discretization <a1d_algos_anchor>` or
:ref:`Composite Side Discretization <a1d_algos_anchor>` algorithms as
follows: a geometrical edge is discretized according to a 1D
hypotheses and then nodes near vertices are modified to assure the
segment length required by **Length Near Vertex** hypothesis.

56
doc/salome/gui/SMESH/input/selection_filter_library.rst
View File

@ -6,7 +6,7 @@ Selection filter library
Selection filter library allows creating and storing in files
the filters that can be later reused for operations on meshes. You can
access it from the Main Menu via **Tools / Selection filter library**.
access it via menu **Tools > Selection filter library**.
It is also possible to save/load a filter by invoking the filter library
from :ref:`filtering_elements` launched from any mesh operation.
@ -53,6 +53,7 @@ operator *Not* and you should specify logical relations between
criteria using **Binary** operators *Or* and *And*.
Some criteria have the additional parameter of **Tolerance**.
Switching on **Insert filter in viewer** check-box limits
selection of elements in the Viewer to the current filter.
@ -100,43 +101,46 @@ The following criteria are applicable to Entities of **all** types except for *V
The following criteria allow selecting mesh **Nodes**:
* **Free nodes** selects nodes not belonging to any mesh element.
* **Double nodes** selects a node coincident with other nodes (within a given **Tolerance**). See also :ref:`tui_double_nodes_control`.
* **Connectivity number** selects nodes with a number of connected elements, which is more, less or equal to the predefined **Threshold Value**. Elements of the highest dimension are countered only.
* **Double nodes** selects a node coincident with other nodes (within a given **Tolerance**). See also :ref:`Double Nodes quality control <tui_double_nodes_control>`.
* **Connectivity number** selects nodes with a number of connected elements, which is more, less or equal to **Threshold Value**. Elements of the highest dimension are countered only.
The following criteria allow selecting mesh **Edges**:
* **Free Borders** selects free 1D mesh elements, i.e. edges belonging to one element (face or volume) only. See also a :ref:`free_borders_page`.
* **Double edges** selects 1D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements` .
* **Borders at Multi-Connections** selects edges belonging to several faces. The number of faces should be more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`borders_at_multi_connection_page`.
* **Length** selects edges with a value of length, which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`length_page` .
* **Free Borders** selects free 1D mesh elements, i.e. edges belonging to one element (face or volume) only. See also a :ref:`Free Borders quality control <free_borders_page>`.
* **Double edges** selects 1D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements` quality control.
* **Borders at Multi-Connections** selects edges belonging to several faces. The number of faces should be more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`borders_at_multi_connection_page` quality control.
* **Length** selects edges with a value of length, which is more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`length_page` quality control.
The following criteria allow selecting mesh **Faces**:
* **Aspect ratio** selects 2D mesh elements with an aspect ratio (see also an :ref:`aspect_ratio_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Warping** selects quadrangles with warping angle (see also a :ref:`warping_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Minimum angle** selects triangles and quadrangles with minimum angle (see also a :ref:`minimum_angle_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Taper** selects quadrangles cells with taper value (see also a :ref:`taper_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Skew** selects triangles and quadrangles with skew value (see also a :ref:`skew_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Area** selects triangles and quadrangles with a value of area (see also an :ref:`area_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Free edges** selects 2D mesh elements having at least one edge, which is not shared with other faces. See also a :ref:`free_edges_page`.
* **Aspect ratio** selects 2D mesh elements with an aspect ratio (see also an :ref:`aspect_ratio_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Warping** selects quadrangles with warping angle (see also a :ref:`warping_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Minimum angle** selects triangles and quadrangles with minimum angle (see also a :ref:`minimum_angle_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Taper** selects quadrangles cells with taper value (see also a :ref:`taper_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Skew** selects triangles and quadrangles with skew value (see also a :ref:`skew_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Area** selects triangles and quadrangles with a value of area (see also an :ref:`area_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Free edges** selects 2D mesh elements having at least one edge, which is not shared with other faces. See also a :ref:`free_edges_page` quality control.
* **Free faces** selects 2D mesh elements, which belong to less than two volumes.
* **Double faces** selects 2D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements`.
* **Faces with bare border** selects 2D mesh elements having a free border without an edge on it. See also :ref:`bare_border_faces_page`.
* **Over-constrained faces** selects 2D mesh elements having only one border shared with other 2D elements. See also :ref:`over_constrained_faces_page`.
* **Borders at Multi-Connections 2D** selects cells consisting of edges belonging to several elements of mesh. The number of mesh elements should be more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`borders_at_multi_connection_2d_page`.
* **Length 2D** selects triangles and quadrangles combining of the edges with a value of length, which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`length_2d_page`.
* **Double faces** selects 2D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements` quality control.
* **Faces with bare border** selects 2D mesh elements having a free border without an edge on it. See also :ref:`bare_border_faces_page` quality control.
* **Over-constrained faces** selects 2D mesh elements having only one border shared with other 2D elements. See also :ref:`over_constrained_faces_page` quality control.
* **Borders at Multi-Connections 2D** selects cells consisting of edges belonging to several elements of mesh. The number of mesh elements should be more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`borders_at_multi_connection_2d_page` quality control.
* **Length 2D** selects triangles and quadrangles combining of the edges with a value of length, which is more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`length_2d_page` quality control.
* **Coplanar faces** selects mesh faces neighboring the one selected by ID in **Threshold Value** field, if the angle between the normal to the neighboring face and the normal to the selected face is less then the angular tolerance (defined in degrees). Selection continues among all neighbor faces of already selected ones.
* **Element Diameter 2D** selects triangles and quadrangles composed of the edges and diagonals with a value of length, which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`max_element_length_2d_page`.
* **Element Diameter 2D** selects triangles and quadrangles composed of the edges and diagonals with a value of length, which is more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`max_element_length_2d_page` quality control.
The following criteria allow selecting mesh **Volumes**:
* **Aspect ratio 3D** selects 3D mesh elements with an aspect ratio (see also an :ref:`aspect_ratio_3d_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Volume** selects 3D mesh elements with a value of volume (see also a :ref:`volume_page`), which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**.
* **Element Diameter 3D** selects 3D mesh elements composed of the edges and diagonals with a value of length, which is more, less or equal (within a given **Tolerance**) to the predefined **Threshold Value**. See also a :ref:`max_element_length_3d_page`.
* **Double volumes** selects 3D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements`.
* **Aspect ratio 3D** selects 3D mesh elements with an aspect ratio (see also an :ref:`aspect_ratio_3d_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Volume** selects 3D mesh elements with a value of volume (see also a :ref:`volume_page` quality control), which is more, less or equal (within a given **Tolerance**) to **Threshold Value**.
* **Element Diameter 3D** selects 3D mesh elements composed of the edges and diagonals with a value of length, which is more, less or equal (within a given **Tolerance**) to **Threshold Value**. See also a :ref:`max_element_length_3d_page` quality control.
* **Double volumes** selects 3D mesh elements basing on the same set of nodes. See also :ref:`filter_double_elements` quality control.
* **Bad oriented volume** selects mesh volumes, which are incorrectly oriented from the point of view of MED convention.
* **Over-constrained volumes** selects mesh volumes having only one facet shared with other volumes. See also :ref:`over_constrained_volumes_page`.
* **Volumes with bare border** selects 3D mesh elements having a free border without a face on it. See also :ref:`bare_border_volumes_page`.
* **Over-constrained volumes** selects mesh volumes having only one facet shared with other volumes. See also :ref:`over_constrained_volumes_page` quality control.
* **Volumes with bare border** selects 3D mesh elements having a free border without a face on it. See also :ref:`bare_border_volumes_page` quality control.
**See also** sample scripts of :ref:`tui_filters_page`.

65
doc/salome/gui/SMESH/input/sewing_meshes.rst
View File

@ -4,8 +4,7 @@
Sewing meshes
*************
In SMESH you can sew elements of a mesh. The current
functionality allows you to sew:
In SMESH you can sew elements of a mesh. The current functionality allows you to sew:
* :ref:`free_borders_anchor`
* :ref:`conform_free_borders_anchor`
@ -17,9 +16,9 @@ functionality allows you to sew:
:align: center
.. centered::
"Sewing button"
*"Sewing"* button
**To sew elements of a mesh:**
*To sew elements of a mesh:*
#. From the **Modification** menu choose the **Transformation** item and from its sub-menu select the **Sewing** item.
#. Check in the dialog box one of the radio buttons corresponding to the type of sewing operation you would like to perform.
@ -35,13 +34,14 @@ Sew free borders
This functionality allows you to unite free borders of a 2D mesh.
There are two working modes: *Automatic* and *Manual*. In the
**Automatic** mode, the program finds free borders coincident within the
specified tolerance and sews them. Optionally it is possible to
visually check and correct if necessary the found free borders before
sewing.
In the **Manual** mode you are to define borders to sew by picking
three nodes of each of two borders.
There are two working modes: *Automatic* and *Manual*.
* In the **Automatic** mode, the program finds free borders coincident within the
specified tolerance and sews them. Optionally it is possible to
visually check and correct if necessary the found free borders before
sewing.
* In the **Manual** mode you are to define borders to sew by picking
three nodes of each of two borders.
.. image:: ../images/sewing1.png
:align: center
@ -70,26 +70,25 @@ To use **Automatic** sewing:
.. image:: ../images/sort.png
:align: center
.. centered::
**Set First** button moves the selected border to the first position in the group, as a result other borders will be moved to this border during sewing.
* **Set First** button moves the selected border to the first position in the group, as a result other borders will be moved to this border during sewing.
.. image:: ../images/remove.png
:align: center
.. centered::
**Remove Border** button removes the selected borders from the group. It is active if there are more than two borders in the group.
* **Remove Border** button removes the selected borders from the group. It is active if there are more than two borders in the group.
* Selection of a border in the list allows changing its first and last nodes whose IDs appear in two fields below the list. *Arrow* buttons near each field move the corresponding end node by the number of nodes defined by **Step** field.
* Selection of a border in the list allows changing its first and last nodes whose IDs appear in two fields below the list.
* *Arrow* buttons near each field move the corresponding end node by the number of nodes defined by **Step** field.
.. image:: ../images/swap.png
:align: center
.. centered::
**Swap** button swaps the first and last nodes of a selected border.
* **Swap** button swaps the first and last nodes of a selected border.
* For sewing free borders manually you should switch the **Mode** to **Manual** and define three points on each border: the first, the second and the last node:
For sewing free borders manually you should switch the **Mode** to **Manual** and define three points on each border: the first, the second and the last node:
.. image:: ../images/sewing_manual.png
:align: center
@ -112,20 +111,20 @@ In practice the borders to sew often coincide and in this case it is
difficult to specify the first and the last nodes of a border since
they coincide with the first and the last nodes of the other
border. To cope with this,
:ref:`merging_nodes_page` coincident nodes into one
:ref:`merge <merging_nodes_page>` coincident nodes into one
beforehand. Two figures below illustrate this approach.
.. image:: ../images/sew_using_merge.png
:align: center
.. centered::
"Merge coincident nodes, which are difficult to distinguish"
Merge coincident nodes, which are difficult to distinguish
.. image:: ../images/sew_after_merge.png
:align: center
.. centered::
"After merging nodes it is easy to specify border nodes"
After merging nodes it is easy to specify border nodes
The sewing algorithm is as follows:
@ -137,7 +136,7 @@ The sewing algorithm is as follows:
:align: center
.. centered::
"Sewing free borders"
Sewing free borders
**See Also** a sample TUI Script of a
:ref:`tui_sew_free_borders` operation.
@ -153,7 +152,7 @@ This functionality can be used to unite two free borders of a 2D mesh.
.. image:: ../images/sewing2.png
:align: center
The borders of meshes for sewing are defined as for "Sew free borders"
The borders of meshes for sewing are defined as for :ref:`free_borders_anchor`
except that the second free border is not limited and can be defined
by the first and the second nodes only. The first nodes of two borders
can be the same.
@ -171,7 +170,7 @@ second border.
:align: center
.. centered::
"Sewing conform free borders"
Sewing conform free borders
**See Also** a sample TUI Script of a
:ref:`tui_sew_conform_free_borders` operation.
@ -182,11 +181,9 @@ second border.
Sew border to side
##################
"Sew border to side" is intended to sew a free border to a mesh
surface.
*Sew border to side* is intended to sew a free border to a mesh surface.
.. note::
The free border is defined as for "Sewing of free borders". The place where to sew the border is defined by two nodes, between which the border faces are placed, so that the first border node is merged with the first node on the side and the last node of the border is merged with the second specified node on the side.
The free border is defined as for :ref:`free_borders_anchor`. The place where to sew the border is defined by two nodes, between which the border faces are placed, so that the first border node is merged with the first node on the side and the last node of the border is merged with the second specified node on the side.
.. image:: ../images/sewing3.png
:align: center
@ -194,7 +191,7 @@ surface.
The algorithm is following.
#. Find a sequence of linked nodes on the side such that the found links to be most co-directed with the links of the free border.
#. Sew two sequences of nodes using algorithm of "Sewing of free berders".
#. Sew two sequences of nodes using algorithm of :ref:`free_borders_anchor`.
.. note::
For sewing border to side you should define three points on the border and two points on the side. User can select these nodes in 3D viewer or define node by its id.
@ -203,7 +200,7 @@ The algorithm is following.
:align: center
.. centered::
"Sewing border to side"
Sewing border to side
**See Also** a sample TUI Script of a
:ref:`tui_sew_meshes_border_to_side` operation.
@ -226,7 +223,7 @@ set must have a corresponding node in the other element set and
corresponding nodes must be equally linked. If there are 3d elements
in a set, only their free faces must obey to that rule.
.. note:: Two corresponding nodes on each side must be specified. They must belong to one element and must be located on an element set boundary.
Two corresponding nodes on each side must be specified. They must belong to one element and must be located on an element set boundary.
Sewing algorithm finds and merges the corresponding nodes starting
from the specified ones.
@ -235,13 +232,13 @@ from the specified ones.
:align: center
.. centered::
"Step-by-step sewing process"
Step-by-step sewing process
.. image:: ../images/image32.jpg
:align: center
.. centered::
"The result of side elements sewing"
The result of side elements sewing
For sewing side elements you should define elements for sewing and two
nodes for merging on the each side. User can select these elements and

20
doc/salome/gui/SMESH/input/skew.rst
View File

@ -13,27 +13,17 @@ criterion can be applied to elements composed of 4 and 3 nodes
.. image:: ../images/image27.jpg
:align: center
.. centered::
**To apply the Skew quality criterion to your mesh:**
*To apply the Skew quality criterion to your mesh:*
.. |img| image:: ../images/image40.png
#. Display your mesh in the viewer.
#. Choose **Controls > Face Controls > Skew** or click **"Skew"** button of the toolbar.
#. Choose **Controls > Face Controls > Skew** or click *"Skew"* button |img| of the toolbar.
.. image:: ../images/image40.png
:align: center
.. centered::
**"Skew" button**
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
Your mesh will be displayed in the viewer with its elements colored according to the applied mesh quality control criterion:
.. image:: ../images/image93.jpg
:align: center
**See Also** a sample TUI Script of a
:ref:`tui_skew` operation.
**See Also** a sample TUI Script of a :ref:`tui_skew` filter.

21
doc/salome/gui/SMESH/input/smeshBuilder.rst Normal file
View File

@ -0,0 +1,21 @@
smeshBuilder module
===================
.. contents::
.. automodule:: smeshBuilder
:synopsis:
:members: GetName, DegreesToRadians, New
smeshBuilder class
------------------
.. autoclass:: smeshBuilder
:members:
Mesh class
------------------
.. autoclass:: Mesh
:members:

71
doc/salome/gui/SMESH/input/smesh_migration.rst
View File

@ -8,97 +8,85 @@ In SALOME 7.2, the Python interface for Mesh has been slightly modified to offer
Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with full functionality.
The compatibility mode allows old scripts to work in almost all cases, but with a warning.
See also :ref:`geompy_migration_page`
* **Salome initialisation** must always be done as shown below.
**Salome initialisation must always be done as shown below**
*salome_init()* can be invoked safely several times):
::
(*salome_init()* can be invoked safely several times)::
import salome
salome.salome_init()
**smesh initialisation is modified.**
the old mode (from dump):
::
* **smesh initialisation** is modified.
The old mode (from dump)::
import smesh, SMESH, SALOMEDS
smesh.SetCurrentStudy(salome.myStudy)
the new mode:
::
The new mode::
import SMESH, SALOMEDS
from salome.smesh import smeshBuilder
smesh = smeshBuilder.New(salome.myStudy)
**Of course,** from smesh import ***is no more possible.**
* Of course, **from smesh import** * is **no more possible.**
You have to explicitely write **smesh.some_method()**.
You have to explicitely write *smesh.some_method()*.
**All algorithms have been transferred from the namespace **smesh** to the namespace **smeshBuilder**.**
* All **algorithms** have been transferred from the namespace *smesh* to the namespace *smeshBuilder*.
For instance:
::
For instance::
MEFISTO_2D_1 = Mesh_1.Triangle(algo=smesh.MEFISTO,geom=Face_1)
is replaced by:
::
is replaced by::
MEFISTO_2D_1 = Mesh_1.Triangle(algo=smeshBuilder.MEFISTO,geom=Face_1)
StdMeshers algorithms concerned are **REGULAR, PYTHON, COMPOSITE, MEFISTO, Hexa, QUADRANGLE, RADIAL_QUAD**.
StdMeshers algorithms concerned are *REGULAR, PYTHON, COMPOSITE, MEFISTO, Hexa, QUADRANGLE, RADIAL_QUAD*.
SMESH Plugins provide such algorithms as: **NETGEN, NETGEN_FULL, FULL_NETGEN, NETGEN_1D2D3D, NETGEN_1D2D, NETGEN_2D, NETGEN_3D**.
SMESH Plugins provide such algorithms as: *NETGEN, NETGEN_FULL, FULL_NETGEN, NETGEN_1D2D3D, NETGEN_1D2D, NETGEN_2D, NETGEN_3D*.
If you use DISTENE plugins, you also have **BLSURF, GHS3D, GHS3DPRL, Hexotic**.
If you use DISTENE plugins, you also have *BLSURF, GHS3D, GHS3DPRL, Hexotic*.
**Some variables were available in both namespaces **smesh** and **SMESH**.
* Some **variables** were available in both namespaces *smesh* and *SMESH*. Now they are available only in namespace *SMESH*.
Now they are available only in namespace **SMESH****.
The dump function used only the namespace *SMESH*,
so, if your script was built with the help of the dump function, it should be already OK in this respect.
The dump function used only the namespace **SMESH**,
so, if your script was built with the help of the dump function, it should be already OK in this respect.
The most used variables concerned are:
The most used variables concerned are:
**NODE, EDGE, FACE, VOLUME, ALL.**
**FT_xxx, geom_xxx, ADD_xxx...**
* *NODE, EDGE, FACE, VOLUME, ALL.*
* *FT_xxx, geom_xxx, ADD_xxx...*
For instance:
::
For instance::
srcFaceGroup = srcMesh.GroupOnGeom( midFace0, "src faces", smesh.FACE )
mesh.MakeGroup("Tetras",smesh.VOLUME,smesh.FT_ElemGeomType,"=",smesh.Geom_TETRA)
filter = smesh.GetFilter(smesh.FACE, smesh.FT_AspectRatio, smesh.FT_MoreThan, 6.5)
is replaced by:
::
is replaced by::
srcFaceGroup = srcMesh.GroupOnGeom( midFace0, "src faces", SMESH.FACE )
mesh.MakeGroup("Tetras",SMESH.VOLUME,SMESH.FT_ElemGeomType,"=",SMESH.Geom_TETRA)
filter = smesh.GetFilter(SMESH.FACE, SMESH.FT_AspectRatio, SMESH.FT_MoreThan, 6.5)
**The namespace **smesh.smesh** does not exist any more, use **smesh** instead.**
For instance:
::
* The namespace **smesh.smesh** does not exist any more, use **smesh** instead.
For instance::
Compound1 = smesh.smesh.Concatenate([Mesh_inf.GetMesh(), Mesh_sup.GetMesh()], 0, 1, 1e-05)
is replaced by:
::
is replaced by::
Compound1 = smesh.Concatenate([Mesh_inf.GetMesh(), Mesh_sup.GetMesh()], 0, 1, 1e-05)
**If you need to import a %SMESH Plugin explicitely, keep in mind that they are now located in separate namespaces.**
* If you need to **import a SMESH Plugin** explicitely, keep in mind that they are now located in separate namespaces.
For instance:
::
For instance::
import StdMeshers
import NETGENPlugin
@ -106,8 +94,7 @@ For instance:
import GHS3DPlugin
import HexoticPLUGIN
is replaced by:
::
is replaced by::
from salome.StdMeshers import StdMeshersBuilder
from salome.NETGENPlugin import NETGENPluginBuilder

958
doc/salome/gui/SMESH/input/smesh_module.rst Normal file
View File

@ -0,0 +1,958 @@
SMESH module
============
.. contents::
.. py:module:: SMESH
DriverMED_ReadStatus
--------------------
.. py:class:: DriverMED_ReadStatus
Enumeration for mesh read status
.. py:attribute:: DRS_OK
Ok
.. py:attribute:: DRS_EMPTY
a file contains no mesh with the given name
.. py:attribute:: DRS_WARN_RENUMBER
a MED file has overlapped ranges of element numbers,
so the numbers from the file are ignored
.. py:attribute:: DRS_WARN_SKIP_ELEM
some elements were skipped due to incorrect file data
.. py:attribute:: DRS_WARN_DESCENDING
some elements were skipped due to descending connectivity
.. py:attribute:: DRS_FAIL
general failure (exception etc.)
ComputeErrorName
----------------
.. py:class:: ComputeErrorName
Enumeration of computation errors
.. py:attribute:: COMPERR_OK
Ok
.. py:attribute:: COMPERR_BAD_INPUT_MESH
wrong mesh of lower sub-mesh
.. py:attribute:: COMPERR_STD_EXCEPTION
some std exception raised
.. py:attribute:: COMPERR_OCC_EXCEPTION
OCC exception raised
.. py:attribute:: COMPERR_SLM_EXCEPTION
SALOME exception raised
.. py:attribute:: COMPERR_EXCEPTION
other exception raised
.. py:attribute:: COMPERR_MEMORY_PB
memory allocation problem
.. py:attribute:: COMPERR_ALGO_FAILED
computation failed
.. py:attribute:: COMPERR_BAD_SHAPE
bad geometry
.. py:attribute:: COMPERR_WARNING
algo reports error but sub-mesh is computed anyway
.. py:attribute:: COMPERR_CANCELED
compute canceled
.. py:attribute:: COMPERR_NO_MESH_ON_SHAPE
no mesh elements assigned to sub-mesh
.. py:attribute:: COMPERR_BAD_PARMETERS
incorrect hypotheses parameters
ComputeError
------------
.. py:class:: ComputeError
Error details
.. py:attribute:: code
``int`` - :class:`ComputeErrorName` or, if negative, algo specific code
.. py:attribute:: comment
``str`` - textual problem description
.. py:attribute:: algoName
``str``
.. py:attribute:: subShapeID
``int`` - id of sub-shape of a shape to mesh
.. py:attribute:: hasBadMesh
``boolean`` - there are elements preventing computation available for visualization
Measure
-------
.. py:class:: Measure
Data returned by measure operations
.. py:attribute:: minX, minY, minZ
``double`` - coordinates of one point
.. py:attribute:: maxX, maxY, maxZ
``double`` - coordinates of another point
.. py:attribute:: node1, node2
``long`` - IDs of two nodes
.. py:attribute:: elem1, elem2
``long`` - IDs of two elements
.. py:attribute:: value
``double`` - distance
NodePosition
------------
.. py:class:: NodePosition
Node location on a shape
.. py:attribute:: shapeID
``long`` - ID of a shape
.. py:attribute:: shapeType
``GEOM.shape_type`` - type of shape
.. py:attribute:: params
``list of float`` -
* [U] on EDGE,
* [U,V] on FACE,
* [] on the rest shapes
ElementPosition
---------------
.. py:class:: ElementPosition
Element location on a shape
.. py:attribute:: shapeID
``long`` - ID of a shape
.. py:attribute:: shapeType
``GEOM.shape_type`` - type of shape
PolySegment
-----------
.. py:class:: PolySegment
Define a cutting plane passing through two points.
Used in :meth:`smeshBuilder.Mesh.MakePolyLine`
.. py:attribute:: node1ID1, node1ID2
``int,int`` - *point 1*: if *node1ID2* > 0, then the point is in the middle of a face edge defined
by two nodes, else it is at *node1ID1*
.. py:attribute:: node2ID1, node2ID2
``int,int`` - *point 2*: if *node2ID2* > 0, then the point is in the middle of a face edge defined
by two nodes, else it is at *node2ID1*
.. py:attribute:: vector
``SMESH.DirStruct`` - vector on the plane; to use a default plane set vector = (0,0,0)
ElementType
-----------
.. py:class:: ElementType
Enumeration for element type, like in SMDS
.. py:attribute::
ALL
NODE
EDGE
FACE
VOLUME
ELEM0D
BALL
NB_ELEMENT_TYPES
EntityType
----------
.. py:class:: EntityType
Enumeration of entity type
.. py:attribute::
Entity_Node
Entity_0D
Entity_Edge
Entity_Quad_Edge
Entity_Triangle
Entity_Quad_Triangle
Entity_BiQuad_Triangle
Entity_Quadrangle
Entity_Quad_Quadrangle
Entity_BiQuad_Quadrangle
Entity_Polygon
Entity_Quad_Polygon
Entity_Tetra
Entity_Quad_Tetra
Entity_Pyramid
Entity_Quad_Pyramid
Entity_Hexa
Entity_Quad_Hexa
Entity_TriQuad_Hexa
Entity_Penta
Entity_Quad_Penta
Entity_BiQuad_Penta
Entity_Hexagonal_Prism
Entity_Polyhedra
Entity_Quad_Polyhedra
Entity_Ball
Entity_Last
GeometryType
------------
.. py:class:: GeometryType
Enumeration of element geometry type
.. py:attribute::
Geom_POINT
Geom_EDGE
Geom_TRIANGLE
Geom_QUADRANGLE
Geom_POLYGON
Geom_TETRA
Geom_PYRAMID
Geom_HEXA
Geom_PENTA
Geom_HEXAGONAL_PRISM
Geom_POLYHEDRA
Geom_BALL
Geom_LAST
Hypothesis_Status
-----------------
.. py:class:: Hypothesis_Status
Enumeration of result of hypothesis addition/removal
.. py:attribute:: HYP_OK
Ok
.. py:attribute:: HYP_MISSING
algo misses a hypothesis
.. py:attribute:: HYP_CONCURRENT
several applicable hypotheses
.. py:attribute:: HYP_BAD_PARAMETER
hypothesis has a bad parameter value
.. py:attribute:: HYP_HIDDEN_ALGO
an algo is hidden by an upper dim algo generating all-dim elements
.. py:attribute:: HYP_HIDING_ALGO
an algo hides lower dim algos by generating all-dim elements
.. py:attribute:: HYP_UNKNOWN_FATAL
all statuses below should be considered as fatal for Add/RemoveHypothesis operations
.. py:attribute:: HYP_INCOMPATIBLE
hypothesis does not fit algorithm
.. py:attribute:: HYP_NOTCONFORM
not conform mesh is produced appling a hypothesis
.. py:attribute:: HYP_ALREADY_EXIST
such hypothesis already exist
.. py:attribute:: HYP_BAD_DIM
bad dimension
.. py:attribute:: HYP_BAD_SUBSHAPE
shape is neither the main one, nor its sub-shape, nor a group
.. py:attribute:: HYP_BAD_GEOMETRY
geometry mismatches algorithm's expectation
.. py:attribute:: HYP_NEED_SHAPE
algorithm can work on shape only
.. py:attribute:: HYP_INCOMPAT_HYPS
several additional hypotheses are incompatible one with other
FunctorType
-----------
.. py:class:: FunctorType
Enumeration of functor types
.. py:attribute::
FT_AspectRatio
FT_AspectRatio3D
FT_Warping
FT_MinimumAngle
FT_Taper
FT_Skew
FT_Area
FT_Volume3D
FT_MaxElementLength2D
FT_MaxElementLength3D
FT_FreeBorders
FT_FreeEdges
FT_FreeNodes
FT_FreeFaces
FT_EqualNodes
FT_EqualEdges
FT_EqualFaces
FT_EqualVolumes
FT_MultiConnection
FT_MultiConnection2D
FT_Length
FT_Length2D
FT_Deflection2D
FT_NodeConnectivityNumber
FT_BelongToMeshGroup
FT_BelongToGeom
FT_BelongToPlane
FT_BelongToCylinder
FT_BelongToGenSurface
FT_LyingOnGeom
FT_RangeOfIds
FT_BadOrientedVolume
FT_BareBorderVolume
FT_BareBorderFace
FT_OverConstrainedVolume
FT_OverConstrainedFace
FT_LinearOrQuadratic
FT_GroupColor
FT_ElemGeomType
FT_EntityType
FT_CoplanarFaces
FT_BallDiameter
FT_ConnectedElements
FT_LessThan
FT_MoreThan
FT_EqualTo
FT_LogicalNOT
FT_LogicalAND
FT_LogicalOR
FT_Undefined
.. py:module:: SMESH.Filter
:noindex:
Filter.Criterion
----------------
.. py:class:: Criterion
Structure containing information of a criterion
.. py:attribute:: Type
``long`` - value of item of :class:`SMESH.FunctorType`
.. py:attribute:: Compare
``long`` - value of item of :class:`SMESH.FunctorType` in ( FT_LessThan, FT_MoreThan, FT_EqualTo )
.. py:attribute:: Threshold
``double`` - threshold value
.. py:attribute:: ThresholdStr
``string`` - Threshold value defined as string. Used for:
1. Diapason of identifiers. Example: "1,2,3,5-10,12,27-29".
2. Storing name of shape.
3. Storing group color "0.2;0;0.5".
4. Storing point coordinates.
.. py:attribute:: ThresholdID
``string`` - One more threshold value defined as string. Used for storing id of shape
.. py:attribute:: UnaryOp
``long`` - unary logical operation: FT_LogicalNOT or FT_Undefined
.. py:attribute:: BinaryOp
``long`` - binary logical operation FT_LogicalAND, FT_LogicalOR etc.
.. py:attribute:: Tolerance
``double`` - Tolerance is used for
1. Comparison of real values.
2. Detection of geometrical coincidence.
.. py:attribute:: TypeOfElement
``ElementType`` - type of element :class:`SMESH.ElementType` (SMESH.NODE, SMESH.FACE etc.)
.. py:attribute:: Precision
``long`` - Precision of numerical functors
.. py:currentmodule:: SMESH
FreeEdges.Border
----------------
.. py:class:: FreeEdges.Border
Free edge: edge connected to one face only
.. py:attribute:: myElemId
``long`` - ID of a face
.. py:attribute:: myPnt1,myPnt2
``long`` - IDs of two nodes
PointStruct
-----------
.. py:class:: PointStruct
3D point.
Use :meth:`GetPointStruct() <smeshBuilder.smeshBuilder.GetPointStruct>`
to convert a vertex (GEOM.GEOM_Object) to PointStruct
.. py:attribute:: x,y,z
``double`` - point coordinates
DirStruct
---------
.. py:class:: DirStruct
3D vector.
Use :meth:`GetDirStruct() <smeshBuilder.smeshBuilder.GetDirStruct>`
to convert a vector (GEOM.GEOM_Object) to DirStruct
.. py:attribute:: PS
:class:`PointStruct` - vector components
AxisStruct
----------
.. py:class:: AxisStruct
Axis defined by its origin and its vector.
Use :meth:`GetAxisStruct() <smeshBuilder.smeshBuilder.GetAxisStruct>`
to convert a line or plane (GEOM.GEOM_Object) to AxisStruct
.. py:attribute:: x,y,z
``double`` - coordinates of the origin
.. py:attribute:: vx,vy,vz
``double`` - components of the vector
Filter
------
.. py:class:: Filter
Filter of mesh entities
.. py:function:: GetElementsId( mesh )
Return satisfying elements
:param SMESH.SMESH_Mesh mesh: the mesh;
it can be obtained via :meth:`smeshBuilder.Mesh.GetMesh`
:return: list of IDs
.. py:function:: GetIDs()
Return satisfying elements.
A mesh to filter must be already set, either via :meth:`SetMesh` method
or via ``mesh`` argument of :meth:`smeshBuilder.smeshBuilder.GetFilter`
:return: list of IDs
.. py:function:: SetMesh( mesh )
Set mesh to filter
:param SMESH.SMESH_Mesh mesh: the mesh;
it can be obtained via :meth:`smeshBuilder.Mesh.GetMesh`
.. py:function:: SetCriteria( criteria )
Define filtering criteria
:param criteria: list of :class:`SMESH.Filter.Criterion`
NumericalFunctor
----------------
.. py:class:: NumericalFunctor
Calculate value by ID of mesh entity. Base class of various functors
.. py:function:: GetValue( elementID )
Compute a value
:param elementID: ID of element or node
:return: floating value
SMESH_Mesh
----------
.. py:class:: SMESH_Mesh
Mesh. It is a Python wrap over a CORBA interface of mesh.
All its methods are exposed via :class:`smeshBuilder.Mesh` class that you can obtain by calling::
smeshBuilder_mesh = smesh.Mesh( smesh_mesh )
SMESH_MeshEditor
----------------
.. py:class:: SMESH_MeshEditor
Mesh editor. It is a Python wrap over a CORBA SMESH_MeshEditor interface.
All its methods are exposed via :class:`smeshBuilder.Mesh` class.
.. py:class:: Extrusion_Error
Enumeration of errors of :meth:`smeshBuilder.Mesh.ExtrusionAlongPathObjects`
.. py:attribute::
EXTR_OK
EXTR_NO_ELEMENTS
EXTR_PATH_NOT_EDGE
EXTR_BAD_PATH_SHAPE
EXTR_BAD_STARTING_NODE
EXTR_BAD_ANGLES_NUMBER
EXTR_CANT_GET_TANGENT
.. py:class:: SMESH_MeshEditor.Sew_Error
Enumeration of errors SMESH_MeshEditor.Sewing... methods
.. py:attribute::
SEW_OK
SEW_BORDER1_NOT_FOUND
SEW_BORDER2_NOT_FOUND
SEW_BOTH_BORDERS_NOT_FOUND
SEW_BAD_SIDE_NODES
SEW_VOLUMES_TO_SPLIT
SEW_DIFF_NB_OF_ELEMENTS
SEW_TOPO_DIFF_SETS_OF_ELEMENTS
SEW_BAD_SIDE1_NODES
SEW_BAD_SIDE2_NODES
SEW_INTERNAL_ERROR
SMESH_Pattern
-------------
.. py:class:: SMESH_Pattern
Pattern mapper. Use a pattern defined by user for
* creating mesh elements on geometry, faces or blocks
* refining existing mesh elements, faces or hexahedra
The pattern is defined by a string as explained :doc:`here <pattern_mapping>`.
Usage work-flow is:
* Define a pattern via Load... method
* Compute future positions of nodes via Apply... method
* Create nodes and elements in a mesh via :meth:`MakeMesh` method
.. py:function:: LoadFromFile( patternFileContents )
Load a pattern from the string *patternFileContents*
:param str patternFileContents: string defining a pattern
:return: True if succeeded
.. py:function:: LoadFromFace( mesh, geomFace, toProject )
Create a 2D pattern from the mesh built on *geomFace*.
:param SMESH.SMESH_Mesh mesh: source mesh
:param GEOM.GEOM_Object geomFace: geometrical face whose mesh forms a pattern
:param boolean toProject: if True makes override nodes positions
on *geomFace* computed by mesher
:return: True if succeeded
.. py:function:: LoadFrom3DBlock( mesh, geomBlock )
Create a 3D pattern from the mesh built on *geomBlock*
:param SMESH.SMESH_Mesh mesh: source mesh
:param GEOM.GEOM_Object geomBlock: geometrical block whose mesh forms a pattern
:return: True if succeeded
.. py:function:: ApplyToFace( geomFace, vertexOnKeyPoint1, toReverse )
Compute nodes coordinates by applying
the loaded pattern to *geomFace*. The first key-point
will be mapped into *vertexOnKeyPoint1*, which must
be in the outer wire of *geomFace*
:param GEOM.GEOM_Object geomFace: the geometrical face to generate faces on
:param GEOM.GEOM_Object vertexOnKeyPoint1: the vertex to be at the 1st key-point
:param boolean toReverse: to reverse order of key-points
:return: list of :class:`SMESH.PointStruct` - computed coordinates of points of the pattern
.. py:function:: ApplyTo3DBlock( geomBlock, vertex000, vertex001 )
Compute nodes coordinates by applying
the loaded pattern to *geomBlock*. The (0,0,0) key-point
will be mapped into *vertex000*. The (0,0,1)
key-point will be mapped into *vertex001*.
:param GEOM.GEOM_Object geomBlock: the geometrical block to generate volume elements on
:param GEOM.GEOM_Object vertex000: the vertex to superpose (0,0,0) key-point of pattern
:param GEOM.GEOM_Object vertex001: the vertex to superpose (0,0,1) key-point of pattern
:return: list of :class:`SMESH.PointStruct` - computed coordinates of points of the pattern
.. py:function:: ApplyToMeshFaces( mesh, facesIDs, nodeIndexOnKeyPoint1, toReverse )
Compute nodes coordinates by applying
the loaded pattern to mesh faces. The first key-point
will be mapped into *nodeIndexOnKeyPoint1* -th node of each mesh face
:param SMESH.SMESH_Mesh mesh: the mesh where to refine faces
:param list_of_ids facesIDs: IDs of faces to refine
:param int nodeIndexOnKeyPoint1: index of a face node to be at 1-st key-point of pattern
:param boolean toReverse: to reverse order of key-points
:return: list of :class:`SMESH.PointStruct` - computed coordinates of points of the pattern
.. py:function:: ApplyToHexahedrons( mesh, volumesIDs, node000Index, node001Index )
Compute nodes coordinates by applying
the loaded pattern to hexahedra. The (0,0,0) key-point
will be mapped into *Node000Index* -th node of each volume.
The (0,0,1) key-point will be mapped into *node001Index* -th
node of each volume.
:param SMESH.SMESH_Mesh mesh: the mesh where to refine hexahedra
:param list_of_ids volumesIDs: IDs of volumes to refine
:param long node000Index: index of a volume node to be at (0,0,0) key-point of pattern
:param long node001Index: index of a volume node to be at (0,0,1) key-point of pattern
:return: list of :class:`SMESH.PointStruct` - computed coordinates of points of the pattern
.. py:function:: MakeMesh( mesh, createPolygons, createPolyedrs )
Create nodes and elements in *mesh* using nodes
coordinates computed by either of Apply...() methods.
If *createPolygons* is True, replace adjacent faces by polygons
to keep mesh conformity.
If *createPolyedrs* is True, replace adjacent volumes by polyedrs
to keep mesh conformity.
:param SMESH.SMESH_Mesh mesh: the mesh to create nodes and elements in
:param boolean createPolygons: to create polygons to to keep mesh conformity
:param boolean createPolyedrs: to create polyherda to to keep mesh conformity
:return: True if succeeded
SMESH_subMesh
-------------
.. py:class:: SMESH_subMesh
:doc:`Sub-mesh <constructing_submeshes>`
.. py:function:: GetNumberOfElements()
Return number of elements in the sub-mesh
.. py:function:: GetNumberOfNodes( all )
Return number of nodes in the sub-mesh
:param boolean all: if True, also return nodes assigned to boundary sub-meshes
.. py:function:: GetElementsId()
Return IDs of elements in the sub-mesh
.. py:function:: GetNodesId()
Return IDs of nodes in the sub-mesh
.. py:function:: GetSubShape()
Return :class:`geom shape <GEOM.GEOM_Object>` the sub-mesh is dedicated to
.. py:function:: GetId()
Return ID of the :class:`geom shape <GEOM.GEOM_Object>` the sub-mesh is dedicated to
.. py:function:: GetMeshInfo()
Return number of mesh elements of each :class:`SMESH.EntityType`.
Use :meth:`smeshBuilder.smeshBuilder.EnumToLong` to get an integer from
an item of :class:`SMESH.EntityType`.
:return: array of number of elements per :class:`SMESH.EntityType`
.. py:function:: GetMesh()
Return the :class:`SMESH.SMESH_Mesh`
SMESH_GroupBase
---------------
.. py:class:: SMESH_GroupBase
:doc:`Mesh group <grouping_elements>`
.. py:function:: SetName( name )
Set group name
.. py:function:: GetName()
Return group name
.. py:function:: GetType()
Return :class:`group type <SMESH.ElementType>` (type of elements in the group)
.. py:function:: Size()
Return the number of elements in the group
.. py:function:: IsEmpty()
Return True if the group does not contain any elements
.. py:function:: Contains( elem_id )
Return True if the group contains an element with ID == *elem_id*
.. py:function:: GetID( elem_index )
Return ID of an element at position *elem_index* counted from 1
.. py:function:: GetNumberOfNodes()
Return the number of nodes of cells included to the group.
For a nodal group return the same value as Size() function
.. py:function:: GetNodeIDs()
Return IDs of nodes of cells included to the group.
For a nodal group return result of GetListOfID() function
.. py:function:: SetColor( color )
Set group color
:param SALOMEDS.Color color: color
.. py:function:: GetColor()
Return group color
:return: SALOMEDS.Color
SMESH_Group
-----------
.. py:class:: SMESH_Group
:doc:`Standalone mesh group <grouping_elements>`. Inherits all methods of :class:`SMESH.SMESH_GroupBase`
.. py:function:: Clear()
Clears the group's contents
.. py:function:: Add( elem_ids )
Adds elements or nodes with specified identifiers to the group
:param list_of_ids elem_ids: IDs to add
.. py:function:: AddFrom( idSource )
Add all elements or nodes from the specified source to the group
:param SMESH.SMESH_IDSource idSource: an object to retrieve IDs from
.. py:function:: Remove( elem_ids )
Removes elements or nodes with specified identifiers from the group
:param list_of_ids elem_ids: IDs to remove
SMESH_GroupOnGeom
-----------------
.. py:class:: SMESH_GroupOnGeom
Group linked to geometry. Inherits all methods of :class:`SMESH.SMESH_GroupBase`
.. py:function:: GetShape()
Return an associated geometry
:return: GEOM.GEOM_Object
SMESH_GroupOnFilter
-------------------
.. py:class:: SMESH_GroupOnFilter
Group defined by filter. Inherits all methods of :class:`SMESH.SMESH_GroupBase`
.. py:function:: SetFilter( filter )
Set the :class:`filter <SMESH.Filter>`
.. py:function:: GetFilter()
Return the :class:`filter <SMESH.Filter>`
SMESH_IDSource
--------------
.. py:class:: SMESH_IDSource
Base class for classes able to return IDs of mesh entities. These classes are:
* :class:`SMESH.SMESH_Mesh`
* :class:`SMESH.SMESH_subMesh`
* :class:`SMESH.SMESH_GroupBase`
* :class:`SMESH.Filter`
* temporal ID source created by :meth:`smeshBuilder.Mesh.GetIDSource`
.. py:function:: GetIDs()
Return a sequence of all element IDs
.. py:function:: GetMeshInfo()
Return number of mesh elements of each :class:`SMESH.EntityType`.
Use :meth:`smeshBuilder.smeshBuilder.EnumToLong` to get an integer from
an item of :class:`SMESH.EntityType`.
.. py:function:: GetNbElementsByType()
Return number of mesh elements of each :class:`SMESH.ElementType`.
Use :meth:`smeshBuilder.smeshBuilder.EnumToLong` to get an integer from
an item of :class:`SMESH.ElementType`.
.. py:function:: GetTypes()
Return types of elements it contains.
It's empty if the object contains no IDs
:return: list of :class:`SMESH.ElementType`
.. py:function:: GetMesh()
Return the :class:`SMESH.SMESH_Mesh`
SMESH_Hypothesis
----------------
.. py:class:: SMESH_Hypothesis
Base class of all :doc:`hypotheses <about_hypo>`
.. py:function:: GetName()
Return string of hypothesis type name, something like "Regular_1D"
.. py:function:: GetLibName()
Return string of plugin library name

73
doc/salome/gui/SMESH/input/smeshpy_interface.rst
View File

@ -7,16 +7,14 @@ Python interface
Python API of SALOME Mesh module defines several classes that can
be used for easy mesh creation and edition.
Documentation of SALOME %Mesh module Python API is available in two forms:
Documentation of SALOME Mesh module Python API is available in two forms:
- :ref:`Structured documentation <modules_page>`, where all methods and classes are grouped by their functionality.
- :doc:`Structured documentation <modules>`, where all methods and classes are grouped by their functionality.
- :ref:`Linear documentation <genindex>` grouped only by classes, declared in the :mod:`smeshBuilder` and :mod:`StdMeshersBuilder` Python packages.
- :ref:`Linear documentation <modindex>` grouped only by classes, declared in the :mod:`smeshBuilder` and :mod:`StdMeshersBuilder` Python packages.
With SALOME 7.2, the Python interface for Mesh has been slightly modified to offer new functionality.
You may have to modify your scripts generated with SALOME 6 or older versions.
Please see :ref:`smesh_migration_page`.
Class :class:`smeshBuilder.smeshBuilder` provides an interface to create and handle
@ -43,21 +41,21 @@ A usual workflow to generate a mesh on geometry is following:
mesh = smesh.Mesh( geometry )
#. Create and assign :ref:`basic_meshing_algos_page` by calling corresponding methods of the mesh. If a sub-shape is provided as an argument, a :ref:`constructing_submeshes_page` is implicitly created on this sub-shape:
#. Create and assign :ref:`algorithms <basic_meshing_algos_page>` by calling corresponding methods of the mesh. If a sub-shape is provided as an argument, a :ref:`sub-mesh <constructing_submeshes_page>` is implicitly created on this sub-shape:
.. code-block:: python
:linenos:
regular1D = smeshBuilder.Mesh.Segment()
mefisto = smeshBuilder.Mesh.Triangle( smeshBuilder.MEFISTO )
regular1D = mesh.Segment()
mefisto = mesh.Triangle( smeshBuilder.MEFISTO )
# use other triangle algorithm on a face -- a sub-mesh appears in the mesh
netgen = smeshBuilder.Mesh.Triangle( smeshBuilder.NETGEN_1D2D, face )
netgen = mesh.Triangle( smeshBuilder.NETGEN_1D2D, face )
#. Create and assign :ref:`about_hypo_page` by calling corresponding methods of algorithms:
#. Create and assign :ref:`hypotheses <about_hypo_page>` by calling corresponding methods of algorithms:
.. code-block:: python
:linenos:
segLen10 = StdMeshersBuilder.StdMeshersBuilder_Segment.LocalLength( 10. )
maxArea = StdMeshersBuilder.StdMeshersBuilder_Segment.LocalLength( 100. )
segLen10 = regular1D.LocalLength( 10. )
maxArea = mefisto.LocalLength( 100. )
netgen.SetMaxSize( 20. )
netgen.SetFineness( smeshBuilder.VeryCoarse )
@ -65,7 +63,7 @@ A usual workflow to generate a mesh on geometry is following:
.. code-block:: python
:linenos:
Mesh.Compute()
mesh.Compute()
An easiest way to start with Python scripting is to do something in
GUI and then to get a corresponding Python script via
@ -83,39 +81,40 @@ generation and for retrieving information on mesh nodes and elements.
Example of 3d mesh generation:
##############################
.. _3dmesh.py:
``3dmesh.py``
.. literalinclude:: ../../../examples/3dmesh.py
:linenos:
:language: python
:download:`../../../examples/3dmesh.py`
:download:`Download this script <../../../examples/3dmesh.py>`
Examples of Python scripts for Mesh operations are available by
the following links:
- :ref:`tui_creating_meshes_page`
- :ref:`tui_defining_hypotheses_page`
- :ref:`tui_grouping_elements_page`
- :ref:`tui_filters_page`
- :ref:`tui_modifying_meshes_page`
- :ref:`tui_transforming_meshes_page`
- :ref:`tui_viewing_meshes_page`
- :ref:`tui_quality_controls_page`
- :ref:`tui_measurements_page`
- :ref:`tui_work_on_objects_from_gui`
- :ref:`tui_notebook_smesh_page`
- :ref:`tui_cartesian_algo`
- :ref:`tui_use_existing_faces`
- :ref:`tui_prism_3d_algo`
- :ref:`tui_generate_flat_elements_page`
.. toctree::
:titlesonly:
tui_creating_meshes
tui_defining_hypotheses
tui_grouping_elements
tui_filters
tui_modifying_meshes
tui_transforming_meshes
tui_viewing_meshes
tui_quality_controls
tui_measurements
tui_work_on_objects_from_gui
tui_notebook_smesh
tui_cartesian_algo
tui_use_existing_faces
tui_prism_3d_algo
tui_generate_flat_elements
.. toctree::
:maxdepth: 2
:hidden:
smesh_migration.rst
smesh_migration.rst
smeshBuilder.rst
StdMeshersBuilder.rst
smeshstudytools.rst
modules.rst
smesh_module.rst

5
doc/salome/gui/SMESH/input/smeshstudytools.rst Normal file
View File

@ -0,0 +1,5 @@
smeshstudytools module
======================
.. automodule:: smeshstudytools
:members:

19
doc/salome/gui/SMESH/input/smoothing.rst
View File

@ -9,17 +9,13 @@ locations of element corners (nodes).
.. note:: Depending on the chosen method and mesh geometry the smoothing can actually decrease the quality of elements and even make some elements inverted.
**To apply smoothing to the elements of your mesh:**
*To apply smoothing to the elements of your mesh:*
#. In the **Modification** menu select the **Smoothing** item or click **"Smoothing"** button in the toolbar.
.. |img| image:: ../images/image84.png
.. image:: ../images/image84.png
:align: center
#. In the **Modification** menu select the **Smoothing** item or click *"Smoothing"* button |img| in the toolbar.
.. centered::
**"Smoothing" button**
The following dialog will appear:
The following dialog will appear:
.. image:: ../images/smoothing.png
:align: center
@ -55,15 +51,14 @@ locations of element corners (nodes).
:align: center
.. centered::
"The initial mesh"
The initial mesh
.. image:: ../images/smoothing2.png
:align: center
.. centered::
"The smoothed mesh"
The smoothed mesh: mesh quality improved
**See Also** a sample TUI Script of a
:ref:`tui_smoothing` operation.
**See Also** a sample TUI Script of a :ref:`tui_smoothing` operation.

13
doc/salome/gui/SMESH/input/split_biquad_to_linear.rst
View File

@ -18,19 +18,16 @@ So that
:align: center
.. centered::
"Mesh before and after splitting"
Mesh before and after splitting
**To split bi-quadratic elements into linear:**
*To split bi-quadratic elements into linear:*
#. From the **Modification** menu choose the **Split bi-quadratic into linear** item or click **"Split bi-quadratic into linear"** button in the toolbar.
.. |img| image:: ../images/split_biquad_to_linear_icon.png
.. image:: ../images/split_biquad_to_linear_icon.png
:align: center
#. From the **Modification** menu choose the **Split bi-quadratic into linear** item or click *"Split bi-quadratic into linear"* button |img| in the toolbar.
.. centered::
**"Split bi-quadratic into linear" button**
The following dialog box shall appear:
The following dialog box shall appear:
.. image:: ../images/split_biquad_to_linear_dlg.png
:align: center

31
doc/salome/gui/SMESH/input/split_to_tetra.rst
View File

@ -7,34 +7,31 @@ Splitting volumes
This operation allows to split either any volumic elements into
tetrahedra or hexahedra into prisms. 2D mesh is modified accordingly.
**To split volumes:**
*To split volumes:*
.. |img| image:: ../images/split_into_tetra_icon.png
#. Select a mesh, a sub-mesh or a group.
#. In the **Modification** menu select the **Split Volumes** item or click **"Split Volumes"** button in the toolbar.
#. In the **Modification** menu select the **Split Volumes** item or click *"Split Volumes"* button |img| in the toolbar.
.. image:: ../images/split_into_tetra_icon.png
:align: center
.. centered::
**"Split Volumes" button**
The following dialog box will appear:
The following dialog box will appear:
.. image:: ../images/split_into_tetra.png
:align: center
First it is possible to select the type of operation:
* First it is possible to select the type of operation:
* If **Tetrahedron** button is checked, the operation will split volumes of any type into tetrahedra.
* If **Prism** button is checked, the operation will split hexahedra into prisms.
* The main list contains the list of volumes to split. You can click on a volume in the 3D viewer and it will be highlighted (lock Shiftkeyboard button to select several volumes). Click **Add** button and the ID of this volume will be added to the list. To remove the selected element or elements from the list click **Remove** button. **Sort list** button allows to sort the list of IDs. **Filter** button allows applying a filter to the selection of volumes.
**Note:** If you split not all adjacent non-tetrahedral volumes, your mesh becomes non-conform.
* **Apply to all** radio button allows splitting all volumes of the currently selected mesh.
* If **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.
* The main list contains the list of volumes to split. You can click on a volume in the 3D viewer and it will be highlighted (lock Shiftkeyboard button to select several volumes). Click **Add** button and the ID of this volume will be added to the list. To remove the selected element or elements from the list click **Remove** button. **Sort list** button allows to sort the list of IDs. **Filter** button allows applying a filter to the selection of volumes.
* If **Prism** element type is selected, the **Split hexahedron** group looks as follows:
.. note:: If you split not all adjacent non-tetrahedral volumes, your mesh becomes non-conform.
* **Apply to all** radio button allows splitting all volumes of the currently selected mesh.
* If **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.
* If **Prism** element type is selected, the **Split hexahedron** group looks as follows:
.. image:: ../images/split_into_prisms.png
:align: center
@ -48,9 +45,9 @@ tetrahedra or hexahedra into prisms. 2D mesh is modified accordingly.
* If **All domains** option is off, the operation stops when all hehexedra adjacent to the start hexahedron are split into prisms. Else the operation tries to continue splitting starting from another hexahedron closest to the **Hexa location**.
* **Select from** set of fields allows choosing a sub-mesh or an existing group whose elements will be added to the list as you click **Add** button.
* **Select from** set of fields allows choosing a sub-mesh or an existing group whose elements will be added to the list as you click **Add** button.
#. Click **Apply** or **Apply and Close** button to confirm the operation.
**See also** a sample TUI script of :ref:`modifying_meshes_split_vol` operation.

Some files were not shown because too many files have changed in this diff Show More