1 // Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SMESH_Mesh.idl
24 // 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;
40 interface SMESH_IDSource;
41 typedef sequence<SMESH_IDSource> ListOfIDSources;
43 typedef sequence<double > double_array ;
44 typedef sequence<long > long_array ;
45 typedef sequence<string > string_array ;
46 typedef sequence<long_array> array_of_long_array ;
64 CHANGE_POLYHEDRON_NODES,
85 struct PointStruct { double x;
89 typedef sequence<PointStruct> nodes_array;
91 struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
93 struct AxisStruct { double x;
101 * Node location on a shape
103 struct NodePosition {
105 GEOM::shape_type shapeType;
106 double_array params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
110 * Enumeration for element type, like in SMDS
121 typedef sequence<ElementType> array_of_ElementType ;
124 * Enumeration for element geometry type, like in SMDS
141 * ElementOrder points out entities of what order are requested
144 ORDER_ANY, /*! entities of any order */
145 ORDER_LINEAR, /*! entities of 1st order */
146 ORDER_QUADRATIC /*! entities of 2nd order */
151 * Enumeration of entity type used in mesh info array,
152 * it should be synchronised with enum SMDSAbs_EntityType
161 Entity_Quad_Triangle,
163 Entity_Quad_Quadrangle,
175 Entity_Quad_Polyhedra,
181 * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
183 enum Hypothesis_Status // in the order of severity
186 HYP_MISSING, // algo misses a hypothesis
187 HYP_CONCURENT, // several applicable hypotheses
188 HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
189 HYP_HIDDEN_ALGO, // an algo is hidden by an upper dim algo generating all-dim elements
190 HYP_HIDING_ALGO, // an algo hides lower dim algos by generating all-dim elements
191 HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
192 // for Add/RemoveHypothesis operations
193 HYP_INCOMPATIBLE, // hypothesis does not fit algo
194 HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
195 HYP_ALREADY_EXIST,// such hypothesis already exist
196 HYP_BAD_DIM, // bad dimension
197 HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
198 HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
199 HYP_NEED_SHAPE // algorithm can work on shape only
203 * Enumeration for DriverMED read status (used by ImportMEDFile() method)
205 enum DriverMED_ReadStatus // in the order of severity
208 DRS_EMPTY, // a MED file contains no mesh with the given name
209 DRS_WARN_RENUMBER, // a MED file has overlapped ranges of element numbers,
210 // so the numbers from the file are ignored
211 DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
212 DRS_FAIL // general failure (exception etc.)
216 * Enumeration for DriverMED (used by Perform() method)
218 enum MED_VERSION // in the order of severity
224 typedef sequence<log_block> log_array;
228 * Auxilary flags for advanced extrusion.
229 * BOUNDARY: create or not boundary for result of extrusion
230 * SEW: try to use existing nodes or create new nodes in any case
232 const long EXTRUSION_FLAG_BOUNDARY = 1;
233 const long EXTRUSION_FLAG_SEW = 2;
236 * Structure used in mesh edit preview data (MeshPreviewStruct)
238 struct ElementSubType { ElementType SMDS_ElementType;
240 long nbNodesInElement; };
242 typedef sequence<ElementSubType> types_array;
245 * Structure containing mesh edit preview data
247 struct MeshPreviewStruct { nodes_array nodesXYZ;
248 long_array elementConnectivities;
249 types_array elementTypes; };
251 interface SMESH_Mesh;
253 interface SMESH_IDSource
256 * Returns a sequence of all element IDs
261 * Returns statistic of mesh elements
262 * @return array of number enityties by index of EntityType
264 long_array GetMeshInfo();
267 * Returns types of elements it contains.
268 * It's empty if the SMESH_IDSource contains no IDs
270 array_of_ElementType GetTypes();
275 SMESH_Mesh GetMesh();
278 interface SMESH_Group;
279 interface SMESH_GroupOnGeom;
281 interface SMESH_GroupOnFilter;
282 interface SMESH_subMesh;
283 interface SMESH_MeshEditor;
285 typedef sequence<SMESH_subMesh> submesh_array;
286 typedef sequence<submesh_array> submesh_array_array;
288 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
291 * Return true if there is a geometry to be meshed
293 boolean HasShapeToMesh()
294 raises (SALOME::SALOME_Exception);
297 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
298 * to know if a returned shape
300 GEOM::GEOM_Object GetShapeToMesh()
301 raises (SALOME::SALOME_Exception);
304 * Remove all nodes and elements
307 raises (SALOME::SALOME_Exception);
310 * Get the list of sub-meshes existing in the mesh
312 submesh_array GetSubMeshes()
313 raises (SALOME::SALOME_Exception);
316 * Remove all nodes and elements of submesh
318 void ClearSubMesh(in long ShapeID)
319 raises (SALOME::SALOME_Exception);
322 * Get the subMesh object associated to a subShape. The subMesh object
323 * gives access to nodes and elements IDs.
324 * SubMesh will be used instead of SubShape in a next idl version to
325 * adress a specific subMesh...
327 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
328 raises (SALOME::SALOME_Exception);
333 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
334 raises (SALOME::SALOME_Exception);
340 SMESH_Group CreateGroup( in ElementType elem_type,
342 raises (SALOME::SALOME_Exception);
345 * Create a group from geometry
347 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
349 in GEOM::GEOM_Object geomObject )
350 raises (SALOME::SALOME_Exception);
353 * Create a group from filter
355 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
357 in SMESH::Filter filter )
358 raises (SALOME::SALOME_Exception);
363 void RemoveGroup(in SMESH_GroupBase aGroup)
364 raises (SALOME::SALOME_Exception);
367 * Remove group with its contents
369 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
370 raises (SALOME::SALOME_Exception);
373 * Get the list of groups existing in the mesh
375 ListOfGroups GetGroups()
376 raises (SALOME::SALOME_Exception);
379 * Get number of groups existing in the mesh
382 raises (SALOME::SALOME_Exception);
385 * Union of two groups
386 * New group is created. All mesh elements that are
387 * present in initial groups are added to the new one
389 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
390 in SMESH_GroupBase aGroup2,
392 raises (SALOME::SALOME_Exception);
395 * Union of list of groups
396 * New group is created. All mesh elements that are
397 * present in initial groups are added to the new one
399 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
401 raises (SALOME::SALOME_Exception);
404 * Intersection of two groups
405 * New group is created. All mesh elements that are
406 * present in both initial groups are added to the new one.
408 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
409 in SMESH_GroupBase aGroup2,
411 raises (SALOME::SALOME_Exception);
414 * Intersection of list of groups
415 * New group is created. All mesh elements that are
416 * present in all initial groups simultaneously are added to the new one.
418 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
420 raises (SALOME::SALOME_Exception);
424 * New group is created. All mesh elements that are present in
425 * main group but do not present in tool group are added to the new one
427 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
428 in SMESH_GroupBase aToolGroup,
430 raises (SALOME::SALOME_Exception);
433 * Cut of lists of groups
434 * New group is created. All mesh elements that are present in
435 * main groups but do not present in tool groups are added to the new one
437 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
438 in ListOfGroups aToolGroups,
440 raises (SALOME::SALOME_Exception);
443 * Create groups of entities from existing groups of superior dimensions
444 * New group is created. System
445 * 1) extracts all nodes from each group,
446 * 2) combines all elements of specified dimension laying on these nodes.
448 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
449 in ElementType anElemType,
451 raises (SALOME::SALOME_Exception);
454 * Convert group on geometry or on filter into standalone group
456 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
457 raises (SALOME::SALOME_Exception);
460 * Add hypothesis to the mesh, under a particular subShape
461 * (or the main shape itself)
462 * The Add method is only used to prepare the build of the mesh and store
463 * the algorithms and associated parameters.
464 * Actual job of mesh the shape is done by MESH_Gen.
466 * - aSubShape : subShape obtained by a shape explode in GEOM
468 * - anHyp : hypothesis object
470 * - OK if the hypothesis is compatible with the subShape
471 * (and all previous hypothesis on the subShape)
472 * - NOK if the hypothesis is not compatible with the subShape
473 * (or one previous hypothesis on the subShape)
474 * raises exception if hypothesis has not been created
476 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
477 in SMESH_Hypothesis anHyp)
478 raises (SALOME::SALOME_Exception);
479 // boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
480 // raises (SALOME::SALOME_Exception);
483 * Remove an hypothesis previouly added with AddHypothesis.
485 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
486 in SMESH_Hypothesis anHyp)
487 raises (SALOME::SALOME_Exception);
488 // boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
489 // in SMESH_Hypothesis anHyp)
490 // raises (SALOME::SALOME_Exception);
493 * Get the list of hypothesis added on a subShape
495 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
496 raises (SALOME::SALOME_Exception);
497 // ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
498 // raises (SALOME::SALOME_Exception);
501 * Get the log of nodes and elements added or removed since previous
504 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
506 // string_array GetLog(in boolean clearAfterGet)
507 // raises (SALOME::SALOME_Exception);
508 log_array GetLog(in boolean clearAfterGet)
509 raises (SALOME::SALOME_Exception);
512 * Clear the log of nodes and elements added or removed since previous
513 * clear. Must be used immediately after GetLog if clearAfterGet is false.
516 raises (SALOME::SALOME_Exception);
519 * Toggle auto color mode on the object.
521 * - theAutoColor : flag which toggles auto color mode.
523 void SetAutoColor(in boolean theAutoColor)
524 raises (SALOME::SALOME_Exception);
527 * Get flag of object's auto color mode.
529 boolean GetAutoColor()
530 raises (SALOME::SALOME_Exception);
533 * Get the internal Id
543 * Obtain instance of SMESH_MeshEditor
545 SMESH_MeshEditor GetMeshEditor()
546 raises (SALOME::SALOME_Exception);
549 * Return SMESH_MeshEditor that would not modify the mesh but
550 * fill MeshPreviewStruct
552 SMESH_MeshEditor GetMeshEditPreviewer()
553 raises (SALOME::SALOME_Exception);
556 * Return true if the mesh has been edited since a total re-compute
557 * and those modifications may prevent successful partial re-compute
559 boolean HasModificationsToDiscard()
560 raises (SALOME::SALOME_Exception);
562 /*! Check group names for duplications.
563 * Consider maximum group name length stored in MED file.
565 boolean HasDuplicatedGroupNamesMED();
568 * Export Mesh to different MED Formats
570 * - file : name of the MED file
571 * - auto_groups : boolean parameter for creating/not creating
572 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
573 * the typical use is auto_groups=false.
574 * - version : define the version of format of MED file, that will be created
575 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
577 void ExportToMEDX( in string file,
578 in boolean auto_groups,
579 in MED_VERSION version,
580 in boolean overwrite ) raises (SALOME::SALOME_Exception);
583 * Export a part of Mesh into a MED file
585 * - meshPart : a part of mesh to store
586 * - file : name of the MED file
587 * - version : define the version of format of MED file, that will be created
588 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
590 void ExportPartToMED( in SMESH_IDSource meshPart,
592 in boolean auto_groups,
593 in MED_VERSION version,
594 in boolean overwrite ) raises (SALOME::SALOME_Exception);
597 * Export Mesh to different MED Formats
598 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
599 * The method is kept in order to support old functionality
601 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
602 raises (SALOME::SALOME_Exception);
605 * Export Mesh to MED_V2_1 MED format
606 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
607 * and overwrite parameter equal to true
608 * The method is kept in order to support old functionality
610 void ExportMED( in string file, in boolean auto_groups )
611 raises (SALOME::SALOME_Exception);
614 * Return string representation of a MED file version comprising nbDigits
616 string GetVersionString(in MED_VERSION version, in short nbDigits);
619 * Export Mesh to DAT, UNV and STL Formats
620 * (UNV supported version is I-DEAS 10)
622 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
623 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
624 void ExportSTL( in string file,
625 in boolean isascii ) raises (SALOME::SALOME_Exception);
626 void ExportCGNS( in SMESH_IDSource meshPart,
628 in boolean overwrite ) raises (SALOME::SALOME_Exception);
629 void ExportPartToDAT( in SMESH_IDSource meshPart,
630 in string file ) raises (SALOME::SALOME_Exception);
631 void ExportPartToUNV( in SMESH_IDSource meshPart,
632 in string file ) raises (SALOME::SALOME_Exception);
633 void ExportPartToSTL( in SMESH_IDSource meshPart,
635 in boolean isascii ) raises (SALOME::SALOME_Exception);
640 SALOME_MED::MESH GetMEDMesh()
641 raises (SALOME::SALOME_Exception);
644 * Get informations about mesh contents
647 raises (SALOME::SALOME_Exception);
650 raises (SALOME::SALOME_Exception);
653 raises (SALOME::SALOME_Exception);
656 raises (SALOME::SALOME_Exception);
658 long NbEdgesOfOrder(in ElementOrder order)
659 raises (SALOME::SALOME_Exception);
662 raises (SALOME::SALOME_Exception);
664 long NbFacesOfOrder(in ElementOrder order)
665 raises (SALOME::SALOME_Exception);
668 raises (SALOME::SALOME_Exception);
670 long NbTrianglesOfOrder(in ElementOrder order)
671 raises (SALOME::SALOME_Exception);
674 raises (SALOME::SALOME_Exception);
676 long NbQuadranglesOfOrder(in ElementOrder order)
677 raises (SALOME::SALOME_Exception);
680 raises (SALOME::SALOME_Exception);
683 raises (SALOME::SALOME_Exception);
685 long NbVolumesOfOrder(in ElementOrder order)
686 raises (SALOME::SALOME_Exception);
689 raises (SALOME::SALOME_Exception);
691 long NbTetrasOfOrder(in ElementOrder order)
692 raises (SALOME::SALOME_Exception);
695 raises (SALOME::SALOME_Exception);
697 long NbHexasOfOrder(in ElementOrder order)
698 raises (SALOME::SALOME_Exception);
701 raises (SALOME::SALOME_Exception);
703 long NbPyramidsOfOrder(in ElementOrder order)
704 raises (SALOME::SALOME_Exception);
707 raises (SALOME::SALOME_Exception);
709 long NbPrismsOfOrder(in ElementOrder order)
710 raises (SALOME::SALOME_Exception);
713 raises (SALOME::SALOME_Exception);
716 raises (SALOME::SALOME_Exception);
718 long_array GetElementsId()
719 raises (SALOME::SALOME_Exception);
721 long_array GetElementsByType( in ElementType theType )
722 raises (SALOME::SALOME_Exception);
724 long_array GetNodesId()
725 raises (SALOME::SALOME_Exception);
728 * Returns type of mesh element
730 ElementType GetElementType( in long id, in boolean iselem )
731 raises (SALOME::SALOME_Exception);
733 EntityType GetElementGeomType( in long id )
734 raises (SALOME::SALOME_Exception);
736 long_array GetSubMeshElementsId(in long ShapeID)
737 raises (SALOME::SALOME_Exception);
739 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
740 raises (SALOME::SALOME_Exception);
742 ElementType GetSubMeshElementType(in long ShapeID)
743 raises (SALOME::SALOME_Exception);
747 * Methods to set meshing order of submeshes
751 * \brief Return submesh objects list in meshing order
753 submesh_array_array GetMeshOrder();
756 * \brief Set submesh object order
758 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
762 * Get mesh description
769 long long GetMeshPtr();
772 * Get XYZ coordinates of node as list of double
773 * If there is not node for given ID - returns empty list
775 double_array GetNodeXYZ(in long id);
778 * For given node returns list of IDs of inverse elements
779 * If there is not node for given ID - returns empty list
781 long_array GetNodeInverseElements(in long id);
784 * \brief Return position of a node on shape
786 NodePosition GetNodePosition(in long NodeID);
789 * If given element is node returns IDs of shape from position
790 * If there is not node for given ID - returns -1
792 long GetShapeID(in long id);
795 * For given element returns ID of result shape after
796 * ::FindShape() from SMESH_MeshEditor
797 * If there is not element for given ID - returns -1
799 long GetShapeIDForElem(in long id);
802 * Returns number of nodes for given element
803 * If there is not element for given ID - returns -1
805 long GetElemNbNodes(in long id);
808 * Returns IDs of nodes of given element
810 long_array GetElemNodes(in long id);
813 * Returns ID of node by given index for given element
814 * If there is not element for given ID - returns -1
815 * If there is not node for given index - returns -2
817 long GetElemNode(in long id, in long index);
820 * Returns true if given node is medium node
821 * in given quadratic element
823 boolean IsMediumNode(in long ide, in long idn);
826 * Returns true if given node is medium node
827 * in one of quadratic elements
829 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
832 * Returns number of edges for given element
834 long ElemNbEdges(in long id);
837 * Returns number of faces for given element
839 long ElemNbFaces(in long id);
842 * Returns nodes of given face (counted from zero) for given volumic element.
844 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
847 * Returns an element based on all given nodes.
849 long FindElementByNodes(in long_array nodes);
852 * Returns true if given element is polygon
854 boolean IsPoly(in long id);
857 * Returns true if given element is quadratic
859 boolean IsQuadratic(in long id);
862 * Returns XYZ coordinates of bary center for given element
864 * If there is not element for given ID - returns empty list
866 double_array BaryCenter(in long id);
868 /*! Gets information about imported MED file */
869 SALOME_MED::MedFileInfo GetMEDFileInfo();
872 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
873 * \param theParameters is a string containing the notebook variables
875 void SetParameters (in string theParameters);
878 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
880 string GetParameters();
883 * Returns list of notebook variables used for last Mesh operation
885 string_array GetLastParameters();
888 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
893 long GetNumberOfElements()
894 raises (SALOME::SALOME_Exception);
899 long GetNumberOfNodes( in boolean all )
900 raises (SALOME::SALOME_Exception);
905 long_array GetElementsId()
906 raises (SALOME::SALOME_Exception);
911 long_array GetElementsByType( in ElementType theType )
912 raises (SALOME::SALOME_Exception);
915 * Return type of submesh element
917 ElementType GetElementType( in long id, in boolean iselem )
918 raises (SALOME::SALOME_Exception);
923 long_array GetNodesId()
924 raises (SALOME::SALOME_Exception);
927 * Get geom shape the submesh is dedicated to
929 GEOM::GEOM_Object GetSubShape()
930 raises (SALOME::SALOME_Exception);
933 * Get SMESH_Mesh which stores nodes coordinates & elements definition
935 SMESH_Mesh GetFather()
936 raises (SALOME::SALOME_Exception);
939 * Get the internal Id
946 SALOME_MED::FAMILY GetFamily()
947 raises (SALOME::SALOME_Exception);