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,
76 ADD_BIQUAD_QUADRANGLE,
90 struct PointStruct { double x;
94 typedef sequence<PointStruct> nodes_array;
96 struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
98 struct AxisStruct { double x;
106 * Node location on a shape
108 struct NodePosition {
110 GEOM::shape_type shapeType;
111 double_array params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
115 * Element location on a shape
117 struct ElementPosition {
119 GEOM::shape_type shapeType;
123 * Enumeration for element type, like in SMDS
135 typedef sequence<ElementType> array_of_ElementType ;
138 * Enumeration for element geometry type, like in SMDS
145 Geom_QUADRANGLE, // when a new GeometryType is added, please
146 Geom_POLYGON, // update a corresponding list in SMESH_2smeshpy.cxx, ln 665
151 Geom_HEXAGONAL_PRISM,
157 * ElementOrder points out entities of what order are requested
160 ORDER_ANY, /*! entities of any order */
161 ORDER_LINEAR, /*! entities of 1st order */
162 ORDER_QUADRATIC /*! entities of 2nd order */
167 * Enumeration of entity type used in mesh info array,
168 * it should be synchronised with enum SMDSAbs_EntityType
177 Entity_Quad_Triangle,
178 Entity_BiQuad_Triangle,
180 Entity_Quad_Quadrangle,
181 Entity_BiQuad_Quadrangle,
193 Entity_Hexagonal_Prism,
195 Entity_Quad_Polyhedra,
202 * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
204 enum Hypothesis_Status // in the order of severity
207 HYP_MISSING, // algo misses a hypothesis
208 HYP_CONCURENT, // several applicable hypotheses
209 HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
210 HYP_HIDDEN_ALGO, // an algo is hidden by an upper dim algo generating all-dim elements
211 HYP_HIDING_ALGO, // an algo hides lower dim algos by generating all-dim elements
212 HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
213 // for Add/RemoveHypothesis operations
214 HYP_INCOMPATIBLE, // hypothesis does not fit algo
215 HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
216 HYP_ALREADY_EXIST,// such hypothesis already exist
217 HYP_BAD_DIM, // bad dimension
218 HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
219 HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
220 HYP_NEED_SHAPE // algorithm can work on shape only
224 * Enumeration for DriverMED read status (used by ImportMEDFile() method)
226 enum DriverMED_ReadStatus // in the order of severity
229 DRS_EMPTY, // a MED file contains no mesh with the given name
230 DRS_WARN_RENUMBER, // a MED file has overlapped ranges of element numbers,
231 // so the numbers from the file are ignored
232 DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
233 DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
234 DRS_FAIL // general failure (exception etc.)
238 * Enumeration for DriverMED (used by Perform() method)
240 enum MED_VERSION // in the order of severity
246 typedef sequence<log_block> log_array;
250 * Auxilary flags for advanced extrusion.
251 * BOUNDARY: create or not boundary for result of extrusion
252 * SEW: try to use existing nodes or create new nodes in any case
254 const long EXTRUSION_FLAG_BOUNDARY = 1;
255 const long EXTRUSION_FLAG_SEW = 2;
258 * Structure used in mesh edit preview data (MeshPreviewStruct)
260 struct ElementSubType { ElementType SMDS_ElementType;
262 long nbNodesInElement; };
264 typedef sequence<ElementSubType> types_array;
267 * Structure containing mesh edit preview data
269 struct MeshPreviewStruct { nodes_array nodesXYZ;
270 long_array elementConnectivities;
271 types_array elementTypes; };
273 interface SMESH_Mesh;
275 interface SMESH_IDSource
278 * Returns a sequence of all element IDs
283 * Returns statistic of mesh elements
284 * @return array of number enityties by index of EntityType
286 long_array GetMeshInfo();
289 * Returns types of elements it contains.
290 * It's empty if the SMESH_IDSource contains no IDs
292 array_of_ElementType GetTypes();
297 SMESH_Mesh GetMesh();
300 * Returns false if GetMeshInfo() returns incorrect information that may
301 * happen if mesh data is not yet fully loaded from the file of study.
303 boolean IsMeshInfoCorrect();
306 interface SMESH_Group;
307 interface SMESH_GroupOnGeom;
309 interface SMESH_GroupOnFilter;
310 interface SMESH_subMesh;
311 interface SMESH_MeshEditor;
313 typedef sequence<SMESH_subMesh> submesh_array;
314 typedef sequence<submesh_array> submesh_array_array;
316 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
319 * Return true if there is a geometry to be meshed
321 boolean HasShapeToMesh()
322 raises (SALOME::SALOME_Exception);
325 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
326 * to know if a returned shape
328 GEOM::GEOM_Object GetShapeToMesh()
329 raises (SALOME::SALOME_Exception);
332 * Return false if the mesh is not yet fully loaded from the study file
335 raises (SALOME::SALOME_Exception);
338 * Load full mesh data from the study file
341 raises (SALOME::SALOME_Exception);
344 * Remove all nodes and elements
347 raises (SALOME::SALOME_Exception);
350 * Get the list of sub-meshes existing in the mesh
352 submesh_array GetSubMeshes()
353 raises (SALOME::SALOME_Exception);
356 * Remove all nodes and elements of submesh
358 void ClearSubMesh(in long ShapeID)
359 raises (SALOME::SALOME_Exception);
362 * Get the subMesh object associated to a Sub-shape. The subMesh object
363 * gives access to nodes and elements IDs.
364 * SubMesh will be used instead of Sub-shape in a next idl version to
365 * adress a specific subMesh...
367 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
368 raises (SALOME::SALOME_Exception);
373 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
374 raises (SALOME::SALOME_Exception);
380 SMESH_Group CreateGroup( in ElementType elem_type,
382 raises (SALOME::SALOME_Exception);
385 * Create a group from geometry
387 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
389 in GEOM::GEOM_Object geomObject )
390 raises (SALOME::SALOME_Exception);
393 * Create a group from filter
395 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
397 in SMESH::Filter filter )
398 raises (SALOME::SALOME_Exception);
403 void RemoveGroup(in SMESH_GroupBase aGroup)
404 raises (SALOME::SALOME_Exception);
407 * Remove group with its contents
409 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
410 raises (SALOME::SALOME_Exception);
413 * Get the list of groups existing in the mesh
415 ListOfGroups GetGroups()
416 raises (SALOME::SALOME_Exception);
419 * Get number of groups existing in the mesh
422 raises (SALOME::SALOME_Exception);
425 * Union of two groups
426 * New group is created. All mesh elements that are
427 * present in initial groups are added to the new one
429 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
430 in SMESH_GroupBase aGroup2,
432 raises (SALOME::SALOME_Exception);
435 * Union of list of groups
436 * New group is created. All mesh elements that are
437 * present in initial groups are added to the new one
439 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
441 raises (SALOME::SALOME_Exception);
444 * Intersection of two groups
445 * New group is created. All mesh elements that are
446 * present in both initial groups are added to the new one.
448 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
449 in SMESH_GroupBase aGroup2,
451 raises (SALOME::SALOME_Exception);
454 * Intersection of list of groups
455 * New group is created. All mesh elements that are
456 * present in all initial groups simultaneously are added to the new one.
458 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
460 raises (SALOME::SALOME_Exception);
464 * New group is created. All mesh elements that are present in
465 * main group but do not present in tool group are added to the new one
467 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
468 in SMESH_GroupBase aToolGroup,
470 raises (SALOME::SALOME_Exception);
473 * Cut of lists of groups
474 * New group is created. All mesh elements that are present in
475 * main groups but do not present in tool groups are added to the new one
477 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
478 in ListOfGroups aToolGroups,
480 raises (SALOME::SALOME_Exception);
483 * Create groups of entities from existing groups of superior dimensions
484 * New group is created. System
485 * 1) extracts all nodes from each group,
486 * 2) combines all elements of specified dimension laying on these nodes.
488 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
489 in ElementType anElemType,
491 raises (SALOME::SALOME_Exception);
494 * Convert group on geometry or on filter into standalone group
496 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
497 raises (SALOME::SALOME_Exception);
500 * Add hypothesis to the mesh, under a particular Sub-shape
501 * (or the main shape itself)
502 * The Add method is only used to prepare the build of the mesh and store
503 * the algorithms and associated parameters.
504 * Actual job of mesh the shape is done by MESH_Gen.
506 * - aSubShape : sub-shape obtained by a shape explode in GEOM
508 * - anHyp : hypothesis object
510 * - OK if the hypothesis is compatible with the sub-shape
511 * (and all previous hypothesis on the sub-shape)
512 * - NOK if the hypothesis is not compatible with the sub-shape
513 * (or one previous hypothesis on the sub-shape)
514 * raises exception if hypothesis has not been created
516 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
517 in SMESH_Hypothesis anHyp)
518 raises (SALOME::SALOME_Exception);
521 * Remove an hypothesis previouly added with AddHypothesis.
523 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
524 in SMESH_Hypothesis anHyp)
525 raises (SALOME::SALOME_Exception);
528 * Get the list of hypothesis added on a sub-shape
530 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
531 raises (SALOME::SALOME_Exception);
534 * Get the log of nodes and elements added or removed since previous
537 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
539 log_array GetLog(in boolean clearAfterGet)
540 raises (SALOME::SALOME_Exception);
543 * Clear the log of nodes and elements added or removed since previous
544 * clear. Must be used immediately after GetLog if clearAfterGet is false.
547 raises (SALOME::SALOME_Exception);
550 * Toggle auto color mode on the object.
552 * - theAutoColor : flag which toggles auto color mode.
554 void SetAutoColor(in boolean theAutoColor)
555 raises (SALOME::SALOME_Exception);
558 * Get flag of object's auto color mode.
560 boolean GetAutoColor()
561 raises (SALOME::SALOME_Exception);
564 * Get the internal Id
574 * Obtain instance of SMESH_MeshEditor
576 SMESH_MeshEditor GetMeshEditor()
577 raises (SALOME::SALOME_Exception);
580 * Return SMESH_MeshEditor that would not modify the mesh but
581 * fill MeshPreviewStruct
583 SMESH_MeshEditor GetMeshEditPreviewer()
584 raises (SALOME::SALOME_Exception);
587 * Return true if the mesh has been edited since a total re-compute
588 * and those modifications may prevent successful partial re-compute
590 boolean HasModificationsToDiscard()
591 raises (SALOME::SALOME_Exception);
593 /*! Check group names for duplications.
594 * Consider maximum group name length stored in MED file.
596 boolean HasDuplicatedGroupNamesMED();
599 * Export Mesh to different MED Formats
601 * - file : name of the MED file
602 * - auto_groups : boolean parameter for creating/not creating
603 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
604 * the typical use is auto_groups=false.
605 * - version : define the version of format of MED file, that will be created
606 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
608 void ExportToMEDX( in string file,
609 in boolean auto_groups,
610 in MED_VERSION version,
611 in boolean overwrite ) raises (SALOME::SALOME_Exception);
614 * Export a part of Mesh into a MED file
616 * - meshPart : a part of mesh to store
617 * - file : name of the MED file
618 * - version : define the version of format of MED file, that will be created
619 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
621 void ExportPartToMED( in SMESH_IDSource meshPart,
623 in boolean auto_groups,
624 in MED_VERSION version,
625 in boolean overwrite ) raises (SALOME::SALOME_Exception);
628 * Export Mesh to different MED Formats
629 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
630 * The method is kept in order to support old functionality
632 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
633 raises (SALOME::SALOME_Exception);
636 * Export Mesh to MED_V2_1 MED format
637 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
638 * and overwrite parameter equal to true
639 * The method is kept in order to support old functionality
641 void ExportMED( in string file, in boolean auto_groups )
642 raises (SALOME::SALOME_Exception);
645 * Export Mesh to SAUV formatted file
646 * Write a temporary med file and use med2sauv
648 void ExportSAUV( in string file, in boolean auto_groups )
649 raises (SALOME::SALOME_Exception);
652 * Return string representation of a MED file version comprising nbDigits
654 string GetVersionString(in MED_VERSION version, in short nbDigits);
657 * Export Mesh to different Formats
658 * (UNV supported version is I-DEAS 10)
660 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
661 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
662 void ExportSTL( in string file,
663 in boolean isascii ) raises (SALOME::SALOME_Exception);
664 void ExportCGNS( in SMESH_IDSource meshPart,
666 in boolean overwrite ) raises (SALOME::SALOME_Exception);
667 void ExportGMF( in SMESH_IDSource meshPart,
669 in boolean withRequiredGroups) raises (SALOME::SALOME_Exception);
670 void ExportPartToDAT( in SMESH_IDSource meshPart,
671 in string file ) raises (SALOME::SALOME_Exception);
672 void ExportPartToUNV( in SMESH_IDSource meshPart,
673 in string file ) raises (SALOME::SALOME_Exception);
674 void ExportPartToSTL( in SMESH_IDSource meshPart,
676 in boolean isascii ) raises (SALOME::SALOME_Exception);
681 SALOME_MED::MESH GetMEDMesh()
682 raises (SALOME::SALOME_Exception);
685 * Get informations about mesh contents
688 raises (SALOME::SALOME_Exception);
691 raises (SALOME::SALOME_Exception);
694 raises (SALOME::SALOME_Exception);
697 raises (SALOME::SALOME_Exception);
700 raises (SALOME::SALOME_Exception);
702 long NbEdgesOfOrder(in ElementOrder order)
703 raises (SALOME::SALOME_Exception);
706 raises (SALOME::SALOME_Exception);
708 long NbFacesOfOrder(in ElementOrder order)
709 raises (SALOME::SALOME_Exception);
712 raises (SALOME::SALOME_Exception);
714 long NbTrianglesOfOrder(in ElementOrder order)
715 raises (SALOME::SALOME_Exception);
717 long NbBiQuadTriangles()
718 raises (SALOME::SALOME_Exception);
721 raises (SALOME::SALOME_Exception);
723 long NbQuadranglesOfOrder(in ElementOrder order)
724 raises (SALOME::SALOME_Exception);
726 long NbBiQuadQuadrangles()
727 raises (SALOME::SALOME_Exception);
730 raises (SALOME::SALOME_Exception);
733 raises (SALOME::SALOME_Exception);
735 long NbVolumesOfOrder(in ElementOrder order)
736 raises (SALOME::SALOME_Exception);
739 raises (SALOME::SALOME_Exception);
741 long NbTetrasOfOrder(in ElementOrder order)
742 raises (SALOME::SALOME_Exception);
745 raises (SALOME::SALOME_Exception);
747 long NbHexasOfOrder(in ElementOrder order)
748 raises (SALOME::SALOME_Exception);
750 long NbTriQuadraticHexas()
751 raises (SALOME::SALOME_Exception);
754 raises (SALOME::SALOME_Exception);
756 long NbPyramidsOfOrder(in ElementOrder order)
757 raises (SALOME::SALOME_Exception);
760 raises (SALOME::SALOME_Exception);
762 long NbPrismsOfOrder(in ElementOrder order)
763 raises (SALOME::SALOME_Exception);
765 long NbHexagonalPrisms()
766 raises (SALOME::SALOME_Exception);
769 raises (SALOME::SALOME_Exception);
772 raises (SALOME::SALOME_Exception);
774 long_array GetElementsId()
775 raises (SALOME::SALOME_Exception);
777 long_array GetElementsByType( in ElementType theType )
778 raises (SALOME::SALOME_Exception);
780 long_array GetNodesId()
781 raises (SALOME::SALOME_Exception);
784 * Returns type of mesh element
786 ElementType GetElementType( in long id, in boolean iselem )
787 raises (SALOME::SALOME_Exception);
789 EntityType GetElementGeomType( in long id )
790 raises (SALOME::SALOME_Exception);
792 long_array GetSubMeshElementsId(in long ShapeID)
793 raises (SALOME::SALOME_Exception);
795 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
796 raises (SALOME::SALOME_Exception);
798 ElementType GetSubMeshElementType(in long ShapeID)
799 raises (SALOME::SALOME_Exception);
803 * Methods to set meshing order of submeshes
807 * \brief Return submesh objects list in meshing order
809 submesh_array_array GetMeshOrder();
812 * \brief Set submesh object order
814 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
818 * Get mesh description
825 long long GetMeshPtr();
828 * Get XYZ coordinates of node as list of double
829 * If there is not node for given ID - returns empty list
831 double_array GetNodeXYZ(in long id);
834 * For given node returns list of IDs of inverse elements
835 * If there is not node for given ID - returns empty list
837 long_array GetNodeInverseElements(in long id);
840 * \brief Return position of a node on shape
842 NodePosition GetNodePosition(in long NodeID);
845 * \brief Return position of an element on shape
847 ElementPosition GetElementPosition(in long ElemID);
850 * If given element is node returns IDs of shape from position
851 * If there is not node for given ID - returns -1
853 long GetShapeID(in long id);
856 * For given element returns ID of result shape after
857 * ::FindShape() from SMESH_MeshEditor
858 * If there is not element for given ID - returns -1
860 long GetShapeIDForElem(in long id);
863 * Returns number of nodes for given element
864 * If there is not element for given ID - returns -1
866 long GetElemNbNodes(in long id);
869 * Returns IDs of nodes of given element
871 long_array GetElemNodes(in long id);
874 * Returns ID of node by given index for given element
875 * If there is not element for given ID - returns -1
876 * If there is not node for given index - returns -2
878 long GetElemNode(in long id, in long index);
881 * Returns true if given node is medium node
882 * in given quadratic element
884 boolean IsMediumNode(in long ide, in long idn);
887 * Returns true if given node is medium node
888 * in one of quadratic elements
890 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
893 * Returns number of edges for given element
895 long ElemNbEdges(in long id);
898 * Returns number of faces for given element
900 long ElemNbFaces(in long id);
903 * Returns nodes of given face (counted from zero) for given volumic element.
905 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
908 * Returns an element based on all given nodes.
910 long FindElementByNodes(in long_array nodes);
913 * Returns true if given element is polygon
915 boolean IsPoly(in long id);
918 * Returns true if given element is quadratic
920 boolean IsQuadratic(in long id);
923 * Returns diameter of a ball discrete element or zero in case of an invalid \a id
925 double GetBallDiameter(in long id);
928 * Returns XYZ coordinates of bary center for given element
930 * If there is not element for given ID - returns empty list
932 double_array BaryCenter(in long id);
934 /*! Gets information about imported MED file */
935 SALOME_MED::MedFileInfo GetMEDFileInfo();
938 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
939 * \param theParameters is a string containing the notebook variables
941 void SetParameters (in string theParameters);
944 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
946 string GetParameters();
949 * Returns list of notebook variables used for last Mesh operation
951 string_array GetLastParameters();
954 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
959 long GetNumberOfElements()
960 raises (SALOME::SALOME_Exception);
965 long GetNumberOfNodes( in boolean all )
966 raises (SALOME::SALOME_Exception);
971 long_array GetElementsId()
972 raises (SALOME::SALOME_Exception);
977 long_array GetElementsByType( in ElementType theType )
978 raises (SALOME::SALOME_Exception);
981 * Return type of submesh element
983 ElementType GetElementType( in long id, in boolean iselem )
984 raises (SALOME::SALOME_Exception);
989 long_array GetNodesId()
990 raises (SALOME::SALOME_Exception);
993 * Get geom shape the submesh is dedicated to
995 GEOM::GEOM_Object GetSubShape()
996 raises (SALOME::SALOME_Exception);
999 * Get SMESH_Mesh which stores nodes coordinates & elements definition
1001 SMESH_Mesh GetFather()
1002 raises (SALOME::SALOME_Exception);
1005 * Get the internal Id
1012 SALOME_MED::FAMILY GetFamily()
1013 raises (SALOME::SALOME_Exception);