1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License.
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMESH_Mesh.idl
23 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_MESH_IDL_
27 #define _SMESH_MESH_IDL_
29 #include "SALOME_Exception.idl"
30 #include "SALOME_GenericObj.idl"
31 #include "GEOM_Gen.idl"
36 interface SMESH_Hypothesis;
37 typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
38 interface SMESH_GroupBase;
39 typedef sequence<SMESH_GroupBase> ListOfGroups;
41 typedef sequence<double > double_array ;
42 typedef sequence<long > long_array ;
43 typedef sequence<string > string_array ;
44 typedef sequence<long_array> array_of_long_array ;
62 CHANGE_POLYHEDRON_NODES,
81 struct PointStruct { double x;
85 typedef sequence<PointStruct> nodes_array;
87 struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
89 struct AxisStruct { double x;
97 * Node location on a shape
101 GEOM::shape_type shapeType;
102 double_array params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
106 * Enumeration for element type, like in SMDS
118 * ElementOrder points out entities of what order are requested
121 ORDER_ANY, /*! entities of any order */
122 ORDER_LINEAR, /*! entities of 1st order */
123 ORDER_QUADRATIC /*! entities of 2nd order */
127 * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
129 enum Hypothesis_Status // in the order of severity
132 HYP_MISSING, // algo misses a hypothesis
133 HYP_CONCURENT, // several applicable hypotheses
134 HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
135 HYP_HIDDEN_ALGO, // an algo is hidden by an upper dim algo generating all-dim elements
136 HYP_HIDING_ALGO, // an algo hides lower dim algos by generating all-dim elements
137 HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
138 // for Add/RemoveHypothesis operations
139 HYP_INCOMPATIBLE, // hypothesis does not fit algo
140 HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
141 HYP_ALREADY_EXIST,// such hypothesis already exist
142 HYP_BAD_DIM, // bad dimension
143 HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
144 HYP_BAD_GEOMETRY // geometry mismatches algorithm's expectation
148 * Enumeration for DriverMED read status (used by ImportMEDFile() method)
150 enum DriverMED_ReadStatus // in the order of severity
153 DRS_EMPTY, // a MED file contains no mesh with the given name
154 DRS_WARN_RENUMBER, // a MED file has overlapped ranges of element numbers,
155 // so the numbers from the file are ignored
156 DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
157 DRS_FAIL // general failure (exception etc.)
161 * Enumeration for DriverMED (used by Perform() method)
163 enum MED_VERSION // in the order of severity
169 typedef sequence<log_block> log_array;
173 * Auxilary flags for advanced extrusion.
174 * BOUNDARY: create or not boundary for result of extrusion
175 * SEW: try to use existing nodes or create new nodes in any case
177 const long EXTRUSION_FLAG_BOUNDARY = 1;
178 const long EXTRUSION_FLAG_SEW = 2;
180 interface SMESH_IDSource
183 * Returns a sequence of all element IDs
188 interface SMESH_Group;
189 interface SMESH_GroupOnGeom;
190 interface SMESH_subMesh;
191 interface SMESH_MeshEditor;
192 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
195 * Return true if there is a geometry to be meshed
197 boolean HasShapeToMesh()
198 raises (SALOME::SALOME_Exception);
201 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
202 * to know if a returned shape
204 GEOM::GEOM_Object GetShapeToMesh()
205 raises (SALOME::SALOME_Exception);
208 * Remove all nodes and elements
211 raises (SALOME::SALOME_Exception);
214 * Get the subMesh object associated to a subShape. The subMesh object
215 * gives access to nodes and elements IDs.
216 * SubMesh will be used instead of SubShape in a next idl version to
217 * adress a specific subMesh...
219 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
220 raises (SALOME::SALOME_Exception);
225 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
226 raises (SALOME::SALOME_Exception);
232 SMESH_Group CreateGroup( in ElementType elem_type,
234 raises (SALOME::SALOME_Exception);
237 * Create a group from geometry group
239 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elem_type,
241 in GEOM::GEOM_Object theGeomObject )
242 raises (SALOME::SALOME_Exception);
247 void RemoveGroup(in SMESH_GroupBase aGroup)
248 raises (SALOME::SALOME_Exception);
251 * Remove group with its contents
253 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
254 raises (SALOME::SALOME_Exception);
257 * Get the list of groups existing in the mesh
259 ListOfGroups GetGroups()
260 raises (SALOME::SALOME_Exception);
263 * Get number of groups existing in the mesh
266 raises (SALOME::SALOME_Exception);
269 * Union of two groups
270 * New group is created. All mesh elements that are
271 * present in initial groups are added to the new one
273 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
274 in SMESH_GroupBase aGroup2,
276 raises (SALOME::SALOME_Exception);
279 * Intersection of two groups
280 * New group is created. All mesh elements that are
281 * present in both initial groups are added to the new one.
283 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
284 in SMESH_GroupBase aGroup2,
286 raises (SALOME::SALOME_Exception);
290 * New group is created. All mesh elements that are present in
291 * main group but do not present in tool group are added to the new one
293 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
294 in SMESH_GroupBase aToolGroup,
296 raises (SALOME::SALOME_Exception);
299 * Add hypothesis to the mesh, under a particular subShape
300 * (or the main shape itself)
301 * The Add method is only used to prepare the build of the mesh and store
302 * the algorithms and associated parameters.
303 * Actual job of mesh the shape is done by MESH_Gen.
305 * - aSubShape : subShape obtained by a shape explode in GEOM
307 * - anHyp : hypothesis object
309 * - OK if the hypothesis is compatible with the subShape
310 * (and all previous hypothesis on the subShape)
311 * - NOK if the hypothesis is not compatible with the subShape
312 * (or one previous hypothesis on the subShape)
313 * raises exception if hypothesis has not been created
315 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
316 in SMESH_Hypothesis anHyp)
317 raises (SALOME::SALOME_Exception);
318 // boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
319 // raises (SALOME::SALOME_Exception);
322 * Remove an hypothesis previouly added with AddHypothesis.
324 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
325 in SMESH_Hypothesis anHyp)
326 raises (SALOME::SALOME_Exception);
327 // boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
328 // in SMESH_Hypothesis anHyp)
329 // raises (SALOME::SALOME_Exception);
332 * Get the list of hypothesis added on a subShape
334 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
335 raises (SALOME::SALOME_Exception);
336 // ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
337 // raises (SALOME::SALOME_Exception);
340 * Get the log of nodes and elements added or removed since previous
343 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
345 // string_array GetLog(in boolean clearAfterGet)
346 // raises (SALOME::SALOME_Exception);
347 log_array GetLog(in boolean clearAfterGet)
348 raises (SALOME::SALOME_Exception);
351 * Clear the log of nodes and elements added or removed since previous
352 * clear. Must be used immediately after GetLog if clearAfterGet is false.
355 raises (SALOME::SALOME_Exception);
358 * Toggle auto color mode on the object.
360 * - theAutoColor : flag which toggles auto color mode.
362 void SetAutoColor(in boolean theAutoColor)
363 raises (SALOME::SALOME_Exception);
366 * Get flag of object's auto color mode.
368 boolean GetAutoColor()
369 raises (SALOME::SALOME_Exception);
372 * Get the internal Id
382 * Obtain instance of SMESH_MeshEditor
384 SMESH_MeshEditor GetMeshEditor()
385 raises (SALOME::SALOME_Exception);
388 * Return SMESH_MeshEditor that would not modify the mesh but
389 * fill MeshPreviewStruct
391 SMESH_MeshEditor GetMeshEditPreviewer()
392 raises (SALOME::SALOME_Exception);
394 /*! Check group names for duplications.
395 * Consider maximum group name length stored in MED file.
397 boolean HasDuplicatedGroupNamesMED();
400 * Export Mesh to different MED Formats
402 * - auto_groups : boolean parameter for creating/not creating
403 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
404 * the typical use is auto_groups=false.
405 * - theVersion : define the version of format of MED file, that will be created
407 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
408 raises (SALOME::SALOME_Exception);
411 * Export Mesh to MED_V2_1 MED format
412 * Works, just the same as ExportToMED, with MED_VERSION parameter equal to MED_V2_1.
413 * The method is kept in order to support old functionality
415 void ExportMED( in string file, in boolean auto_groups )
416 raises (SALOME::SALOME_Exception);
419 * Return string representation of a MED file version comprising nbDigits
421 string GetVersionString(in MED_VERSION version, in short nbDigits);
424 * Export Mesh to DAT, UNV and STL Formats
425 * (UNV supported version is I-DEAS 10)
427 void ExportDAT( in string file )
428 raises (SALOME::SALOME_Exception);
429 void ExportUNV( in string file )
430 raises (SALOME::SALOME_Exception);
431 void ExportSTL( in string file, in boolean isascii )
432 raises (SALOME::SALOME_Exception);
437 SALOME_MED::MESH GetMEDMesh()
438 raises (SALOME::SALOME_Exception);
441 * Get informations about mesh contents
444 raises (SALOME::SALOME_Exception);
447 raises (SALOME::SALOME_Exception);
450 raises (SALOME::SALOME_Exception);
452 long NbEdgesOfOrder(in ElementOrder order)
453 raises (SALOME::SALOME_Exception);
456 raises (SALOME::SALOME_Exception);
458 long NbFacesOfOrder(in ElementOrder order)
459 raises (SALOME::SALOME_Exception);
462 raises (SALOME::SALOME_Exception);
464 long NbTrianglesOfOrder(in ElementOrder order)
465 raises (SALOME::SALOME_Exception);
468 raises (SALOME::SALOME_Exception);
470 long NbQuadranglesOfOrder(in ElementOrder order)
471 raises (SALOME::SALOME_Exception);
474 raises (SALOME::SALOME_Exception);
477 raises (SALOME::SALOME_Exception);
479 long NbVolumesOfOrder(in ElementOrder order)
480 raises (SALOME::SALOME_Exception);
483 raises (SALOME::SALOME_Exception);
485 long NbTetrasOfOrder(in ElementOrder order)
486 raises (SALOME::SALOME_Exception);
489 raises (SALOME::SALOME_Exception);
491 long NbHexasOfOrder(in ElementOrder order)
492 raises (SALOME::SALOME_Exception);
495 raises (SALOME::SALOME_Exception);
497 long NbPyramidsOfOrder(in ElementOrder order)
498 raises (SALOME::SALOME_Exception);
501 raises (SALOME::SALOME_Exception);
503 long NbPrismsOfOrder(in ElementOrder order)
504 raises (SALOME::SALOME_Exception);
507 raises (SALOME::SALOME_Exception);
510 raises (SALOME::SALOME_Exception);
512 long_array GetElementsId()
513 raises (SALOME::SALOME_Exception);
515 long_array GetElementsByType( in ElementType theType )
516 raises (SALOME::SALOME_Exception);
518 long_array GetNodesId()
519 raises (SALOME::SALOME_Exception);
522 * Returns type of mesh element
524 ElementType GetElementType( in long id, in boolean iselem )
525 raises (SALOME::SALOME_Exception);
527 long_array GetSubMeshElementsId(in long ShapeID)
528 raises (SALOME::SALOME_Exception);
530 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
531 raises (SALOME::SALOME_Exception);
533 ElementType GetSubMeshElementType(in long ShapeID)
534 raises (SALOME::SALOME_Exception);
537 * Get mesh description
544 long long GetMeshPtr();
547 * Get XYZ coordinates of node as list of double
548 * If there is not node for given ID - returns empty list
550 double_array GetNodeXYZ(in long id);
553 * For given node returns list of IDs of inverse elements
554 * If there is not node for given ID - returns empty list
556 long_array GetNodeInverseElements(in long id);
559 * \brief Return position of a node on shape
561 NodePosition GetNodePosition(in long NodeID);
564 * If given element is node returns IDs of shape from position
565 * If there is not node for given ID - returns -1
567 long GetShapeID(in long id);
570 * For given element returns ID of result shape after
571 * ::FindShape() from SMESH_MeshEditor
572 * If there is not element for given ID - returns -1
574 long GetShapeIDForElem(in long id);
577 * Returns number of nodes for given element
578 * If there is not element for given ID - returns -1
580 long GetElemNbNodes(in long id);
583 * Returns IDs of nodes of given element
585 long_array GetElemNodes(in long id);
588 * Returns ID of node by given index for given element
589 * If there is not element for given ID - returns -1
590 * If there is not node for given index - returns -2
592 long GetElemNode(in long id, in long index);
595 * Returns true if given node is medium node
596 * in given quadratic element
598 boolean IsMediumNode(in long ide, in long idn);
601 * Returns true if given node is medium node
602 * in one of quadratic elements
604 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
607 * Returns number of edges for given element
609 long ElemNbEdges(in long id);
612 * Returns number of faces for given element
614 long ElemNbFaces(in long id);
617 * Returns true if given element is polygon
619 boolean IsPoly(in long id);
622 * Returns true if given element is quadratic
624 boolean IsQuadratic(in long id);
627 * Returns XYZ coordinates of bary center for given element
629 * If there is not element for given ID - returns empty list
631 double_array BaryCenter(in long id);
633 /*! Gets information about imported MED file */
634 SALOME_MED::MedFileInfo GetMEDFileInfo();
637 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
642 long GetNumberOfElements()
643 raises (SALOME::SALOME_Exception);
648 long GetNumberOfNodes( in boolean all )
649 raises (SALOME::SALOME_Exception);
654 long_array GetElementsId()
655 raises (SALOME::SALOME_Exception);
660 long_array GetElementsByType( in ElementType theType )
661 raises (SALOME::SALOME_Exception);
664 * Return type of submesh element
666 ElementType GetElementType( in long id, in boolean iselem )
667 raises (SALOME::SALOME_Exception);
672 long_array GetNodesId()
673 raises (SALOME::SALOME_Exception);
676 * Get geom shape the submesh is dedicated to
678 GEOM::GEOM_Object GetSubShape()
679 raises (SALOME::SALOME_Exception);
682 * Get SMESH_Mesh which stores nodes coordinates & elements definition
684 SMESH_Mesh GetFather()
685 raises (SALOME::SALOME_Exception);
688 * Get the internal Id
695 SALOME_MED::FAMILY GetFamily()
696 raises (SALOME::SALOME_Exception);