Salome HOME
PAL 14158 Add the Octree and OctreeNode classes to accelerate detection of close...
[modules/smesh.git] / doc / salome / gui / SMESH / smeshpy_doc / classsmesh_1_1Mesh__Algorithm.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>SALOME - SMESH - v.version: smesh.Mesh_Algorithm Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.4.6 -->
8 <h1>smesh.Mesh_Algorithm Class Reference</h1><!-- doxytag: class="smesh::Mesh_Algorithm" -->Mother class to define algorithm, recommended to don't use directly.  
9 <a href="#_details">More...</a>
10 <p>
11 Inheritance diagram for smesh.Mesh_Algorithm:<p><center><img src="classsmesh_1_1Mesh__Algorithm__inherit__graph.jpg" border="0" usemap="#smesh_8Mesh__Algorithm__inherit__map" alt="Inheritance graph"></center>
12 <map name="smesh_8Mesh__Algorithm__inherit__map">
13 <area href="classsmesh_1_1Mesh__Hexahedron.html" shape="rect" coords="219,8,395,32" alt="">
14 <area href="classsmesh_1_1Mesh__Netgen.html" shape="rect" coords="234,56,381,80" alt="">
15 <area href="classsmesh_1_1Mesh__Quadrangle.html" shape="rect" coords="221,104,394,128" alt="">
16 <area href="classsmesh_1_1Mesh__Segment.html" shape="rect" coords="229,152,386,176" alt="">
17 <area href="classsmesh_1_1Mesh__Tetrahedron.html" shape="rect" coords="219,200,395,224" alt="">
18 <area href="classsmesh_1_1Mesh__Triangle.html" shape="rect" coords="231,248,383,272" alt="">
19 </map>
20 <table border="0" cellpadding="0" cellspacing="0">
21 <tr><td></td></tr>
22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
23 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#39dd34eb5db727c1ff2b69a84df18394">GetSubMesh</a></td></tr>
24
25 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#8451e22abaaba662c00052d95f47f7b0">GetAlgorithm</a></td></tr>
26
27 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the wrapped mesher.  <a href="#8451e22abaaba662c00052d95f47f7b0"></a><br></td></tr>
28 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#cb3346c2c3cd4334e82c951e2b4929ec">TreatHypoStatus</a></td></tr>
29
30 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#cb3346c2c3cd4334e82c951e2b4929ec"></a><br></td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#b0ee92d94d1907fc263864b727685187">Create</a></td></tr>
32
33 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#b0ee92d94d1907fc263864b727685187"></a><br></td></tr>
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#e6c4621e95fa72626c26a320a53c5929">Hypothesis</a></td></tr>
35
36 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#e6c4621e95fa72626c26a320a53c5929"></a><br></td></tr>
37 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
38 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#a2388901def73df05eabdc3dd0aeb876">mesh</a></td></tr>
39
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#b637c67f711a33b32c3b56073a65db52">geom</a></td></tr>
41
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#e31641d994477ff6913cef21bc8eed50">subm</a></td></tr>
43
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#169100dea59b37e7e9a0d155b7208fc8">algo</a></td></tr>
45
46 <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#47bfe89357342e4a889d4723518288e1">mesh</a> = 0</td></tr>
48
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#f6608d059606200dce0679f3367112d1">geom</a> = 0</td></tr>
50
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#981bc18824369ac623f4527b7ddddaf5">subm</a> = 0</td></tr>
52
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#ae7e23c67b8497a4b5bbf0cc53ac6693">algo</a> = 0</td></tr>
54
55 </table>
56 <hr><a name="_details"></a><h2>Detailed Description</h2>
57 More details. 
58 <p>
59 <hr><h2>Member Function Documentation</h2>
60 <a class="anchor" name="39dd34eb5db727c1ff2b69a84df18394"></a><!-- doxytag: member="smesh::Mesh_Algorithm::GetSubMesh" ref="39dd34eb5db727c1ff2b69a84df18394" args="" --><p>
61 <table class="mdTable" cellpadding="2" cellspacing="0">
62   <tr>
63     <td class="mdRow">
64       <table cellpadding="0" cellspacing="0" border="0">
65         <tr>
66           <td class="md" nowrap valign="top">def smesh.Mesh_Algorithm.GetSubMesh           </td>
67           <td class="md" valign="top">(&nbsp;</td>
68           <td class="md" nowrap valign="top">&nbsp;</td>
69           <td class="mdname1" valign="top" nowrap> <em>self</em>          </td>
70           <td class="md" valign="top">&nbsp;)&nbsp;</td>
71           <td class="md" nowrap></td>
72         </tr>
73       </table>
74     </td>
75   </tr>
76 </table>
77 <table cellspacing="5" cellpadding="0" border="0">
78   <tr>
79     <td>
80       &nbsp;
81     </td>
82     <td>
83
84 <p>
85     </td>
86   </tr>
87 </table>
88 <a class="anchor" name="8451e22abaaba662c00052d95f47f7b0"></a><!-- doxytag: member="smesh::Mesh_Algorithm::GetAlgorithm" ref="8451e22abaaba662c00052d95f47f7b0" args="" --><p>
89 <table class="mdTable" cellpadding="2" cellspacing="0">
90   <tr>
91     <td class="mdRow">
92       <table cellpadding="0" cellspacing="0" border="0">
93         <tr>
94           <td class="md" nowrap valign="top">def smesh.Mesh_Algorithm.GetAlgorithm           </td>
95           <td class="md" valign="top">(&nbsp;</td>
96           <td class="md" nowrap valign="top">&nbsp;</td>
97           <td class="mdname1" valign="top" nowrap> <em>self</em>          </td>
98           <td class="md" valign="top">&nbsp;)&nbsp;</td>
99           <td class="md" nowrap></td>
100         </tr>
101       </table>
102     </td>
103   </tr>
104 </table>
105 <table cellspacing="5" cellpadding="0" border="0">
106   <tr>
107     <td>
108       &nbsp;
109     </td>
110     <td>
111
112 <p>
113     </td>
114   </tr>
115 </table>
116 <a class="anchor" name="cb3346c2c3cd4334e82c951e2b4929ec"></a><!-- doxytag: member="smesh::Mesh_Algorithm::TreatHypoStatus" ref="cb3346c2c3cd4334e82c951e2b4929ec" args="" --><p>
117 <table class="mdTable" cellpadding="2" cellspacing="0">
118   <tr>
119     <td class="mdRow">
120       <table cellpadding="0" cellspacing="0" border="0">
121         <tr>
122           <td class="md" nowrap valign="top">def smesh.Mesh_Algorithm.TreatHypoStatus           </td>
123           <td class="md" valign="top">(&nbsp;</td>
124           <td class="md" nowrap valign="top">&nbsp;</td>
125           <td class="mdname" nowrap> <em>self</em>, </td>
126         </tr>
127         <tr>
128           <td class="md" nowrap align="right"></td>
129           <td class="md"></td>
130           <td class="md" nowrap>&nbsp;</td>
131           <td class="mdname" nowrap> <em>status</em>, </td>
132         </tr>
133         <tr>
134           <td class="md" nowrap align="right"></td>
135           <td class="md"></td>
136           <td class="md" nowrap>&nbsp;</td>
137           <td class="mdname" nowrap> <em>hypName</em>, </td>
138         </tr>
139         <tr>
140           <td class="md" nowrap align="right"></td>
141           <td class="md"></td>
142           <td class="md" nowrap>&nbsp;</td>
143           <td class="mdname" nowrap> <em>geomName</em>, </td>
144         </tr>
145         <tr>
146           <td class="md" nowrap align="right"></td>
147           <td class="md"></td>
148           <td class="md" nowrap>&nbsp;</td>
149           <td class="mdname" nowrap> <em>isAlgo</em></td>
150         </tr>
151         <tr>
152           <td class="md"></td>
153           <td class="md">)&nbsp;</td>
154           <td class="md" colspan="2"></td>
155         </tr>
156       </table>
157     </td>
158   </tr>
159 </table>
160 <table cellspacing="5" cellpadding="0" border="0">
161   <tr>
162     <td>
163       &nbsp;
164     </td>
165     <td>
166
167 <p>
168 Print error message if a hypothesis was not assigned.     </td>
169   </tr>
170 </table>
171 <a class="anchor" name="b0ee92d94d1907fc263864b727685187"></a><!-- doxytag: member="smesh::Mesh_Algorithm::Create" ref="b0ee92d94d1907fc263864b727685187" args="" --><p>
172 <table class="mdTable" cellpadding="2" cellspacing="0">
173   <tr>
174     <td class="mdRow">
175       <table cellpadding="0" cellspacing="0" border="0">
176         <tr>
177           <td class="md" nowrap valign="top">def smesh.Mesh_Algorithm.Create           </td>
178           <td class="md" valign="top">(&nbsp;</td>
179           <td class="md" nowrap valign="top">&nbsp;</td>
180           <td class="mdname" nowrap> <em>self</em>, </td>
181         </tr>
182         <tr>
183           <td class="md" nowrap align="right"></td>
184           <td class="md"></td>
185           <td class="md" nowrap>&nbsp;</td>
186           <td class="mdname" nowrap> <em>mesh</em>, </td>
187         </tr>
188         <tr>
189           <td class="md" nowrap align="right"></td>
190           <td class="md"></td>
191           <td class="md" nowrap>&nbsp;</td>
192           <td class="mdname" nowrap> <em>geom</em>, </td>
193         </tr>
194         <tr>
195           <td class="md" nowrap align="right"></td>
196           <td class="md"></td>
197           <td class="md" nowrap>&nbsp;</td>
198           <td class="mdname" nowrap> <em>hypo</em>, </td>
199         </tr>
200         <tr>
201           <td class="md" nowrap align="right"></td>
202           <td class="md"></td>
203           <td class="md" nowrap>&nbsp;</td>
204           <td class="mdname" nowrap> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td>
205         </tr>
206         <tr>
207           <td class="md"></td>
208           <td class="md">)&nbsp;</td>
209           <td class="md" colspan="2"></td>
210         </tr>
211       </table>
212     </td>
213   </tr>
214 </table>
215 <table cellspacing="5" cellpadding="0" border="0">
216   <tr>
217     <td>
218       &nbsp;
219     </td>
220     <td>
221
222 <p>
223     </td>
224   </tr>
225 </table>
226 <a class="anchor" name="e6c4621e95fa72626c26a320a53c5929"></a><!-- doxytag: member="smesh::Mesh_Algorithm::Hypothesis" ref="e6c4621e95fa72626c26a320a53c5929" args="" --><p>
227 <table class="mdTable" cellpadding="2" cellspacing="0">
228   <tr>
229     <td class="mdRow">
230       <table cellpadding="0" cellspacing="0" border="0">
231         <tr>
232           <td class="md" nowrap valign="top">def smesh.Mesh_Algorithm.Hypothesis           </td>
233           <td class="md" valign="top">(&nbsp;</td>
234           <td class="md" nowrap valign="top">&nbsp;</td>
235           <td class="mdname" nowrap> <em>self</em>, </td>
236         </tr>
237         <tr>
238           <td class="md" nowrap align="right"></td>
239           <td class="md"></td>
240           <td class="md" nowrap>&nbsp;</td>
241           <td class="mdname" nowrap> <em>hyp</em>, </td>
242         </tr>
243         <tr>
244           <td class="md" nowrap align="right"></td>
245           <td class="md"></td>
246           <td class="md" nowrap>&nbsp;</td>
247           <td class="mdname" nowrap> <em>args</em> = <code>[]</code>, </td>
248         </tr>
249         <tr>
250           <td class="md" nowrap align="right"></td>
251           <td class="md"></td>
252           <td class="md" nowrap>&nbsp;</td>
253           <td class="mdname" nowrap> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td>
254         </tr>
255         <tr>
256           <td class="md"></td>
257           <td class="md">)&nbsp;</td>
258           <td class="md" colspan="2"></td>
259         </tr>
260       </table>
261     </td>
262   </tr>
263 </table>
264 <table cellspacing="5" cellpadding="0" border="0">
265   <tr>
266     <td>
267       &nbsp;
268     </td>
269     <td>
270
271 <p>
272     </td>
273   </tr>
274 </table>
275 <hr><h2>Field Documentation</h2>
276 <a class="anchor" name="47bfe89357342e4a889d4723518288e1"></a><!-- doxytag: member="smesh::Mesh_Algorithm::mesh" ref="47bfe89357342e4a889d4723518288e1" args="" --><p>
277 <table class="mdTable" cellpadding="2" cellspacing="0">
278   <tr>
279     <td class="mdRow">
280       <table cellpadding="0" cellspacing="0" border="0">
281         <tr>
282           <td class="md" nowrap valign="top">int <a class="el" href="classsmesh_1_1Mesh__Algorithm.html#47bfe89357342e4a889d4723518288e1">smesh.Mesh_Algorithm.mesh</a> = 0<code> [static]</code>          </td>
283         </tr>
284       </table>
285     </td>
286   </tr>
287 </table>
288 <table cellspacing="5" cellpadding="0" border="0">
289   <tr>
290     <td>
291       &nbsp;
292     </td>
293     <td>
294
295 <p>
296     </td>
297   </tr>
298 </table>
299 <a class="anchor" name="f6608d059606200dce0679f3367112d1"></a><!-- doxytag: member="smesh::Mesh_Algorithm::geom" ref="f6608d059606200dce0679f3367112d1" args="" --><p>
300 <table class="mdTable" cellpadding="2" cellspacing="0">
301   <tr>
302     <td class="mdRow">
303       <table cellpadding="0" cellspacing="0" border="0">
304         <tr>
305           <td class="md" nowrap valign="top">int <a class="el" href="classsmesh_1_1Mesh__Algorithm.html#f6608d059606200dce0679f3367112d1">smesh.Mesh_Algorithm.geom</a> = 0<code> [static]</code>          </td>
306         </tr>
307       </table>
308     </td>
309   </tr>
310 </table>
311 <table cellspacing="5" cellpadding="0" border="0">
312   <tr>
313     <td>
314       &nbsp;
315     </td>
316     <td>
317
318 <p>
319     </td>
320   </tr>
321 </table>
322 <a class="anchor" name="981bc18824369ac623f4527b7ddddaf5"></a><!-- doxytag: member="smesh::Mesh_Algorithm::subm" ref="981bc18824369ac623f4527b7ddddaf5" args="" --><p>
323 <table class="mdTable" cellpadding="2" cellspacing="0">
324   <tr>
325     <td class="mdRow">
326       <table cellpadding="0" cellspacing="0" border="0">
327         <tr>
328           <td class="md" nowrap valign="top">int <a class="el" href="classsmesh_1_1Mesh__Algorithm.html#981bc18824369ac623f4527b7ddddaf5">smesh.Mesh_Algorithm.subm</a> = 0<code> [static]</code>          </td>
329         </tr>
330       </table>
331     </td>
332   </tr>
333 </table>
334 <table cellspacing="5" cellpadding="0" border="0">
335   <tr>
336     <td>
337       &nbsp;
338     </td>
339     <td>
340
341 <p>
342     </td>
343   </tr>
344 </table>
345 <a class="anchor" name="ae7e23c67b8497a4b5bbf0cc53ac6693"></a><!-- doxytag: member="smesh::Mesh_Algorithm::algo" ref="ae7e23c67b8497a4b5bbf0cc53ac6693" args="" --><p>
346 <table class="mdTable" cellpadding="2" cellspacing="0">
347   <tr>
348     <td class="mdRow">
349       <table cellpadding="0" cellspacing="0" border="0">
350         <tr>
351           <td class="md" nowrap valign="top">int <a class="el" href="classsmesh_1_1Mesh__Algorithm.html#ae7e23c67b8497a4b5bbf0cc53ac6693">smesh.Mesh_Algorithm.algo</a> = 0<code> [static]</code>          </td>
352         </tr>
353       </table>
354     </td>
355   </tr>
356 </table>
357 <table cellspacing="5" cellpadding="0" border="0">
358   <tr>
359     <td>
360       &nbsp;
361     </td>
362     <td>
363
364 <p>
365     </td>
366   </tr>
367 </table>
368 <a class="anchor" name="a2388901def73df05eabdc3dd0aeb876"></a><!-- doxytag: member="smesh::Mesh_Algorithm::mesh" ref="a2388901def73df05eabdc3dd0aeb876" args="" --><p>
369 <table class="mdTable" cellpadding="2" cellspacing="0">
370   <tr>
371     <td class="mdRow">
372       <table cellpadding="0" cellspacing="0" border="0">
373         <tr>
374           <td class="md" nowrap valign="top"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#47bfe89357342e4a889d4723518288e1">smesh.Mesh_Algorithm.mesh</a>          </td>
375         </tr>
376       </table>
377     </td>
378   </tr>
379 </table>
380 <table cellspacing="5" cellpadding="0" border="0">
381   <tr>
382     <td>
383       &nbsp;
384     </td>
385     <td>
386
387 <p>
388     </td>
389   </tr>
390 </table>
391 <a class="anchor" name="b637c67f711a33b32c3b56073a65db52"></a><!-- doxytag: member="smesh::Mesh_Algorithm::geom" ref="b637c67f711a33b32c3b56073a65db52" args="" --><p>
392 <table class="mdTable" cellpadding="2" cellspacing="0">
393   <tr>
394     <td class="mdRow">
395       <table cellpadding="0" cellspacing="0" border="0">
396         <tr>
397           <td class="md" nowrap valign="top"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#f6608d059606200dce0679f3367112d1">smesh.Mesh_Algorithm.geom</a>          </td>
398         </tr>
399       </table>
400     </td>
401   </tr>
402 </table>
403 <table cellspacing="5" cellpadding="0" border="0">
404   <tr>
405     <td>
406       &nbsp;
407     </td>
408     <td>
409
410 <p>
411     </td>
412   </tr>
413 </table>
414 <a class="anchor" name="e31641d994477ff6913cef21bc8eed50"></a><!-- doxytag: member="smesh::Mesh_Algorithm::subm" ref="e31641d994477ff6913cef21bc8eed50" args="" --><p>
415 <table class="mdTable" cellpadding="2" cellspacing="0">
416   <tr>
417     <td class="mdRow">
418       <table cellpadding="0" cellspacing="0" border="0">
419         <tr>
420           <td class="md" nowrap valign="top"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#981bc18824369ac623f4527b7ddddaf5">smesh.Mesh_Algorithm.subm</a>          </td>
421         </tr>
422       </table>
423     </td>
424   </tr>
425 </table>
426 <table cellspacing="5" cellpadding="0" border="0">
427   <tr>
428     <td>
429       &nbsp;
430     </td>
431     <td>
432
433 <p>
434     </td>
435   </tr>
436 </table>
437 <a class="anchor" name="169100dea59b37e7e9a0d155b7208fc8"></a><!-- doxytag: member="smesh::Mesh_Algorithm::algo" ref="169100dea59b37e7e9a0d155b7208fc8" args="" --><p>
438 <table class="mdTable" cellpadding="2" cellspacing="0">
439   <tr>
440     <td class="mdRow">
441       <table cellpadding="0" cellspacing="0" border="0">
442         <tr>
443           <td class="md" nowrap valign="top"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html#ae7e23c67b8497a4b5bbf0cc53ac6693">smesh.Mesh_Algorithm.algo</a>          </td>
444         </tr>
445       </table>
446     </td>
447   </tr>
448 </table>
449 <table cellspacing="5" cellpadding="0" border="0">
450   <tr>
451     <td>
452       &nbsp;
453     </td>
454     <td>
455
456 <p>
457     </td>
458   </tr>
459 </table>
460 </body>
461 </html>