1 // Copyright (C) 2007-2013 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,
75 ADD_BIQUAD_QUADRANGLE,
89 struct PointStruct { double x;
93 typedef sequence<PointStruct> nodes_array;
95 struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
97 struct AxisStruct { double x;
105 * Node location on a shape
107 struct NodePosition {
109 GEOM::shape_type shapeType;
110 double_array params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
114 * Element location on a shape
116 struct ElementPosition {
118 GEOM::shape_type shapeType;
122 * Enumeration for element type, like in SMDS
134 typedef sequence<ElementType> array_of_ElementType ;
137 * Enumeration for element geometry type, like in SMDS
144 Geom_QUADRANGLE, // when a new GeometryType is added, please
145 Geom_POLYGON, // update a corresponding list in SMESH_2smeshpy.cxx, ln 665
150 Geom_HEXAGONAL_PRISM,
156 * ElementOrder points out entities of what order are requested
159 ORDER_ANY, /*! entities of any order */
160 ORDER_LINEAR, /*! entities of 1st order */
161 ORDER_QUADRATIC /*! entities of 2nd order */
166 * Enumeration of entity type used in mesh info array,
167 * it should be synchronised with enum SMDSAbs_EntityType
176 Entity_Quad_Triangle,
178 Entity_Quad_Quadrangle,
179 Entity_BiQuad_Quadrangle,
191 Entity_Hexagonal_Prism,
193 Entity_Quad_Polyhedra,
200 * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
202 enum Hypothesis_Status // in the order of severity
205 HYP_MISSING, // algo misses a hypothesis
206 HYP_CONCURENT, // several applicable hypotheses
207 HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
208 HYP_HIDDEN_ALGO, // an algo is hidden by an upper dim algo generating all-dim elements
209 HYP_HIDING_ALGO, // an algo hides lower dim algos by generating all-dim elements
210 HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
211 // for Add/RemoveHypothesis operations
212 HYP_INCOMPATIBLE, // hypothesis does not fit algo
213 HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
214 HYP_ALREADY_EXIST,// such hypothesis already exist
215 HYP_BAD_DIM, // bad dimension
216 HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
217 HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
218 HYP_NEED_SHAPE // algorithm can work on shape only
222 * Enumeration for DriverMED read status (used by ImportMEDFile() method)
224 enum DriverMED_ReadStatus // in the order of severity
227 DRS_EMPTY, // a MED file contains no mesh with the given name
228 DRS_WARN_RENUMBER, // a MED file has overlapped ranges of element numbers,
229 // so the numbers from the file are ignored
230 DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
231 DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
232 DRS_FAIL // general failure (exception etc.)
236 * Enumeration for DriverMED (used by Perform() method)
238 enum MED_VERSION // in the order of severity
244 typedef sequence<log_block> log_array;
248 * Auxilary flags for advanced extrusion.
249 * BOUNDARY: create or not boundary for result of extrusion
250 * SEW: try to use existing nodes or create new nodes in any case
252 const long EXTRUSION_FLAG_BOUNDARY = 1;
253 const long EXTRUSION_FLAG_SEW = 2;
256 * Structure used in mesh edit preview data (MeshPreviewStruct)
258 struct ElementSubType { ElementType SMDS_ElementType;
260 long nbNodesInElement; };
262 typedef sequence<ElementSubType> types_array;
265 * Structure containing mesh edit preview data
267 struct MeshPreviewStruct { nodes_array nodesXYZ;
268 long_array elementConnectivities;
269 types_array elementTypes; };
271 interface SMESH_Mesh;
273 interface SMESH_IDSource
276 * Returns a sequence of all element IDs
281 * Returns statistic of mesh elements
282 * @return array of number enityties by index of EntityType
284 long_array GetMeshInfo();
287 * Returns types of elements it contains.
288 * It's empty if the SMESH_IDSource contains no IDs
290 array_of_ElementType GetTypes();
295 SMESH_Mesh GetMesh();
298 * Returns false if GetMeshInfo() returns incorrect information that may
299 * happen if mesh data is not yet fully loaded from the file of study.
301 boolean IsMeshInfoCorrect();
304 interface SMESH_Group;
305 interface SMESH_GroupOnGeom;
307 interface SMESH_GroupOnFilter;
308 interface SMESH_subMesh;
309 interface SMESH_MeshEditor;
311 typedef sequence<SMESH_subMesh> submesh_array;
312 typedef sequence<submesh_array> submesh_array_array;
314 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
317 * Return true if there is a geometry to be meshed
319 boolean HasShapeToMesh()
320 raises (SALOME::SALOME_Exception);
323 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
324 * to know if a returned shape
326 GEOM::GEOM_Object GetShapeToMesh()
327 raises (SALOME::SALOME_Exception);
330 * Return false if the mesh is not yet fully loaded from the study file
333 raises (SALOME::SALOME_Exception);
336 * Load full mesh data from the study file
339 raises (SALOME::SALOME_Exception);
342 * Remove all nodes and elements
345 raises (SALOME::SALOME_Exception);
348 * Get the list of sub-meshes existing in the mesh
350 submesh_array GetSubMeshes()
351 raises (SALOME::SALOME_Exception);
354 * Remove all nodes and elements of submesh
356 void ClearSubMesh(in long ShapeID)
357 raises (SALOME::SALOME_Exception);
360 * Get the subMesh object associated to a Sub-shape. The subMesh object
361 * gives access to nodes and elements IDs.
362 * SubMesh will be used instead of Sub-shape in a next idl version to
363 * adress a specific subMesh...
365 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
366 raises (SALOME::SALOME_Exception);
371 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
372 raises (SALOME::SALOME_Exception);
378 SMESH_Group CreateGroup( in ElementType elem_type,
380 raises (SALOME::SALOME_Exception);
383 * Create a group from geometry
385 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
387 in GEOM::GEOM_Object geomObject )
388 raises (SALOME::SALOME_Exception);
391 * Create a group from filter
393 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
395 in SMESH::Filter filter )
396 raises (SALOME::SALOME_Exception);
401 void RemoveGroup(in SMESH_GroupBase aGroup)
402 raises (SALOME::SALOME_Exception);
405 * Remove group with its contents
407 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
408 raises (SALOME::SALOME_Exception);
411 * Get the list of groups existing in the mesh
413 ListOfGroups GetGroups()
414 raises (SALOME::SALOME_Exception);
417 * Get number of groups existing in the mesh
420 raises (SALOME::SALOME_Exception);
423 * Union of two groups
424 * New group is created. All mesh elements that are
425 * present in initial groups are added to the new one
427 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
428 in SMESH_GroupBase aGroup2,
430 raises (SALOME::SALOME_Exception);
433 * Union of list of groups
434 * New group is created. All mesh elements that are
435 * present in initial groups are added to the new one
437 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
439 raises (SALOME::SALOME_Exception);
442 * Intersection of two groups
443 * New group is created. All mesh elements that are
444 * present in both initial groups are added to the new one.
446 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
447 in SMESH_GroupBase aGroup2,
449 raises (SALOME::SALOME_Exception);
452 * Intersection of list of groups
453 * New group is created. All mesh elements that are
454 * present in all initial groups simultaneously are added to the new one.
456 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
458 raises (SALOME::SALOME_Exception);
462 * New group is created. All mesh elements that are present in
463 * main group but do not present in tool group are added to the new one
465 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
466 in SMESH_GroupBase aToolGroup,
468 raises (SALOME::SALOME_Exception);
471 * Cut of lists of groups
472 * New group is created. All mesh elements that are present in
473 * main groups but do not present in tool groups are added to the new one
475 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
476 in ListOfGroups aToolGroups,
478 raises (SALOME::SALOME_Exception);
481 * Create groups of entities from existing groups of superior dimensions
482 * New group is created. System
483 * 1) extracts all nodes from each group,
484 * 2) combines all elements of specified dimension laying on these nodes.
486 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
487 in ElementType anElemType,
489 raises (SALOME::SALOME_Exception);
492 * Convert group on geometry or on filter into standalone group
494 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
495 raises (SALOME::SALOME_Exception);
498 * Add hypothesis to the mesh, under a particular Sub-shape
499 * (or the main shape itself)
500 * The Add method is only used to prepare the build of the mesh and store
501 * the algorithms and associated parameters.
502 * Actual job of mesh the shape is done by MESH_Gen.
504 * - aSubShape : sub-shape obtained by a shape explode in GEOM
506 * - anHyp : hypothesis object
508 * - OK if the hypothesis is compatible with the sub-shape
509 * (and all previous hypothesis on the sub-shape)
510 * - NOK if the hypothesis is not compatible with the sub-shape
511 * (or one previous hypothesis on the sub-shape)
512 * raises exception if hypothesis has not been created
514 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
515 in SMESH_Hypothesis anHyp)
516 raises (SALOME::SALOME_Exception);
519 * Remove an hypothesis previouly added with AddHypothesis.
521 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
522 in SMESH_Hypothesis anHyp)
523 raises (SALOME::SALOME_Exception);
526 * Get the list of hypothesis added on a sub-shape
528 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
529 raises (SALOME::SALOME_Exception);
532 * Get the log of nodes and elements added or removed since previous
535 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
537 log_array GetLog(in boolean clearAfterGet)
538 raises (SALOME::SALOME_Exception);
541 * Clear the log of nodes and elements added or removed since previous
542 * clear. Must be used immediately after GetLog if clearAfterGet is false.
545 raises (SALOME::SALOME_Exception);
548 * Toggle auto color mode on the object.
550 * - theAutoColor : flag which toggles auto color mode.
552 void SetAutoColor(in boolean theAutoColor)
553 raises (SALOME::SALOME_Exception);
556 * Get flag of object's auto color mode.
558 boolean GetAutoColor()
559 raises (SALOME::SALOME_Exception);
562 * Get the internal Id
572 * Obtain instance of SMESH_MeshEditor
574 SMESH_MeshEditor GetMeshEditor()
575 raises (SALOME::SALOME_Exception);
578 * Return SMESH_MeshEditor that would not modify the mesh but
579 * fill MeshPreviewStruct
581 SMESH_MeshEditor GetMeshEditPreviewer()
582 raises (SALOME::SALOME_Exception);
585 * Return true if the mesh has been edited since a total re-compute
586 * and those modifications may prevent successful partial re-compute
588 boolean HasModificationsToDiscard()
589 raises (SALOME::SALOME_Exception);
591 /*! Check group names for duplications.
592 * Consider maximum group name length stored in MED file.
594 boolean HasDuplicatedGroupNamesMED();
597 * Export Mesh to different MED Formats
599 * - file : name of the MED file
600 * - auto_groups : boolean parameter for creating/not creating
601 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
602 * the typical use is auto_groups=false.
603 * - version : define the version of format of MED file, that will be created
604 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
606 void ExportToMEDX( in string file,
607 in boolean auto_groups,
608 in MED_VERSION version,
609 in boolean overwrite ) raises (SALOME::SALOME_Exception);
612 * Export a part of Mesh into a MED file
614 * - meshPart : a part of mesh to store
615 * - file : name of the MED file
616 * - version : define the version of format of MED file, that will be created
617 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
619 void ExportPartToMED( in SMESH_IDSource meshPart,
621 in boolean auto_groups,
622 in MED_VERSION version,
623 in boolean overwrite ) raises (SALOME::SALOME_Exception);
626 * Export Mesh to different MED Formats
627 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
628 * The method is kept in order to support old functionality
630 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
631 raises (SALOME::SALOME_Exception);
634 * Export Mesh to MED_V2_1 MED format
635 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
636 * and overwrite parameter equal to true
637 * The method is kept in order to support old functionality
639 void ExportMED( in string file, in boolean auto_groups )
640 raises (SALOME::SALOME_Exception);
643 * Export Mesh to SAUV formatted file
644 * Write a temporary med file and use med2sauv
646 void ExportSAUV( in string file, in boolean auto_groups )
647 raises (SALOME::SALOME_Exception);
650 * Return string representation of a MED file version comprising nbDigits
652 string GetVersionString(in MED_VERSION version, in short nbDigits);
655 * Export Mesh to different Formats
656 * (UNV supported version is I-DEAS 10)
658 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
659 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
660 void ExportSTL( in string file,
661 in boolean isascii ) raises (SALOME::SALOME_Exception);
662 void ExportCGNS( in SMESH_IDSource meshPart,
664 in boolean overwrite ) raises (SALOME::SALOME_Exception);
665 void ExportGMF( in SMESH_IDSource meshPart,
667 in boolean withRequiredGroups) raises (SALOME::SALOME_Exception);
668 void ExportPartToDAT( in SMESH_IDSource meshPart,
669 in string file ) raises (SALOME::SALOME_Exception);
670 void ExportPartToUNV( in SMESH_IDSource meshPart,
671 in string file ) raises (SALOME::SALOME_Exception);
672 void ExportPartToSTL( in SMESH_IDSource meshPart,
674 in boolean isascii ) raises (SALOME::SALOME_Exception);
679 SALOME_MED::MESH GetMEDMesh()
680 raises (SALOME::SALOME_Exception);
683 * Get informations about mesh contents
686 raises (SALOME::SALOME_Exception);
689 raises (SALOME::SALOME_Exception);
692 raises (SALOME::SALOME_Exception);
695 raises (SALOME::SALOME_Exception);
698 raises (SALOME::SALOME_Exception);
700 long NbEdgesOfOrder(in ElementOrder order)
701 raises (SALOME::SALOME_Exception);
704 raises (SALOME::SALOME_Exception);
706 long NbFacesOfOrder(in ElementOrder order)
707 raises (SALOME::SALOME_Exception);
710 raises (SALOME::SALOME_Exception);
712 long NbTrianglesOfOrder(in ElementOrder order)
713 raises (SALOME::SALOME_Exception);
716 raises (SALOME::SALOME_Exception);
718 long NbQuadranglesOfOrder(in ElementOrder order)
719 raises (SALOME::SALOME_Exception);
721 long NbBiQuadQuadrangles()
722 raises (SALOME::SALOME_Exception);
725 raises (SALOME::SALOME_Exception);
728 raises (SALOME::SALOME_Exception);
730 long NbVolumesOfOrder(in ElementOrder order)
731 raises (SALOME::SALOME_Exception);
734 raises (SALOME::SALOME_Exception);
736 long NbTetrasOfOrder(in ElementOrder order)
737 raises (SALOME::SALOME_Exception);
740 raises (SALOME::SALOME_Exception);
742 long NbHexasOfOrder(in ElementOrder order)
743 raises (SALOME::SALOME_Exception);
745 long NbTriQuadraticHexas()
746 raises (SALOME::SALOME_Exception);
749 raises (SALOME::SALOME_Exception);
751 long NbPyramidsOfOrder(in ElementOrder order)
752 raises (SALOME::SALOME_Exception);
755 raises (SALOME::SALOME_Exception);
757 long NbPrismsOfOrder(in ElementOrder order)
758 raises (SALOME::SALOME_Exception);
760 long NbHexagonalPrisms()
761 raises (SALOME::SALOME_Exception);
764 raises (SALOME::SALOME_Exception);
767 raises (SALOME::SALOME_Exception);
769 long_array GetElementsId()
770 raises (SALOME::SALOME_Exception);
772 long_array GetElementsByType( in ElementType theType )
773 raises (SALOME::SALOME_Exception);
775 long_array GetNodesId()
776 raises (SALOME::SALOME_Exception);
779 * Returns type of mesh element
781 ElementType GetElementType( in long id, in boolean iselem )
782 raises (SALOME::SALOME_Exception);
784 EntityType GetElementGeomType( in long id )
785 raises (SALOME::SALOME_Exception);
787 long_array GetSubMeshElementsId(in long ShapeID)
788 raises (SALOME::SALOME_Exception);
790 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
791 raises (SALOME::SALOME_Exception);
793 ElementType GetSubMeshElementType(in long ShapeID)
794 raises (SALOME::SALOME_Exception);
798 * Methods to set meshing order of submeshes
802 * \brief Return submesh objects list in meshing order
804 submesh_array_array GetMeshOrder();
807 * \brief Set submesh object order
809 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
813 * Get mesh description
820 long long GetMeshPtr();
823 * Get XYZ coordinates of node as list of double
824 * If there is not node for given ID - returns empty list
826 double_array GetNodeXYZ(in long id);
829 * For given node returns list of IDs of inverse elements
830 * If there is not node for given ID - returns empty list
832 long_array GetNodeInverseElements(in long id);
835 * \brief Return position of a node on shape
837 NodePosition GetNodePosition(in long NodeID);
840 * \brief Return position of an element on shape
842 ElementPosition GetElementPosition(in long ElemID);
845 * If given element is node returns IDs of shape from position
846 * If there is not node for given ID - returns -1
848 long GetShapeID(in long id);
851 * For given element returns ID of result shape after
852 * ::FindShape() from SMESH_MeshEditor
853 * If there is not element for given ID - returns -1
855 long GetShapeIDForElem(in long id);
858 * Returns number of nodes for given element
859 * If there is not element for given ID - returns -1
861 long GetElemNbNodes(in long id);
864 * Returns IDs of nodes of given element
866 long_array GetElemNodes(in long id);
869 * Returns ID of node by given index for given element
870 * If there is not element for given ID - returns -1
871 * If there is not node for given index - returns -2
873 long GetElemNode(in long id, in long index);
876 * Returns true if given node is medium node
877 * in given quadratic element
879 boolean IsMediumNode(in long ide, in long idn);
882 * Returns true if given node is medium node
883 * in one of quadratic elements
885 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
888 * Returns number of edges for given element
890 long ElemNbEdges(in long id);
893 * Returns number of faces for given element
895 long ElemNbFaces(in long id);
898 * Returns nodes of given face (counted from zero) for given volumic element.
900 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
903 * Returns an element based on all given nodes.
905 long FindElementByNodes(in long_array nodes);
908 * Returns true if given element is polygon
910 boolean IsPoly(in long id);
913 * Returns true if given element is quadratic
915 boolean IsQuadratic(in long id);
918 * Returns diameter of a ball discrete element or zero in case of an invalid \a id
920 double GetBallDiameter(in long id);
923 * Returns XYZ coordinates of bary center for given element
925 * If there is not element for given ID - returns empty list
927 double_array BaryCenter(in long id);
929 /*! Gets information about imported MED file */
930 SALOME_MED::MedFileInfo GetMEDFileInfo();
933 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
934 * \param theParameters is a string containing the notebook variables
936 void SetParameters (in string theParameters);
939 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
941 string GetParameters();
944 * Returns list of notebook variables used for last Mesh operation
946 string_array GetLastParameters();
949 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
954 long GetNumberOfElements()
955 raises (SALOME::SALOME_Exception);
960 long GetNumberOfNodes( in boolean all )
961 raises (SALOME::SALOME_Exception);
966 long_array GetElementsId()
967 raises (SALOME::SALOME_Exception);
972 long_array GetElementsByType( in ElementType theType )
973 raises (SALOME::SALOME_Exception);
976 * Return type of submesh element
978 ElementType GetElementType( in long id, in boolean iselem )
979 raises (SALOME::SALOME_Exception);
984 long_array GetNodesId()
985 raises (SALOME::SALOME_Exception);
988 * Get geom shape the submesh is dedicated to
990 GEOM::GEOM_Object GetSubShape()
991 raises (SALOME::SALOME_Exception);
994 * Get SMESH_Mesh which stores nodes coordinates & elements definition
996 SMESH_Mesh GetFather()
997 raises (SALOME::SALOME_Exception);
1000 * Get the internal Id
1007 SALOME_MED::FAMILY GetFamily()
1008 raises (SALOME::SALOME_Exception);