]> SALOME platform Git repositories - modules/smesh.git/commitdiff
Salome HOME
Update SMESH documentation
authormaintenance team <salome-mnt@opencascade.com>
Thu, 29 Oct 2009 07:26:03 +0000 (07:26 +0000)
committermaintenance team <salome-mnt@opencascade.com>
Thu, 29 Oct 2009 07:26:03 +0000 (07:26 +0000)
doc/salome/gui/SMESH/input/1d_meshing_hypo.doc
doc/salome/gui/SMESH/input/blsurf_hypo.doc
doc/salome/gui/SMESH/input/ghs3d_hypo.doc
doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc
doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.doc

index c61d388a5d15a69ad2730bd2bf80062e2803acb6..ab033b7ff43e3ce067e45e12bba73f3dc6d6ddd1 100644 (file)
@@ -199,31 +199,24 @@ minimum and maximum value of this parameter.
 \anchor fixed_points_1d_anchor
 <h2>Fixed points 1D hypothesis</h2>
 
-<b>Fixed points 1D</b> hypothesis allows to split edges into segments
-using set of fixed points given by normalized parameters on edge and
-set of numbers of segments for splitting each sub-segment between
-fixed points. Optionally it is possible to set flag
-<b>Same Nb. Segments for all intervals</b> and
-only one value for mentioned number of segments.
-
-The direction of the splitting is defined by the orientation of the
-underlying geometrical edge. <b>"Reverse Edges"</b> list box allows to
-specify the edges for which the splitting should be made in the
-direction opposing to their orientation. This list box is enabled only
-if the geometry object is selected for the meshing. In this case the
-user can select edges to be reversed either directly picking them in
-the 3D viewer or by selecting the edges or groups of edges in the
-Object browser.
+<b>Fixed points 1D</b> hypothesis allows spliting edges through a
+set of points parametrized on the edge (from 1 to 0)and a number of segments for each
+interval limited by the points.
 
-Using of this hypothesis for quadrangle face where main mesh is
-created using <b>Quadrangle(Mapping)</b> and <b>NumberOfSegments</b>
-hypothesises. Creation hypothesis <b>FixedPoint_1D</b> for submesh on
-one edge:
+\image html hypo_fixedpnt_dlg.png 
 
-\image html hypo_fixedpnt_dlg.png
+It is possible to check in <b>Same Nb. Segments for all intervals</b> 
+option and to define one value for all intervals.
 
-Resulting 2D mesh:
+The splitting direction is defined by the orientation of the
+underlying geometrical edge. <b>"Reverse Edges"</b> 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.
 
-\image html mesh_fixedpnt.png
+\image html mesh_fixedpnt.png "Example of a submesh on the edge built using Fixed points 1D hypothesis"
 
 */
index 81a770618d29e3dc435b4923013d24141a344c84..03c0fc5946a986bff218a70739defc427d09856d 100644 (file)
@@ -207,19 +207,20 @@ String variables:
 
 \image html blsurf_parameters_sizemap.png
 
-It is possible to define user sizes on faces, edges or verteces.
+User sizes can be defined on faces, edges or vertices.
 <ul>
-<li>Those faces, edges and verteces can be the meshed geometry object or sub-shapes (from explode command) of the meshed geometry object.</li>
-<li>Groups of faces, edges and verteces are also handled.</li>
-<li>To add the same size on several geometries, multi-selection is possible.</li>
-<li>The sizes are either constant values or python functions.</li>
-<li>In the case of a python function, the following rules must be respected:
+<li>The faces, edges and vertices can belong to the meshed geometrical
+object or to its sub-shapes (created using <b>Explode</b> command).</li>
+<li>Groups of faces, edges and vertices are also handled.</li>
+<li>It is possible to attribute the same size to several geometries using multi-selection.</li>
+<li>The sizes are constant values or python functions.</li>
+<li>In case of a python function, the following rules must be respected:
 <ul>
-<li>The name of the function is f</li>
-<li>If geometry is face or group of faces, function is f(u,v)</li>
-<li>If geometry is edge or group of edges, function is f(t)</li>
-<li>If geometry is vertex or group of vertices, function is f()</li>
-<li>The function must return a double</li>
+<li>The name of the function is f.</li>
+<li>If geometry is a face or a group of faces, the function is f(u,v).</li>
+<li>If geometry is an edge or a group of edges, the function is f(t).</li>
+<li>If geometry is a vertex or a group of vertices, the function is f().</li>
+<li>The function must return a double.</li>
 </ul></li>
 </ul>
 
@@ -227,10 +228,12 @@ It is possible to define user sizes on faces, edges or verteces.
 
 \anchor blsurf_sizemap_computation
 <h2>Computation of the physical size</h2>
-Here is the detail on the calculation of the size (from BLSurf documentation).
 \n
-The size is obtained by querying sizemap functions associated to the input CAD object for surfaces, curves and points.
-Each function can either return a value h (which is then trimmed between the two bounds hphymin and hphymax), or "no answer" (by not assigning a value to h), thus providing great flexibility in the specification of the sizes. The computation depends whether point P is internal to a surface, internal to a curve, or at the end of several curves:
+The physical size is obtained by querying sizemap functions associated to the input CAD object for surfaces, curves and points.
+Each function can either return a value h (which is then trimmed
+between the two bounds hphymin and hphymax), or "no answer" (by not
+assigning a value to h), thus providing great flexibility in the
+specification of the sizes. The computation depends on whether point P is internal to a surface, internal to a curve, or at the end of several curves:
 <ul>
 <li> If point P is internal to a surface, the CAD surface size function is queried. If no answer is returned, one interpolates with the values at the vertices of the discretized interface curves.</li>
 <li> If point P is internal to a curve, the CAD curve size function is queried first. If no answer is returned, the surface size function is queried for every adjacent surface and the mean value of the returned values is computed. If no answer is returned, sizes h1 and h2 at both ends of the curve are considered (see next item) and the interpolated value is computed.</li>
@@ -243,12 +246,13 @@ In order to compute the mean of several values, the arithmetic mean is used by d
 
 \image html blsurf_parameters_enforced_vertices.png
 
-It is possible to define some enforced vertices to BLSurf algorithm without any vertex creation into the CAD.
+It is possible to define some enforced vertices to BLSurf algorithm
+without creating any vertices by CAD algorithms.
 <ul>
-<li>Enforced vertices are the projection of a given point defines by its (x,y,z) coordinates on the concerned face.</li>
-<li>It is possible to define several enforced vertices on 1 face.</li>
-<li>Group of faces are also handled.</li>
-<li>If the projection point is on the boundary or outside the face, then it will be ignored.</li>
+<li>The enforced vertex is the projection of a point defined by its
+(x,y,z) coordinates on the selected face.</li>
+<li>It is possible to define several enforced vertices on a face or a group of faces.</li>
+<li>If the projected point is on the boundary or outside of the face, it will be ignored.</li>
 </ul>
 
 <br><b>See Also</b> a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including enforced vertices.
index 230929ce7a0cd500824e8bf2cdf20dcfec481849..eb4b981b65b88bb212bf12111fe486223a77941f 100644 (file)
@@ -56,16 +56,18 @@ together with the characteristics of the final mesh.
 <li><b>To create new nodes</b> - if this option is checked off, ghs3d
 tries to create tetrahedrons using only the nodes of the 2D mesh.</li>
 
-<li><b>To remove initial central point</b> - TetMesh-GHS3D adds an internal point 
-at the centre of gravity of the bounding box in order to speed up and to simplify 
-the meshing process. It is however possible for TetMesh-GHS3D to refrain from creating 
+<li><b>To remove the initial central point</b> TetMesh-GHS3D adds an internal point 
+at the gravity centre of the bounding box to speed up and to simplify 
+the meshing process. However, it is possible to refrain from creating 
 this point by using the command line option -no initial central point. This can be
-particularly useful to generate a volume mesh without internal points at all, and in some rare cases,
-to help the boundary regeneration phase when it failed with the standard options (for example when
-one dimension of the domain is large compared to the other two, with a ratio of 20 or more).
-Use this option when the boundary regeneration failed with the standard parameters and before using
+particularly useful to generate a volume mesh without internal points at all and in some rare cases
+at the boundary regeneration phase when it is impossible to proceed
+with the standard options
+(for example, when one dimension of the domain is more than 20 times greater than the other two).
+Use this option if the boundary regeneration has failed with the standard parameters and before using
 the recovery version (command line option -C).
-Note: when using this option, the speed of the meshing process may decrease, and quality may change.
+Note: when using this option, the speed of the meshing process may
+decrease, and the quality may change.
 Note: the boundary regeneration may fail with this option, in some rare cases.</li>
 
 <li><b>To use boundary recovery version</b> - enables using a
@@ -78,18 +80,18 @@ quality (poor aspect ratio of elements, tetrahedra with a very small
 positive volume).</li>
 
 <li><b>To use FEM correction</b> - Applies finite-element correction by 
-replacing overconstrained elements where it is possible. The process i
-first slicing the overconstrained edges and second the overconstrained 
-facets. This ensures that no edges have two boundary vertices and that 
-no facets have three boundary vertices. TetMesh-GHS3D gives the initial 
+replacing overconstrained elements where it is possible. At first the proces
+slices the overconstrained edges and at second the overconstrained 
+facets. This ensures that there are no edges with two boundary
+vertices and that there are no facets with three boundary vertices. TetMesh-GHS3D gives the initial 
 and final overconstrained edges and facets. It also gives the facets
 which have three edges on the boundary.
 Note: when using this option, the speed of the meshing process may 
 decrease, quality may change, and the smallest volume may be smaller.
-The default is no correction.</li>
+By default, the FEM correction is not used.</li>
 
-<li><b>Option as text</b> - allows input of any text as command line
-for ghs3d. This allows the input of advanced options in a free from. </li>
+<li><b>Option as text</b> - allows to input in the command line any text
+for ghs3d, for example, advanced options. </li>
 
 </ul>
 
@@ -98,9 +100,9 @@ for ghs3d. This allows the input of advanced options in a free from. </li>
 
 \image html ghs3d_enforced_vertices.png
 
-GHS3D algorithm can locally raffine the mesh. It is possible to define enforced vertices in the volume where the mesh will be raffined.
+GHS3D algorithm can locally make the mesh finer. It is possible to define enforced vertices in the volume where the mesh will be detailed.
 
-A node will be created at the enforced vertex coordinates. There is no need to create a vertex in the CAD.
+A node will be created at the enforced vertex coordinates. There is no need to create a vertex in CAD.
 
 An enforced vertex is defined by:
 <ul>
@@ -111,4 +113,4 @@ An enforced vertex is defined by:
 <br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices.
 
 
-*/
\ No newline at end of file
+*/
index 5f07f993cb1dacfb3d9806713852b4da448f0b25..f4b5b2ba5d37e8e37963133a432190abfd73764a 100644 (file)
@@ -2,21 +2,21 @@
 
 \page make_2dmesh_from_3d_page Generate the skin elements (2D) of a mesh having 3D elements
 
-\n This functionality allows you to generate 2D mesh elements as skin
-on existing 3D mesh elements
+\n This functionality allows to generate 2D mesh elements as a skin
+on the existing 3D mesh elements.
 
 <em>To generate 2D mesh:</em>
 <ol>
-<li>From the Modification menu choose the "Create 2D mesh from 3D"
-Mesh item, or invoke from popup menu.
+<li>From the Modification menu choose "Create 2D mesh from 3D"
+item, or choose from the popup menu.
 
 \image html 2d_from_3d_menu.png
 
 The algorithm detects boundary volume faces without connections to
-other volumes and create 2D mesh elements on face nodes. If mesh
-already contains 2D elements on detected nodes - no new element
-created. The result dialog shows mesh information statistic about new
-created 2D mesh elements.
+other volumes and creates 2D mesh elements on face nodes. If the mesh
+already contains 2D elements on the detected nodes, new elements are not
+created. The the resulting dialog shows mesh information statistics
+about the newly created 2D mesh elements.
 </ol>
 
 */
index 4436e092b8eba346290305133d44a6c2638b798d..9b4fa9a025f3ee1463315c6cb2b0d3d5d6a486f3 100644 (file)
@@ -2,27 +2,20 @@
 
 \page radial_quadrangle_1D2D_algo_page Radial Quadrangle 1D2D
 
-\n This algorithm applies to the meshing of a 2D shapes.
-Required conditions: Face must be a full circle or part of circle
-(i.e. number of edges <= 3 and one of them must be a circle curve).
-The resulting mesh consists of triangles (near center point) and
+\n This algorithm applies to the meshing of 2D shapes under the
+following conditions: the face must be a full circle or a part of circle
+(i.e. the number of edges is less or equal to 3 and one of them is a circle curve).
+The resulting mesh consists of triangles (near the center point) and
 quadrangles.
 
-This algorithm also requires the information concerning the number and
-distribution of mesh layers alond a radius of circle. Distribution of
-layers can be set with any of 1D Hypotheses.
-
-Creation hypothesis:
+This algorithm requires the hypothesis indicating the number
+of mesh layers along the radius. The distribution of layers can be set with any 1D Hypothesis.
 
 \image html hypo_radquad_dlg.png
 
-Resulting 3D mesh for the cylinder with <b>RadialQuadrangle_1D2D</b>
-hypothesis for top and bottom faces:
-
-\image html mesh_radquad_01.png
-
-Resulting 2D mesh for the part of circle:
+\image html mesh_radquad_01.png "Radial Quadrangle 2D mesh on the top
+and the bottom faces of a cylinder"
 
-\image html mesh_radquad_02.png
+\image html mesh_radquad_02.png "Radial Quadrangle 2D mesh on a part of circle"
 
 */