Salome HOME
Add possibility to define Local Size via a file
[plugins/netgenplugin.git] / doc / salome / gui / NETGENPLUGIN / input / netgen_2d_3d_hypo.doc
index cf9c245412a452441ecbae586923967e8f103e4d..4ef8e066a9f1e7165878bc60a9607134a946b670 100644 (file)
@@ -1,24 +1,24 @@
 /*!
 
-\page netgen_2d_3d_hypo_page Netgen 2D and 3D hypotheses
+\page netgen_2d_3d_hypo_page NETGEN 2D and 3D hypotheses
 
-<b>Netgen 2D Parameters</b> and <b>Netgen 3D  Parameters</b> hypotheses work only with
-<b>Netgen 1D-2D</b>, <b>Netgen 2D</b>, <b>Netgen 1D-2D-3D</b> and
-<b>Netgen 3D</b> algorithms. <b>Netgen 1D-2D</b> and <b>Netgen
+<b>NETGEN 2D Parameters</b> and <b>NETGEN 3D  Parameters</b> hypotheses work only with
+<b>NETGEN 1D-2D</b>, <b>NETGEN 2D</b>, <b>NETGEN 1D-2D-3D</b> and
+<b>NETGEN 3D</b> algorithms. <b>NETGEN 1D-2D</b> and <b>NETGEN
 1D-2D-3D</b>  algorithms do not require definition of lower-level
 hypotheses and algorithms (2D and 1D for meshing 3D objects and 1D for
 meshing 2D objects).
 
 \image html netgen2d3d.png
-<center><em>Hypothesis dialog boxes of <b>Netgen 1D-2D</b> and <b>Netgen
+<center><em>Hypothesis dialog boxes of <b>NETGEN 1D-2D</b> and <b>NETGEN
       1D-2D-3D</b> algorithms are same</em></center>
 <br>
 
 \image html netgen2d3d_only.png
-<center><em>Dialog boxes of <b>Netgen 2D</b> and <b>Netgen 3D</b>
+<center><em>Dialog boxes of <b>NETGEN 2D</b> and <b>NETGEN 3D</b>
     algorithms </em></center>
 
-- <b>Name</b> - allows to define the name for the algorithm (Netgen
+- <b>Name</b> - allows to define the name for the algorithm (NETGEN
 2D (or 3D) Parameters by default).
 - <b>Max Size</b> - maximum linear dimensions for mesh cells.
 - <b>Min Size</b> - minimum linear dimensions for mesh cells. It is
@@ -42,8 +42,9 @@ size at a given point. This parameter is used only if <b>Limit Size by
 then size of mesh segments and mesh faces on curved edges and surfaces
 is defined using value of <b>Nb Segs per Radius</b> parameter, and
 number of segments on straight edges is defined by values of
-<b>Nb. Segs per Edge</b> parameter. If this box is not checked in,
-then size of elements is defined by three parameters only:
+<b>Nb. Segs per Edge</b> parameter. (<b>Growth rate</b> is also taken
+into account.) If this box is not checked in, then size of elements is
+defined by three parameters only:
 <b>Max Size</b>, <b>Min Size</b> and <b>Growth rate</b>.
 - <b>Allow Quadrangles</b> - if this box is checked in, the mesher
 tries to generate quadrangle 2D mesh. Triangle elements are created
@@ -58,17 +59,37 @@ but are topologically different.
 \image html netgen3d_local_size.png
 
 - <b>Local sizes</b> - allows to define size of elements on and
-around specified geometrical edges and vertices. To define the local
-size it is necessary to select a geometrical edge or vertex in the
-object browser or in the viewer, and to click <b>On Edge</b> or <b>On
-Vertex</b> correspondingly. <b>Name</b> of the geometrical object and
-a default <b>Value</b> will be added in the table where the
-<b>Value</b> can be changed.
+around specified geometrical objects. To define the local
+size it is necessary to select a geometrical objects in the
+object browser or in the viewer, and to click a button corresponding
+to the type of the geometrical objects: <b>On Vertex</b>, <b>On
+  Edge</b> etc. <b>Name</b> of the geometrical object and a
+default <b>Value</b> will be added in the table where the <b>Value</b>
+can be changed.
 - <b>Remove</b> - deletes a selected row from the table.
+- <b>Mesh-size File</b> - opens a dialog to select a file defining
+size of elements. The file includes two obligatory sections. The first
+section defines the size at points. The second section defines the
+size along lines. Let's consider the following sample size file.
+\code
+2
+92.5 92.5 92.5 0.05
+42.5 42.5 42.5 0.04
+1
+25 25 0 25 25 200  0.3
+\endcode
+"2" at the first line means that there are two points in the first
+section.<br>
+"92.5 92.5 92.5 0.05" at the second line means that at the point with
+coordinates (92.5, 92.5, 92.5) size of elements should be 0.05.<br>
+"1" at the fourth line means that there is one line in the second
+section.<br>
+"25 25 0 25 25 200  0.3" means that along the line between points (25,
+25, 0) and (25, 25, 200) size of elements should be 0.3.
 
 \image html netgen2d3d_simple.png
 
-<b>Netgen 2D simple parameters</b> and <b>Netgen 3D simple
+<b>NETGEN 2D simple parameters</b> and <b>NETGEN 3D simple
 parameters</b> allow defining the size of elements for each
 dimension.
 
@@ -92,7 +113,7 @@ volumic elements will be equal to an average area of 2D elements, else
 - <b>Max. Element Volume</b> specifies expected maximum element volume
 of 3d elements.
 
-\note Netgen algorithm does not strictly follow the input
+\note NETGEN algorithm does not strictly follow the input
 parameters. The actual mesh can be more or less dense than
 required. There are several factors in it:
 - NETGEN does not actually use <b>Number of Segments</b> parameter for