mirror of
https://git.salome-platform.org/gitpub/modules/smesh.git
synced 2025-01-14 02:30:33 +05:00
NPAL18500: structured help for SMESH python interface.
This commit is contained in:
jfa
parent
b9d1ac1de2
commit
c1d7a51e7e
@ -41,7 +41,9 @@ usr_docs:
|
||||
filesl=`find .`; \
|
||||
for filen in $${filesl}; do \
|
||||
sed 's/\([^s1e]\)smeshDC\|^smeshDC/\1smesh/g' $${filen} > ./tmp; \
|
||||
mv -f tmp $${filen}; \
|
||||
sed 's/smesh:://g' ./tmp > ./tmp1; \
|
||||
rm -f tmp; \
|
||||
mv -f tmp1 $${filen}; \
|
||||
done; \
|
||||
cd ..; \
|
||||
echo "Running doxygen in directory: "`pwd`; \
|
||||
|
||||
@ -138,8 +138,8 @@ split into 20 edges. Default is 0.0.</li>
|
||||
|
||||
<li>\b eps_ends (real) - is used to detect curves whose lengths are very
|
||||
small, which sometimes constitutes an error. A message is printed
|
||||
if<i> fabs(P2-P1) < eps_ends</i>, where </i>P1 and </i>P2 are the
|
||||
extremities of a curve. Default is <i>diag</i>/500.0.
|
||||
if<i> fabs(P2-P1) < eps_ends</i>, where <i>P1</i> and <i>P2</i> are the
|
||||
extremities of a curve. Default is <i>diag</i>/500.0.</li>
|
||||
|
||||
<li>\b prefix (char) - is a prefix of the files generated by
|
||||
BLSURF. Default is "x".</li>
|
||||
@ -196,16 +196,26 @@ String variables:
|
||||
\n
|
||||
Currently BLSURF plugin has the following limitations.
|
||||
<ul>
|
||||
<li>Mesh contains inverted elements, if it is based on shape, consisting of more than one face (box, cone, torus...) and if the option "Allow Quadrangles (Test)" was checked before computation.</li>
|
||||
<li>Mesh contains inverted elements, if it is based on shape,
|
||||
consisting of more than one face (box, cone, torus...) and if
|
||||
the option "Allow Quadrangles (Test)" was checked before
|
||||
computation.</li>
|
||||
|
||||
<li>SIGFPE exception is raised at trying to compute mesh, based on box, with checked option "Patch independent".</l>
|
||||
<li>SIGFPE exception is raised at trying to compute mesh, based on
|
||||
box, with checked option "Patch independent".</li>
|
||||
|
||||
<li>It has been found out that BLSURF algorithm can't be used as a local algorithm (on sub-meshes) and as a provider of low-level mesh for some 3D algorithms because BLSURF mesher (and consequently plugin) does not provide information on node parameters on edges (U) and faces (U,V). For example the following combinations of algorithms are impossible:
|
||||
<ul>
|
||||
<li> global MEFISTO or Quadrangle(mapping) + local BLSURF;</li>
|
||||
<li> BLSUFR + Projection 2D from faces meshed by BLSURF;</li>
|
||||
<li> local BLSURF + Extrusion 3D;
|
||||
</ul>
|
||||
<li>It has been found out that BLSURF algorithm can't be used as a
|
||||
local algorithm (on sub-meshes) and as a provider of low-level
|
||||
mesh for some 3D algorithms because BLSURF mesher (and
|
||||
consequently plugin) does not provide information on node
|
||||
parameters on edges (U) and faces (U,V). For example the
|
||||
following combinations of algorithms are impossible:
|
||||
<ul>
|
||||
<li> global MEFISTO or Quadrangle(mapping) + local BLSURF;</li>
|
||||
<li> BLSUFR + Projection 2D from faces meshed by BLSURF;</li>
|
||||
<li> local BLSURF + Extrusion 3D;</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
*/
|
||||
*/
|
||||
|
||||
@ -8,41 +8,35 @@ selectable in the dialog box.
|
||||
\image html mergeelems.png
|
||||
|
||||
<ul>
|
||||
<li>\b Name is the name of the mesh whose elements will be merged.</li>
|
||||
<li>\b Tolerance is a maximum distance between elements sufficient for
|
||||
merging.
|
||||
<ul>
|
||||
<li>\b Detect button generates the list of coincident elements for the given
|
||||
\b Tolerance.</li>
|
||||
<li>\b Name is the name of the mesh whose elements will be merged.</li>
|
||||
<li>\b Tolerance is a maximum distance between elements sufficient for merging.
|
||||
<ul>
|
||||
<li>\b Detect button generates the list of coincident elements for the given \b Tolerance.</li>
|
||||
</ul></li>
|
||||
<li><b>Coincident elements</b> is a list of groupes of elements for
|
||||
merging. All elements of each group will form one after the operation.
|
||||
<ul>
|
||||
<li>\b Remove button deletes the selected group from the list.</li>
|
||||
<li>\b Add button adds to the list a group of elements selected in the
|
||||
viewer with pressed "Shift" key.</li>
|
||||
<li><b>Select all</b> checkbox selects all groups.</li>
|
||||
</ul></li>
|
||||
<li><b>Edit selected group</b> list allows editing the selected group:
|
||||
<br><br>
|
||||
\image html add.gif
|
||||
<center>adds to the group the element selected in the viewer.</center>
|
||||
<br>
|
||||
\image html remove.gif
|
||||
<center>removes from the group the selected element.</center>
|
||||
<br>
|
||||
\image html sort.gif
|
||||
<center>moves the selected element to the first position in the
|
||||
group. This means that all other elements will be merged into this
|
||||
one.</center>
|
||||
<br>
|
||||
</li>
|
||||
<li>To confirm your choice click \b Apply or <b>Apply and Close</b> button.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b>Coincident elements</b> is a list of groupes of elements for
|
||||
merging. All elements of each group will form one after the operation.
|
||||
<ul>
|
||||
<li>\b Remove button deletes the selected group from the list.</li>
|
||||
<li>\b Add button adds to the list a group of elements selected in the
|
||||
viewer with pressed "Shift" key.</li>
|
||||
<li><b>Select all</b> checkbox selects all groups.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b>Edit selected group</b> list allows editing the selected
|
||||
group:
|
||||
<br><br>
|
||||
\image html add.gif
|
||||
<center>adds to the group the element selected in the viewer.</center>
|
||||
<br>
|
||||
\image html remove.gif
|
||||
<center>removes from the group the selected element.</center>
|
||||
<br>
|
||||
\image html sort.gif
|
||||
<center>moves the selected element to the first position in the
|
||||
group. This means that all other elements will be merged into this
|
||||
one.</center><br>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>To confirm your choice click \b Apply or <b>Apply and Close</b> button.</li>
|
||||
</ol>
|
||||
|
||||
In this picture you see a triangle which coincides with one of the
|
||||
elements of the mesh. After we apply <b>Merge Elements</b> functionality, the
|
||||
@ -50,7 +44,7 @@ triangle will be completely merged with the mesh.
|
||||
|
||||
\image html meshtrianglemergeelem1.png
|
||||
|
||||
<br><b>See Also</b> a sample TUI Script of a
|
||||
\ref tui_merging_elements "Merge Elements" operation.
|
||||
<br><b>See Also</b> a sample TUI Script of a
|
||||
\ref tui_merging_elements "Merge Elements" operation.
|
||||
|
||||
*/
|
||||
|
||||
@ -5,14 +5,25 @@
|
||||
\n Python package smesh defines several classes, destined for easy and
|
||||
clear mesh creation and edition (see the \ref introduction_to_mesh_python_page "example").
|
||||
|
||||
\n Please draw your attention to the below notes before address to
|
||||
the \ref smeshDC "documentation for smesh.py"
|
||||
\n Documentation for smesh package is now available in two forms.
|
||||
|
||||
\n 1. The main page of the \ref smeshDC "documentation for smesh.py"
|
||||
contains a list of data structures and a list of functions,
|
||||
provided by the package smesh.py. The first item in the data
|
||||
structures list (\ref smeshDC::smeshDC "class smesh") also
|
||||
represents documentation for methods of the package smesh.py itself.
|
||||
\n 1. Here you can find <a href="smeshpy_doc/modules.html">structured
|
||||
documentation for smesh package</a>, where all methods and
|
||||
classes are grouped by their functionality, like it is done in
|
||||
the GUI documentation.
|
||||
|
||||
\n 2. And here the \ref smeshDC "linear documentation for smesh package"
|
||||
is represented, grouped only by classes, declared in the smesh.py file.
|
||||
|
||||
\n Please draw your attention to the below notes before address to
|
||||
the documentation"
|
||||
|
||||
\n 1. The main page of the \ref smeshDC "linear documentation for smesh package"
|
||||
contains a list of data structures and a list of
|
||||
functions, provided by the package smesh.py. The first item in
|
||||
the data structures list (\ref smeshDC::smeshDC "class smesh")
|
||||
also represents documentation for methods of the package
|
||||
smesh.py itself.
|
||||
|
||||
\n 2. Package smesh.py gives interface to create and manage
|
||||
meshes. Please, use it to create an empty mesh or to import
|
||||
@ -24,7 +35,7 @@ the \ref smeshDC "documentation for smesh.py"
|
||||
data structures list).
|
||||
|
||||
\n 4. Class Mesh allows to assign algorithms to a mesh.
|
||||
\n \t Please note, that there are always available some algorithms,
|
||||
\n Please note, that there are always available some algorithms,
|
||||
included in standard Salome installation:
|
||||
- REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
|
||||
|
||||
@ -35,7 +46,7 @@ the \ref smeshDC "documentation for smesh.py"
|
||||
\n others are based on commercial meshers:
|
||||
- GHS3D(3D), BLSURF(2D).
|
||||
|
||||
\n \t To add hypotheses, please use interfaces, provided by the
|
||||
\n To add hypotheses, please use interfaces, provided by the
|
||||
assigned algorithms.
|
||||
|
||||
*/
|
||||
|
||||
@ -33,10 +33,10 @@ or some of its elements specifying:
|
||||
\n When <b>Create as new mesh</b> radio button is selected, the source mesh (or elements) remains at its previous location and a new mesh is created at the new location and appears in the Object Browser with the default name MeshName_mirrored (you can change this name in the adjacent box).
|
||||
\n <b> Copy groups </b> checkbox allows copying the groups of elements of the source mesh to the newly created one.
|
||||
|
||||
.
|
||||
|
||||
\par
|
||||
|
||||
<br><b>See Also</b> a sample TUI Script of a
|
||||
\ref tui_symmetry "Symmetry" operation.
|
||||
|
||||
*/
|
||||
*/
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user