1 // Copyright (C) 2007-2012 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_FAIL // general failure (exception etc.)
235 * Enumeration for DriverMED (used by Perform() method)
237 enum MED_VERSION // in the order of severity
243 typedef sequence<log_block> log_array;
247 * Auxilary flags for advanced extrusion.
248 * BOUNDARY: create or not boundary for result of extrusion
249 * SEW: try to use existing nodes or create new nodes in any case
251 const long EXTRUSION_FLAG_BOUNDARY = 1;
252 const long EXTRUSION_FLAG_SEW = 2;
255 * Structure used in mesh edit preview data (MeshPreviewStruct)
257 struct ElementSubType { ElementType SMDS_ElementType;
259 long nbNodesInElement; };
261 typedef sequence<ElementSubType> types_array;
264 * Structure containing mesh edit preview data
266 struct MeshPreviewStruct { nodes_array nodesXYZ;
267 long_array elementConnectivities;
268 types_array elementTypes; };
270 interface SMESH_Mesh;
272 interface SMESH_IDSource
275 * Returns a sequence of all element IDs
280 * Returns statistic of mesh elements
281 * @return array of number enityties by index of EntityType
283 long_array GetMeshInfo();
286 * Returns types of elements it contains.
287 * It's empty if the SMESH_IDSource contains no IDs
289 array_of_ElementType GetTypes();
294 SMESH_Mesh GetMesh();
297 * Returns false if GetMeshInfo() returns incorrect information that may
298 * happen if mesh data is not yet fully loaded from the file of study.
300 boolean IsMeshInfoCorrect();
303 interface SMESH_Group;
304 interface SMESH_GroupOnGeom;
306 interface SMESH_GroupOnFilter;
307 interface SMESH_subMesh;
308 interface SMESH_MeshEditor;
310 typedef sequence<SMESH_subMesh> submesh_array;
311 typedef sequence<submesh_array> submesh_array_array;
313 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
316 * Return true if there is a geometry to be meshed
318 boolean HasShapeToMesh()
319 raises (SALOME::SALOME_Exception);
322 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
323 * to know if a returned shape
325 GEOM::GEOM_Object GetShapeToMesh()
326 raises (SALOME::SALOME_Exception);
329 * Return false if the mesh is not yet fully loaded from the study file
332 raises (SALOME::SALOME_Exception);
335 * Load full mesh data from the study file
338 raises (SALOME::SALOME_Exception);
341 * Remove all nodes and elements
344 raises (SALOME::SALOME_Exception);
347 * Get the list of sub-meshes existing in the mesh
349 submesh_array GetSubMeshes()
350 raises (SALOME::SALOME_Exception);
353 * Remove all nodes and elements of submesh
355 void ClearSubMesh(in long ShapeID)
356 raises (SALOME::SALOME_Exception);
359 * Get the subMesh object associated to a Sub-shape. The subMesh object
360 * gives access to nodes and elements IDs.
361 * SubMesh will be used instead of Sub-shape in a next idl version to
362 * adress a specific subMesh...
364 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
365 raises (SALOME::SALOME_Exception);
370 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
371 raises (SALOME::SALOME_Exception);
377 SMESH_Group CreateGroup( in ElementType elem_type,
379 raises (SALOME::SALOME_Exception);
382 * Create a group from geometry
384 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
386 in GEOM::GEOM_Object geomObject )
387 raises (SALOME::SALOME_Exception);
390 * Create a group from filter
392 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
394 in SMESH::Filter filter )
395 raises (SALOME::SALOME_Exception);
400 void RemoveGroup(in SMESH_GroupBase aGroup)
401 raises (SALOME::SALOME_Exception);
404 * Remove group with its contents
406 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
407 raises (SALOME::SALOME_Exception);
410 * Get the list of groups existing in the mesh
412 ListOfGroups GetGroups()
413 raises (SALOME::SALOME_Exception);
416 * Get number of groups existing in the mesh
419 raises (SALOME::SALOME_Exception);
422 * Union of two groups
423 * New group is created. All mesh elements that are
424 * present in initial groups are added to the new one
426 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
427 in SMESH_GroupBase aGroup2,
429 raises (SALOME::SALOME_Exception);
432 * Union of list of groups
433 * New group is created. All mesh elements that are
434 * present in initial groups are added to the new one
436 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
438 raises (SALOME::SALOME_Exception);
441 * Intersection of two groups
442 * New group is created. All mesh elements that are
443 * present in both initial groups are added to the new one.
445 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
446 in SMESH_GroupBase aGroup2,
448 raises (SALOME::SALOME_Exception);
451 * Intersection of list of groups
452 * New group is created. All mesh elements that are
453 * present in all initial groups simultaneously are added to the new one.
455 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
457 raises (SALOME::SALOME_Exception);
461 * New group is created. All mesh elements that are present in
462 * main group but do not present in tool group are added to the new one
464 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
465 in SMESH_GroupBase aToolGroup,
467 raises (SALOME::SALOME_Exception);
470 * Cut of lists of groups
471 * New group is created. All mesh elements that are present in
472 * main groups but do not present in tool groups are added to the new one
474 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
475 in ListOfGroups aToolGroups,
477 raises (SALOME::SALOME_Exception);
480 * Create groups of entities from existing groups of superior dimensions
481 * New group is created. System
482 * 1) extracts all nodes from each group,
483 * 2) combines all elements of specified dimension laying on these nodes.
485 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
486 in ElementType anElemType,
488 raises (SALOME::SALOME_Exception);
491 * Convert group on geometry or on filter into standalone group
493 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
494 raises (SALOME::SALOME_Exception);
497 * Add hypothesis to the mesh, under a particular Sub-shape
498 * (or the main shape itself)
499 * The Add method is only used to prepare the build of the mesh and store
500 * the algorithms and associated parameters.
501 * Actual job of mesh the shape is done by MESH_Gen.
503 * - aSubShape : sub-shape obtained by a shape explode in GEOM
505 * - anHyp : hypothesis object
507 * - OK if the hypothesis is compatible with the sub-shape
508 * (and all previous hypothesis on the sub-shape)
509 * - NOK if the hypothesis is not compatible with the sub-shape
510 * (or one previous hypothesis on the sub-shape)
511 * raises exception if hypothesis has not been created
513 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
514 in SMESH_Hypothesis anHyp)
515 raises (SALOME::SALOME_Exception);
518 * Remove an hypothesis previouly added with AddHypothesis.
520 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
521 in SMESH_Hypothesis anHyp)
522 raises (SALOME::SALOME_Exception);
525 * Get the list of hypothesis added on a sub-shape
527 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
528 raises (SALOME::SALOME_Exception);
531 * Get the log of nodes and elements added or removed since previous
534 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
536 log_array GetLog(in boolean clearAfterGet)
537 raises (SALOME::SALOME_Exception);
540 * Clear the log of nodes and elements added or removed since previous
541 * clear. Must be used immediately after GetLog if clearAfterGet is false.
544 raises (SALOME::SALOME_Exception);
547 * Toggle auto color mode on the object.
549 * - theAutoColor : flag which toggles auto color mode.
551 void SetAutoColor(in boolean theAutoColor)
552 raises (SALOME::SALOME_Exception);
555 * Get flag of object's auto color mode.
557 boolean GetAutoColor()
558 raises (SALOME::SALOME_Exception);
561 * Get the internal Id
571 * Obtain instance of SMESH_MeshEditor
573 SMESH_MeshEditor GetMeshEditor()
574 raises (SALOME::SALOME_Exception);
577 * Return SMESH_MeshEditor that would not modify the mesh but
578 * fill MeshPreviewStruct
580 SMESH_MeshEditor GetMeshEditPreviewer()
581 raises (SALOME::SALOME_Exception);
584 * Return true if the mesh has been edited since a total re-compute
585 * and those modifications may prevent successful partial re-compute
587 boolean HasModificationsToDiscard()
588 raises (SALOME::SALOME_Exception);
590 /*! Check group names for duplications.
591 * Consider maximum group name length stored in MED file.
593 boolean HasDuplicatedGroupNamesMED();
596 * Export Mesh to different MED Formats
598 * - file : name of the MED file
599 * - auto_groups : boolean parameter for creating/not creating
600 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
601 * the typical use is auto_groups=false.
602 * - version : define the version of format of MED file, that will be created
603 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
605 void ExportToMEDX( in string file,
606 in boolean auto_groups,
607 in MED_VERSION version,
608 in boolean overwrite ) raises (SALOME::SALOME_Exception);
611 * Export a part of Mesh into a MED file
613 * - meshPart : a part of mesh to store
614 * - file : name of the MED file
615 * - version : define the version of format of MED file, that will be created
616 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
618 void ExportPartToMED( in SMESH_IDSource meshPart,
620 in boolean auto_groups,
621 in MED_VERSION version,
622 in boolean overwrite ) raises (SALOME::SALOME_Exception);
625 * Export Mesh to different MED Formats
626 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
627 * The method is kept in order to support old functionality
629 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
630 raises (SALOME::SALOME_Exception);
633 * Export Mesh to MED_V2_1 MED format
634 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
635 * and overwrite parameter equal to true
636 * The method is kept in order to support old functionality
638 void ExportMED( in string file, in boolean auto_groups )
639 raises (SALOME::SALOME_Exception);
642 * Export Mesh to SAUV formatted file
643 * Write a temporary med file and use med2sauv
645 void ExportSAUV( in string file, in boolean auto_groups )
646 raises (SALOME::SALOME_Exception);
649 * Return string representation of a MED file version comprising nbDigits
651 string GetVersionString(in MED_VERSION version, in short nbDigits);
654 * Export Mesh to different Formats
655 * (UNV supported version is I-DEAS 10)
657 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
658 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
659 void ExportSTL( in string file,
660 in boolean isascii ) raises (SALOME::SALOME_Exception);
661 void ExportCGNS( in SMESH_IDSource meshPart,
663 in boolean overwrite ) raises (SALOME::SALOME_Exception);
664 void ExportGMF( in SMESH_IDSource meshPart,
666 in boolean withRequiredGroups) raises (SALOME::SALOME_Exception);
667 void ExportPartToDAT( in SMESH_IDSource meshPart,
668 in string file ) raises (SALOME::SALOME_Exception);
669 void ExportPartToUNV( in SMESH_IDSource meshPart,
670 in string file ) raises (SALOME::SALOME_Exception);
671 void ExportPartToSTL( in SMESH_IDSource meshPart,
673 in boolean isascii ) raises (SALOME::SALOME_Exception);
678 SALOME_MED::MESH GetMEDMesh()
679 raises (SALOME::SALOME_Exception);
682 * Get informations about mesh contents
685 raises (SALOME::SALOME_Exception);
688 raises (SALOME::SALOME_Exception);
691 raises (SALOME::SALOME_Exception);
694 raises (SALOME::SALOME_Exception);
697 raises (SALOME::SALOME_Exception);
699 long NbEdgesOfOrder(in ElementOrder order)
700 raises (SALOME::SALOME_Exception);
703 raises (SALOME::SALOME_Exception);
705 long NbFacesOfOrder(in ElementOrder order)
706 raises (SALOME::SALOME_Exception);
709 raises (SALOME::SALOME_Exception);
711 long NbTrianglesOfOrder(in ElementOrder order)
712 raises (SALOME::SALOME_Exception);
715 raises (SALOME::SALOME_Exception);
717 long NbQuadranglesOfOrder(in ElementOrder order)
718 raises (SALOME::SALOME_Exception);
720 long NbBiQuadQuadrangles()
721 raises (SALOME::SALOME_Exception);
724 raises (SALOME::SALOME_Exception);
727 raises (SALOME::SALOME_Exception);
729 long NbVolumesOfOrder(in ElementOrder order)
730 raises (SALOME::SALOME_Exception);
733 raises (SALOME::SALOME_Exception);
735 long NbTetrasOfOrder(in ElementOrder order)
736 raises (SALOME::SALOME_Exception);
739 raises (SALOME::SALOME_Exception);
741 long NbHexasOfOrder(in ElementOrder order)
742 raises (SALOME::SALOME_Exception);
744 long NbTriQuadraticHexas()
745 raises (SALOME::SALOME_Exception);
748 raises (SALOME::SALOME_Exception);
750 long NbPyramidsOfOrder(in ElementOrder order)
751 raises (SALOME::SALOME_Exception);
754 raises (SALOME::SALOME_Exception);
756 long NbPrismsOfOrder(in ElementOrder order)
757 raises (SALOME::SALOME_Exception);
759 long NbHexagonalPrisms()
760 raises (SALOME::SALOME_Exception);
763 raises (SALOME::SALOME_Exception);
766 raises (SALOME::SALOME_Exception);
768 long_array GetElementsId()
769 raises (SALOME::SALOME_Exception);
771 long_array GetElementsByType( in ElementType theType )
772 raises (SALOME::SALOME_Exception);
774 long_array GetNodesId()
775 raises (SALOME::SALOME_Exception);
778 * Returns type of mesh element
780 ElementType GetElementType( in long id, in boolean iselem )
781 raises (SALOME::SALOME_Exception);
783 EntityType GetElementGeomType( in long id )
784 raises (SALOME::SALOME_Exception);
786 long_array GetSubMeshElementsId(in long ShapeID)
787 raises (SALOME::SALOME_Exception);
789 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
790 raises (SALOME::SALOME_Exception);
792 ElementType GetSubMeshElementType(in long ShapeID)
793 raises (SALOME::SALOME_Exception);
797 * Methods to set meshing order of submeshes
801 * \brief Return submesh objects list in meshing order
803 submesh_array_array GetMeshOrder();
806 * \brief Set submesh object order
808 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
812 * Get mesh description
819 long long GetMeshPtr();
822 * Get XYZ coordinates of node as list of double
823 * If there is not node for given ID - returns empty list
825 double_array GetNodeXYZ(in long id);
828 * For given node returns list of IDs of inverse elements
829 * If there is not node for given ID - returns empty list
831 long_array GetNodeInverseElements(in long id);
834 * \brief Return position of a node on shape
836 NodePosition GetNodePosition(in long NodeID);
839 * \brief Return position of an element on shape
841 ElementPosition GetElementPosition(in long ElemID);
844 * If given element is node returns IDs of shape from position
845 * If there is not node for given ID - returns -1
847 long GetShapeID(in long id);
850 * For given element returns ID of result shape after
851 * ::FindShape() from SMESH_MeshEditor
852 * If there is not element for given ID - returns -1
854 long GetShapeIDForElem(in long id);
857 * Returns number of nodes for given element
858 * If there is not element for given ID - returns -1
860 long GetElemNbNodes(in long id);
863 * Returns IDs of nodes of given element
865 long_array GetElemNodes(in long id);
868 * Returns ID of node by given index for given element
869 * If there is not element for given ID - returns -1
870 * If there is not node for given index - returns -2
872 long GetElemNode(in long id, in long index);
875 * Returns true if given node is medium node
876 * in given quadratic element
878 boolean IsMediumNode(in long ide, in long idn);
881 * Returns true if given node is medium node
882 * in one of quadratic elements
884 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
887 * Returns number of edges for given element
889 long ElemNbEdges(in long id);
892 * Returns number of faces for given element
894 long ElemNbFaces(in long id);
897 * Returns nodes of given face (counted from zero) for given volumic element.
899 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
902 * Returns an element based on all given nodes.
904 long FindElementByNodes(in long_array nodes);
907 * Returns true if given element is polygon
909 boolean IsPoly(in long id);
912 * Returns true if given element is quadratic
914 boolean IsQuadratic(in long id);
917 * Returns diameter of a ball discrete element or zero in case of an invalid \a id
919 double GetBallDiameter(in long id);
922 * Returns XYZ coordinates of bary center for given element
924 * If there is not element for given ID - returns empty list
926 double_array BaryCenter(in long id);
928 /*! Gets information about imported MED file */
929 SALOME_MED::MedFileInfo GetMEDFileInfo();
932 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
933 * \param theParameters is a string containing the notebook variables
935 void SetParameters (in string theParameters);
938 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
940 string GetParameters();
943 * Returns list of notebook variables used for last Mesh operation
945 string_array GetLastParameters();
948 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
953 long GetNumberOfElements()
954 raises (SALOME::SALOME_Exception);
959 long GetNumberOfNodes( in boolean all )
960 raises (SALOME::SALOME_Exception);
965 long_array GetElementsId()
966 raises (SALOME::SALOME_Exception);
971 long_array GetElementsByType( in ElementType theType )
972 raises (SALOME::SALOME_Exception);
975 * Return type of submesh element
977 ElementType GetElementType( in long id, in boolean iselem )
978 raises (SALOME::SALOME_Exception);
983 long_array GetNodesId()
984 raises (SALOME::SALOME_Exception);
987 * Get geom shape the submesh is dedicated to
989 GEOM::GEOM_Object GetSubShape()
990 raises (SALOME::SALOME_Exception);
993 * Get SMESH_Mesh which stores nodes coordinates & elements definition
995 SMESH_Mesh GetFather()
996 raises (SALOME::SALOME_Exception);
999 * Get the internal Id
1006 SALOME_MED::FAMILY GetFamily()
1007 raises (SALOME::SALOME_Exception);