Salome HOME
Update page for correct example reference.
[modules/smesh.git] / doc / salome / gui / SMESH / smeshpy_doc / namespacesmesh.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: Package smesh</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>Package smesh</h1>
9 <p>
10 Python package smesh defines several classes, destined for easy and clear mesh creation and edition.
11 <p class="whs2"><a href="../smesh.py_introduction.htm">Example.</a></p>
12 <p>
13 <table border="0" cellpadding="0" cellspacing="0">
14 <tr><td></td></tr>
15 <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
16 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Algorithm.html">Mesh_Algorithm</a></td></tr>
17
18 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mother class to define algorithm, recommended to don't use directly.  <a href="classsmesh_1_1Mesh__Algorithm.html#_details">More...</a><br></td></tr>
19 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Segment.html">Mesh_Segment</a></td></tr>
20
21 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a segment 1D algorithm for discretization.  <a href="classsmesh_1_1Mesh__Segment.html#_details">More...</a><br></td></tr>
22 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Segment__Python.html">Mesh_Segment_Python</a></td></tr>
23
24 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a segment 1D algorithm for discretization with python function.  <a href="classsmesh_1_1Mesh__Segment__Python.html#_details">More...</a><br></td></tr>
25 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Triangle.html">Mesh_Triangle</a></td></tr>
26
27 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a triangle 2D algorithm.  <a href="classsmesh_1_1Mesh__Triangle.html#_details">More...</a><br></td></tr>
28 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Quadrangle.html">Mesh_Quadrangle</a></td></tr>
29
30 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a quadrangle 2D algorithm.  <a href="classsmesh_1_1Mesh__Quadrangle.html#_details">More...</a><br></td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Tetrahedron.html">Mesh_Tetrahedron</a></td></tr>
32
33 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a tetrahedron 3D algorithm.  <a href="classsmesh_1_1Mesh__Tetrahedron.html#_details">More...</a><br></td></tr>
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Hexahedron.html">Mesh_Hexahedron</a></td></tr>
35
36 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a hexahedron 3D algorithm.  <a href="classsmesh_1_1Mesh__Hexahedron.html#_details">More...</a><br></td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh__Netgen.html">Mesh_Netgen</a></td></tr>
38
39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a NETGEN-based 2D or 3D algorithm that need no discrete boundary (i.e.  <a href="classsmesh_1_1Mesh__Netgen.html#_details">More...</a><br></td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmesh_1_1Mesh.html">Mesh</a></td></tr>
41
42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class to define a mesh.  <a href="classsmesh_1_1Mesh.html#_details">More...</a><br></td></tr>
43 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#78d19ec2e8b9d0290e401878b14ade9c">GetName</a></td></tr>
45
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#79291ef16549a9ea4338f6515d2a3347">SetName</a></td></tr>
47
48 <tr><td colspan="2"><br><h2>Variables</h2></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#85f3ed596d91251bfa3b2d2ac4151739">REGULAR</a> = 1</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="namespacesmesh.html#40eed802c94269a68ec2194609fac2f0">PYTHON</a> = 2</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="namespacesmesh.html#72b65da5195aa8d71574f95e5533d612">NETGEN</a> = 3</td></tr>
54
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#bf6aaa2e2cf565cbe3ae34954dee8926">GHS3D</a> = 4</td></tr>
56
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">tuple&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#6e041b9ca898fefe3ea0abafeed4aff2">smesh</a> = salome.lcc.FindOrLoadComponent(&quot;FactoryServer&quot;, &quot;SMESH&quot;)</td></tr>
58
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesmesh.html#d821cab222bc6c9405a89a6c6082d388">NO_NAME</a> = &quot;NoName&quot;</td></tr>
60
61 </table>
62 <hr><h2>Function Documentation</h2>
63 <a class="anchor" name="78d19ec2e8b9d0290e401878b14ade9c"></a><!-- doxytag: member="smesh::GetName" ref="78d19ec2e8b9d0290e401878b14ade9c" args="" --><p>
64 <table class="mdTable" cellpadding="2" cellspacing="0">
65   <tr>
66     <td class="mdRow">
67       <table cellpadding="0" cellspacing="0" border="0">
68         <tr>
69           <td class="md" nowrap valign="top">def smesh.GetName           </td>
70           <td class="md" valign="top">(&nbsp;</td>
71           <td class="md" nowrap valign="top">&nbsp;</td>
72           <td class="mdname1" valign="top" nowrap> <em>obj</em>          </td>
73           <td class="md" valign="top">&nbsp;)&nbsp;</td>
74           <td class="md" nowrap></td>
75         </tr>
76       </table>
77     </td>
78   </tr>
79 </table>
80 <table cellspacing="5" cellpadding="0" border="0">
81   <tr>
82     <td>
83       &nbsp;
84     </td>
85     <td>
86
87 <p>
88     </td>
89   </tr>
90 </table>
91 <a class="anchor" name="79291ef16549a9ea4338f6515d2a3347"></a><!-- doxytag: member="smesh::SetName" ref="79291ef16549a9ea4338f6515d2a3347" args="" --><p>
92 <table class="mdTable" cellpadding="2" cellspacing="0">
93   <tr>
94     <td class="mdRow">
95       <table cellpadding="0" cellspacing="0" border="0">
96         <tr>
97           <td class="md" nowrap valign="top">def smesh.SetName           </td>
98           <td class="md" valign="top">(&nbsp;</td>
99           <td class="md" nowrap valign="top">&nbsp;</td>
100           <td class="mdname" nowrap> <em>obj</em>, </td>
101         </tr>
102         <tr>
103           <td class="md" nowrap align="right"></td>
104           <td class="md"></td>
105           <td class="md" nowrap>&nbsp;</td>
106           <td class="mdname" nowrap> <em>name</em></td>
107         </tr>
108         <tr>
109           <td class="md"></td>
110           <td class="md">)&nbsp;</td>
111           <td class="md" colspan="2"></td>
112         </tr>
113       </table>
114     </td>
115   </tr>
116 </table>
117 <table cellspacing="5" cellpadding="0" border="0">
118   <tr>
119     <td>
120       &nbsp;
121     </td>
122     <td>
123
124 <p>
125     </td>
126   </tr>
127 </table>
128 <hr><h2>Variable Documentation</h2>
129 <a class="anchor" name="85f3ed596d91251bfa3b2d2ac4151739"></a><!-- doxytag: member="smesh::REGULAR" ref="85f3ed596d91251bfa3b2d2ac4151739" args="" --><p>
130 <table class="mdTable" cellpadding="2" cellspacing="0">
131   <tr>
132     <td class="mdRow">
133       <table cellpadding="0" cellspacing="0" border="0">
134         <tr>
135           <td class="md" nowrap valign="top">int <a class="el" href="namespacesmesh.html#85f3ed596d91251bfa3b2d2ac4151739">smesh.REGULAR</a> = 1<code> [static]</code>          </td>
136         </tr>
137       </table>
138     </td>
139   </tr>
140 </table>
141 <table cellspacing="5" cellpadding="0" border="0">
142   <tr>
143     <td>
144       &nbsp;
145     </td>
146     <td>
147
148 <p>
149     </td>
150   </tr>
151 </table>
152 <a class="anchor" name="40eed802c94269a68ec2194609fac2f0"></a><!-- doxytag: member="smesh::PYTHON" ref="40eed802c94269a68ec2194609fac2f0" args="" --><p>
153 <table class="mdTable" cellpadding="2" cellspacing="0">
154   <tr>
155     <td class="mdRow">
156       <table cellpadding="0" cellspacing="0" border="0">
157         <tr>
158           <td class="md" nowrap valign="top">int <a class="el" href="namespacesmesh.html#40eed802c94269a68ec2194609fac2f0">smesh.PYTHON</a> = 2<code> [static]</code>          </td>
159         </tr>
160       </table>
161     </td>
162   </tr>
163 </table>
164 <table cellspacing="5" cellpadding="0" border="0">
165   <tr>
166     <td>
167       &nbsp;
168     </td>
169     <td>
170
171 <p>
172     </td>
173   </tr>
174 </table>
175 <a class="anchor" name="72b65da5195aa8d71574f95e5533d612"></a><!-- doxytag: member="smesh::NETGEN" ref="72b65da5195aa8d71574f95e5533d612" args="" --><p>
176 <table class="mdTable" cellpadding="2" cellspacing="0">
177   <tr>
178     <td class="mdRow">
179       <table cellpadding="0" cellspacing="0" border="0">
180         <tr>
181           <td class="md" nowrap valign="top">int <a class="el" href="namespacesmesh.html#72b65da5195aa8d71574f95e5533d612">smesh.NETGEN</a> = 3<code> [static]</code>          </td>
182         </tr>
183       </table>
184     </td>
185   </tr>
186 </table>
187 <table cellspacing="5" cellpadding="0" border="0">
188   <tr>
189     <td>
190       &nbsp;
191     </td>
192     <td>
193
194 <p>
195     </td>
196   </tr>
197 </table>
198 <a class="anchor" name="bf6aaa2e2cf565cbe3ae34954dee8926"></a><!-- doxytag: member="smesh::GHS3D" ref="bf6aaa2e2cf565cbe3ae34954dee8926" args="" --><p>
199 <table class="mdTable" cellpadding="2" cellspacing="0">
200   <tr>
201     <td class="mdRow">
202       <table cellpadding="0" cellspacing="0" border="0">
203         <tr>
204           <td class="md" nowrap valign="top">int <a class="el" href="namespacesmesh.html#bf6aaa2e2cf565cbe3ae34954dee8926">smesh.GHS3D</a> = 4<code> [static]</code>          </td>
205         </tr>
206       </table>
207     </td>
208   </tr>
209 </table>
210 <table cellspacing="5" cellpadding="0" border="0">
211   <tr>
212     <td>
213       &nbsp;
214     </td>
215     <td>
216
217 <p>
218     </td>
219   </tr>
220 </table>
221 <a class="anchor" name="6e041b9ca898fefe3ea0abafeed4aff2"></a><!-- doxytag: member="smesh::smesh" ref="6e041b9ca898fefe3ea0abafeed4aff2" args="" --><p>
222 <table class="mdTable" cellpadding="2" cellspacing="0">
223   <tr>
224     <td class="mdRow">
225       <table cellpadding="0" cellspacing="0" border="0">
226         <tr>
227           <td class="md" nowrap valign="top">tuple <a class="el" href="namespacesmesh.html#6e041b9ca898fefe3ea0abafeed4aff2">smesh.smesh</a> = salome.lcc.FindOrLoadComponent(&quot;FactoryServer&quot;, &quot;SMESH&quot;)<code> [static]</code>          </td>
228         </tr>
229       </table>
230     </td>
231   </tr>
232 </table>
233 <table cellspacing="5" cellpadding="0" border="0">
234   <tr>
235     <td>
236       &nbsp;
237     </td>
238     <td>
239
240 <p>
241     </td>
242   </tr>
243 </table>
244 <a class="anchor" name="d821cab222bc6c9405a89a6c6082d388"></a><!-- doxytag: member="smesh::NO_NAME" ref="d821cab222bc6c9405a89a6c6082d388" args="" --><p>
245 <table class="mdTable" cellpadding="2" cellspacing="0">
246   <tr>
247     <td class="mdRow">
248       <table cellpadding="0" cellspacing="0" border="0">
249         <tr>
250           <td class="md" nowrap valign="top">string <a class="el" href="namespacesmesh.html#d821cab222bc6c9405a89a6c6082d388">smesh.NO_NAME</a> = &quot;NoName&quot;<code> [static]</code>          </td>
251         </tr>
252       </table>
253     </td>
254   </tr>
255 </table>
256 <table cellspacing="5" cellpadding="0" border="0">
257   <tr>
258     <td>
259       &nbsp;
260     </td>
261     <td>
262
263 <p>
264     </td>
265   </tr>
266 </table>
267 </body>
268 </html>