doc/salome/gui/SMESH/smeshpy_doc/classsmeshDC_1_1Mesh__Algorithm.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
   6    <title>Main Page</title>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css">
   8 <link href="tabs.css" rel="stylesheet" type="text/css">
   9 </head>
  10 <body>
  11 &nbsp;
  12 </body>
  13 </html>
  14 <!-- Generated by Doxygen 1.4.7 -->
  15 <div class="nav">
  16 <a class="el" href="namespacesmeshDC.html">smeshDC</a>.<a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html">Mesh_Algorithm</a></div>
  17 <h1>smeshDC.Mesh_Algorithm Class Reference</h1><!-- doxytag: class="smeshDC::Mesh_Algorithm" -->Mother class to define algorithm, recommended to don't use directly.
  18 <a href="#_details">More...</a>
  19 <p>
  20 Inheritance diagram for smeshDC.Mesh_Algorithm:<p><center><img src="classsmeshDC_1_1Mesh__Algorithm__inherit__graph.jpg" border="0" usemap="#smeshDC_8Mesh__Algorithm__inherit__map" alt="Inheritance graph"></center>
  21 <map name="smeshDC_8Mesh__Algorithm__inherit__map">
  22 <area href="classsmeshDC_1_1Mesh__Hexahedron.html" shape="rect" coords="258,8,466,32" alt="">
  23 <area href="classsmeshDC_1_1Mesh__Netgen.html" shape="rect" coords="274,56,450,80" alt="">
  24 <area href="classsmeshDC_1_1Mesh__Prism3D.html" shape="rect" coords="272,104,453,128" alt="">
  25 <area href="classsmeshDC_1_1Mesh__Projection1D.html" shape="rect" coords="257,152,468,176" alt="">
  26 <area href="classsmeshDC_1_1Mesh__Projection2D.html" shape="rect" coords="257,200,468,224" alt="">
  27 <area href="classsmeshDC_1_1Mesh__Projection3D.html" shape="rect" coords="257,248,468,272" alt="">
  28 <area href="classsmeshDC_1_1Mesh__Quadrangle.html" shape="rect" coords="260,296,465,320" alt="">
  29 <area href="classsmeshDC_1_1Mesh__RadialPrism3D.html" shape="rect" coords="250,344,474,368" alt="">
  30 <area href="classsmeshDC_1_1Mesh__Segment.html" shape="rect" coords="269,392,456,416" alt="">
  31 <area href="classsmeshDC_1_1Mesh__Tetrahedron.html" shape="rect" coords="260,440,465,464" alt="">
  32 <area href="classsmeshDC_1_1Mesh__Triangle.html" shape="rect" coords="273,488,452,512" alt="">
  33 </map>
  34 <table border="0" cellpadding="0" cellspacing="0">
  35 <tr><td></td></tr>
  36 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#d236fbbd88c3548e3e1cbaad693587fd">__init__</a></td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#6e10699dca080739fe879c39242d383f">GetSubMesh</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If the algorithm is global, return 0; <br>
  42  else return the submesh associated to this algorithm.  <a href="#6e10699dca080739fe879c39242d383f"></a><br></td></tr>
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#823bceab89ad9844fbdcf7a2b59b82d4">GetAlgorithm</a></td></tr>
  44
  45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the wrapped mesher.  <a href="#823bceab89ad9844fbdcf7a2b59b82d4"></a><br></td></tr>
  46 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#cc7b73f68fec47890cf16932a71e71ff">GetCompatibleHypothesis</a></td></tr>
  47
  48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get list of hypothesis that can be used with this algorithm.  <a href="#cc7b73f68fec47890cf16932a71e71ff"></a><br></td></tr>
  49 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#07001c3590c379d357754b3a8b4e62f2">GetName</a></td></tr>
  50
  51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get name of algo.  <a href="#07001c3590c379d357754b3a8b4e62f2"></a><br></td></tr>
  52 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#fc9788a5b000f2f7afb7f7e81888bc1d">SetName</a></td></tr>
  53
  54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set name to algo.  <a href="#fc9788a5b000f2f7afb7f7e81888bc1d"></a><br></td></tr>
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#84a52154a90fef60f7939fc73084dea2">GetId</a></td></tr>
  56
  57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get id of algo.  <a href="#84a52154a90fef60f7939fc73084dea2"></a><br></td></tr>
  58 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#6ed4da82cee92b3be4b42debecb10bfd">Create</a></td></tr>
  59
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#6ed4da82cee92b3be4b42debecb10bfd"></a><br></td></tr>
  61 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#088088a4a4c2f4057984a8d5f5af05d0">Hypothesis</a></td></tr>
  62
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#088088a4a4c2f4057984a8d5f5af05d0"></a><br></td></tr>
  64 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#a26131bcccd55e4d89612e43aeba151a">smesh</a></td></tr>
  66
  67 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#389abfff22e0cd47e6fd98f5f5000cfa">mesh</a></td></tr>
  68
  69 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#20ae4013ee7d13170461eca766fdda32">geom</a></td></tr>
  70
  71 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#3292dd6a8b832264d19f199469602054">subm</a></td></tr>
  72
  73 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#f42e17af989dda7a186b5d7e68f2ec71">algo</a></td></tr>
  74
  75 </table>
  76 <hr><a name="_details"></a><h2>Detailed Description</h2>
  77 More details.
  78 <p>
  79 <hr><h2>Member Function Documentation</h2>
  80 <a class="anchor" name="d236fbbd88c3548e3e1cbaad693587fd"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::__init__" ref="d236fbbd88c3548e3e1cbaad693587fd" args="" -->
  81 <div class="memitem">
  82 <div class="memproto">
  83       <table class="memname">
  84         <tr>
  85           <td class="memname">def smeshDC.Mesh_Algorithm.__init__           </td>
  86           <td>(</td>
  87           <td class="paramtype">&nbsp;</td>
  88           <td class="paramname"> <em>self</em>, </td>
  89         </tr>
  90         <tr>
  91           <td class="paramkey"></td>
  92           <td></td>
  93           <td class="paramtype">&nbsp;</td>
  94           <td class="paramname"> <em>smesh</em></td><td>&nbsp;</td>
  95         </tr>
  96         <tr>
  97           <td></td>
  98           <td>)</td>
  99           <td></td><td></td><td width="100%"></td>
 100         </tr>
 101       </table>
 102 </div>
 103 <div class="memdoc">
 104
 105 <p>
 106
 107 </div>
 108 </div><p>
 109 <a class="anchor" name="6e10699dca080739fe879c39242d383f"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::GetSubMesh" ref="6e10699dca080739fe879c39242d383f" args="" -->
 110 <div class="memitem">
 111 <div class="memproto">
 112       <table class="memname">
 113         <tr>
 114           <td class="memname">def smeshDC.Mesh_Algorithm.GetSubMesh           </td>
 115           <td>(</td>
 116           <td class="paramtype">&nbsp;</td>
 117           <td class="paramname"> <em>self</em>          </td>
 118           <td>&nbsp;)&nbsp;</td>
 119           <td width="100%"></td>
 120         </tr>
 121       </table>
 122 </div>
 123 <div class="memdoc">
 124
 125 <p>
 126
 127 </div>
 128 </div><p>
 129 <a class="anchor" name="823bceab89ad9844fbdcf7a2b59b82d4"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::GetAlgorithm" ref="823bceab89ad9844fbdcf7a2b59b82d4" args="" -->
 130 <div class="memitem">
 131 <div class="memproto">
 132       <table class="memname">
 133         <tr>
 134           <td class="memname">def smeshDC.Mesh_Algorithm.GetAlgorithm           </td>
 135           <td>(</td>
 136           <td class="paramtype">&nbsp;</td>
 137           <td class="paramname"> <em>self</em>          </td>
 138           <td>&nbsp;)&nbsp;</td>
 139           <td width="100%"></td>
 140         </tr>
 141       </table>
 142 </div>
 143 <div class="memdoc">
 144
 145 <p>
 146
 147 </div>
 148 </div><p>
 149 <a class="anchor" name="cc7b73f68fec47890cf16932a71e71ff"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::GetCompatibleHypothesis" ref="cc7b73f68fec47890cf16932a71e71ff" args="" -->
 150 <div class="memitem">
 151 <div class="memproto">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">def smeshDC.Mesh_Algorithm.GetCompatibleHypothesis           </td>
 155           <td>(</td>
 156           <td class="paramtype">&nbsp;</td>
 157           <td class="paramname"> <em>self</em>          </td>
 158           <td>&nbsp;)&nbsp;</td>
 159           <td width="100%"></td>
 160         </tr>
 161       </table>
 162 </div>
 163 <div class="memdoc">
 164
 165 <p>
 166
 167 </div>
 168 </div><p>
 169 <a class="anchor" name="07001c3590c379d357754b3a8b4e62f2"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::GetName" ref="07001c3590c379d357754b3a8b4e62f2" args="" -->
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">def smeshDC.Mesh_Algorithm.GetName           </td>
 175           <td>(</td>
 176           <td class="paramtype">&nbsp;</td>
 177           <td class="paramname"> <em>self</em>          </td>
 178           <td>&nbsp;)&nbsp;</td>
 179           <td width="100%"></td>
 180         </tr>
 181       </table>
 182 </div>
 183 <div class="memdoc">
 184
 185 <p>
 186
 187 </div>
 188 </div><p>
 189 <a class="anchor" name="fc9788a5b000f2f7afb7f7e81888bc1d"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::SetName" ref="fc9788a5b000f2f7afb7f7e81888bc1d" args="" -->
 190 <div class="memitem">
 191 <div class="memproto">
 192       <table class="memname">
 193         <tr>
 194           <td class="memname">def smeshDC.Mesh_Algorithm.SetName           </td>
 195           <td>(</td>
 196           <td class="paramtype">&nbsp;</td>
 197           <td class="paramname"> <em>self</em>, </td>
 198         </tr>
 199         <tr>
 200           <td class="paramkey"></td>
 201           <td></td>
 202           <td class="paramtype">&nbsp;</td>
 203           <td class="paramname"> <em>name</em></td><td>&nbsp;</td>
 204         </tr>
 205         <tr>
 206           <td></td>
 207           <td>)</td>
 208           <td></td><td></td><td width="100%"></td>
 209         </tr>
 210       </table>
 211 </div>
 212 <div class="memdoc">
 213
 214 <p>
 215
 216 </div>
 217 </div><p>
 218 <a class="anchor" name="84a52154a90fef60f7939fc73084dea2"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::GetId" ref="84a52154a90fef60f7939fc73084dea2" args="" -->
 219 <div class="memitem">
 220 <div class="memproto">
 221       <table class="memname">
 222         <tr>
 223           <td class="memname">def smeshDC.Mesh_Algorithm.GetId           </td>
 224           <td>(</td>
 225           <td class="paramtype">&nbsp;</td>
 226           <td class="paramname"> <em>self</em>          </td>
 227           <td>&nbsp;)&nbsp;</td>
 228           <td width="100%"></td>
 229         </tr>
 230       </table>
 231 </div>
 232 <div class="memdoc">
 233
 234 <p>
 235
 236 </div>
 237 </div><p>
 238 <a class="anchor" name="6ed4da82cee92b3be4b42debecb10bfd"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::Create" ref="6ed4da82cee92b3be4b42debecb10bfd" args="" -->
 239 <div class="memitem">
 240 <div class="memproto">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">def smeshDC.Mesh_Algorithm.Create           </td>
 244           <td>(</td>
 245           <td class="paramtype">&nbsp;</td>
 246           <td class="paramname"> <em>self</em>, </td>
 247         </tr>
 248         <tr>
 249           <td class="paramkey"></td>
 250           <td></td>
 251           <td class="paramtype">&nbsp;</td>
 252           <td class="paramname"> <em>mesh</em>, </td>
 253         </tr>
 254         <tr>
 255           <td class="paramkey"></td>
 256           <td></td>
 257           <td class="paramtype">&nbsp;</td>
 258           <td class="paramname"> <em>geom</em>, </td>
 259         </tr>
 260         <tr>
 261           <td class="paramkey"></td>
 262           <td></td>
 263           <td class="paramtype">&nbsp;</td>
 264           <td class="paramname"> <em>hypo</em>, </td>
 265         </tr>
 266         <tr>
 267           <td class="paramkey"></td>
 268           <td></td>
 269           <td class="paramtype">&nbsp;</td>
 270           <td class="paramname"> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td><td>&nbsp;</td>
 271         </tr>
 272         <tr>
 273           <td></td>
 274           <td>)</td>
 275           <td></td><td></td><td width="100%"></td>
 276         </tr>
 277       </table>
 278 </div>
 279 <div class="memdoc">
 280
 281 <p>
 282
 283 </div>
 284 </div><p>
 285 <a class="anchor" name="088088a4a4c2f4057984a8d5f5af05d0"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::Hypothesis" ref="088088a4a4c2f4057984a8d5f5af05d0" args="" -->
 286 <div class="memitem">
 287 <div class="memproto">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname">def smeshDC.Mesh_Algorithm.Hypothesis           </td>
 291           <td>(</td>
 292           <td class="paramtype">&nbsp;</td>
 293           <td class="paramname"> <em>self</em>, </td>
 294         </tr>
 295         <tr>
 296           <td class="paramkey"></td>
 297           <td></td>
 298           <td class="paramtype">&nbsp;</td>
 299           <td class="paramname"> <em>hyp</em>, </td>
 300         </tr>
 301         <tr>
 302           <td class="paramkey"></td>
 303           <td></td>
 304           <td class="paramtype">&nbsp;</td>
 305           <td class="paramname"> <em>args</em> = <code>[]</code>, </td>
 306         </tr>
 307         <tr>
 308           <td class="paramkey"></td>
 309           <td></td>
 310           <td class="paramtype">&nbsp;</td>
 311           <td class="paramname"> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td><td>&nbsp;</td>
 312         </tr>
 313         <tr>
 314           <td></td>
 315           <td>)</td>
 316           <td></td><td></td><td width="100%"></td>
 317         </tr>
 318       </table>
 319 </div>
 320 <div class="memdoc">
 321
 322 <p>
 323
 324 </div>
 325 </div><p>
 326 <hr><h2>Field Documentation</h2>
 327 <a class="anchor" name="a26131bcccd55e4d89612e43aeba151a"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::smesh" ref="a26131bcccd55e4d89612e43aeba151a" args="" -->
 328 <div class="memitem">
 329 <div class="memproto">
 330       <table class="memname">
 331         <tr>
 332           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#a26131bcccd55e4d89612e43aeba151a">smeshDC.Mesh_Algorithm.smesh</a>          </td>
 333         </tr>
 334       </table>
 335 </div>
 336 <div class="memdoc">
 337
 338 <p>
 339
 340 </div>
 341 </div><p>
 342 <a class="anchor" name="389abfff22e0cd47e6fd98f5f5000cfa"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::mesh" ref="389abfff22e0cd47e6fd98f5f5000cfa" args="" -->
 343 <div class="memitem">
 344 <div class="memproto">
 345       <table class="memname">
 346         <tr>
 347           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#389abfff22e0cd47e6fd98f5f5000cfa">smeshDC.Mesh_Algorithm.mesh</a>          </td>
 348         </tr>
 349       </table>
 350 </div>
 351 <div class="memdoc">
 352
 353 <p>
 354
 355 </div>
 356 </div><p>
 357 <a class="anchor" name="20ae4013ee7d13170461eca766fdda32"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::geom" ref="20ae4013ee7d13170461eca766fdda32" args="" -->
 358 <div class="memitem">
 359 <div class="memproto">
 360       <table class="memname">
 361         <tr>
 362           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#20ae4013ee7d13170461eca766fdda32">smeshDC.Mesh_Algorithm.geom</a>          </td>
 363         </tr>
 364       </table>
 365 </div>
 366 <div class="memdoc">
 367
 368 <p>
 369
 370 <p>
 371 Reimplemented in <a class="el" href="classsmeshDC_1_1Mesh__Segment.html#44e8968ec16413fd4aac2b906c313c0e">smeshDC.Mesh_Segment</a>.
 372 </div>
 373 </div><p>
 374 <a class="anchor" name="3292dd6a8b832264d19f199469602054"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::subm" ref="3292dd6a8b832264d19f199469602054" args="" -->
 375 <div class="memitem">
 376 <div class="memproto">
 377       <table class="memname">
 378         <tr>
 379           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#3292dd6a8b832264d19f199469602054">smeshDC.Mesh_Algorithm.subm</a>          </td>
 380         </tr>
 381       </table>
 382 </div>
 383 <div class="memdoc">
 384
 385 <p>
 386
 387 </div>
 388 </div><p>
 389 <a class="anchor" name="f42e17af989dda7a186b5d7e68f2ec71"></a><!-- doxytag: member="smeshDC::Mesh_Algorithm::algo" ref="f42e17af989dda7a186b5d7e68f2ec71" args="" -->
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#f42e17af989dda7a186b5d7e68f2ec71">smeshDC.Mesh_Algorithm.algo</a>          </td>
 395         </tr>
 396       </table>
 397 </div>
 398 <div class="memdoc">
 399
 400 <p>
 401
 402 </div>
 403 </div><p>
 404 </DIV>
 405 <DIV class="div-footer">
 406 Generated on Thu Jun 21 13:26:41 2007 for SALOME - SMESH - v.4.0.0 by&nbsp;<A href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></A> 1.4.7</DIV>
 407 </BODY>
 408 </HTML>