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 * Remove all nodes and elements of submesh
312 void ClearSubMesh(in long ShapeID)
313 raises (SALOME::SALOME_Exception);
316 * Get the subMesh object associated to a subShape. The subMesh object
317 * gives access to nodes and elements IDs.
318 * SubMesh will be used instead of SubShape in a next idl version to
319 * adress a specific subMesh...
321 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
322 raises (SALOME::SALOME_Exception);
327 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
328 raises (SALOME::SALOME_Exception);
334 SMESH_Group CreateGroup( in ElementType elem_type,
336 raises (SALOME::SALOME_Exception);
339 * Create a group from geometry
341 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
343 in GEOM::GEOM_Object geomObject )
344 raises (SALOME::SALOME_Exception);
347 * Create a group from filter
349 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
351 in SMESH::Filter filter )
352 raises (SALOME::SALOME_Exception);
357 void RemoveGroup(in SMESH_GroupBase aGroup)
358 raises (SALOME::SALOME_Exception);
361 * Remove group with its contents
363 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
364 raises (SALOME::SALOME_Exception);
367 * Get the list of groups existing in the mesh
369 ListOfGroups GetGroups()
370 raises (SALOME::SALOME_Exception);
373 * Get number of groups existing in the mesh
376 raises (SALOME::SALOME_Exception);
379 * Union of two groups
380 * New group is created. All mesh elements that are
381 * present in initial groups are added to the new one
383 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
384 in SMESH_GroupBase aGroup2,
386 raises (SALOME::SALOME_Exception);
389 * Union of list of groups
390 * New group is created. All mesh elements that are
391 * present in initial groups are added to the new one
393 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
395 raises (SALOME::SALOME_Exception);
398 * Intersection of two groups
399 * New group is created. All mesh elements that are
400 * present in both initial groups are added to the new one.
402 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
403 in SMESH_GroupBase aGroup2,
405 raises (SALOME::SALOME_Exception);
408 * Intersection of list of groups
409 * New group is created. All mesh elements that are
410 * present in all initial groups simultaneously are added to the new one.
412 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
414 raises (SALOME::SALOME_Exception);
418 * New group is created. All mesh elements that are present in
419 * main group but do not present in tool group are added to the new one
421 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
422 in SMESH_GroupBase aToolGroup,
424 raises (SALOME::SALOME_Exception);
427 * Cut of lists of groups
428 * New group is created. All mesh elements that are present in
429 * main groups but do not present in tool groups are added to the new one
431 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
432 in ListOfGroups aToolGroups,
434 raises (SALOME::SALOME_Exception);
437 * Create groups of entities from existing groups of superior dimensions
438 * New group is created. System
439 * 1) extracts all nodes from each group,
440 * 2) combines all elements of specified dimension laying on these nodes.
442 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
443 in ElementType anElemType,
445 raises (SALOME::SALOME_Exception);
448 * Convert group on geometry or on filter into standalone group
450 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
451 raises (SALOME::SALOME_Exception);
454 * Add hypothesis to the mesh, under a particular subShape
455 * (or the main shape itself)
456 * The Add method is only used to prepare the build of the mesh and store
457 * the algorithms and associated parameters.
458 * Actual job of mesh the shape is done by MESH_Gen.
460 * - aSubShape : subShape obtained by a shape explode in GEOM
462 * - anHyp : hypothesis object
464 * - OK if the hypothesis is compatible with the subShape
465 * (and all previous hypothesis on the subShape)
466 * - NOK if the hypothesis is not compatible with the subShape
467 * (or one previous hypothesis on the subShape)
468 * raises exception if hypothesis has not been created
470 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
471 in SMESH_Hypothesis anHyp)
472 raises (SALOME::SALOME_Exception);
473 // boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
474 // raises (SALOME::SALOME_Exception);
477 * Remove an hypothesis previouly added with AddHypothesis.
479 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
480 in SMESH_Hypothesis anHyp)
481 raises (SALOME::SALOME_Exception);
482 // boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
483 // in SMESH_Hypothesis anHyp)
484 // raises (SALOME::SALOME_Exception);
487 * Get the list of hypothesis added on a subShape
489 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
490 raises (SALOME::SALOME_Exception);
491 // ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
492 // raises (SALOME::SALOME_Exception);
495 * Get the log of nodes and elements added or removed since previous
498 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
500 // string_array GetLog(in boolean clearAfterGet)
501 // raises (SALOME::SALOME_Exception);
502 log_array GetLog(in boolean clearAfterGet)
503 raises (SALOME::SALOME_Exception);
506 * Clear the log of nodes and elements added or removed since previous
507 * clear. Must be used immediately after GetLog if clearAfterGet is false.
510 raises (SALOME::SALOME_Exception);
513 * Toggle auto color mode on the object.
515 * - theAutoColor : flag which toggles auto color mode.
517 void SetAutoColor(in boolean theAutoColor)
518 raises (SALOME::SALOME_Exception);
521 * Get flag of object's auto color mode.
523 boolean GetAutoColor()
524 raises (SALOME::SALOME_Exception);
527 * Get the internal Id
537 * Obtain instance of SMESH_MeshEditor
539 SMESH_MeshEditor GetMeshEditor()
540 raises (SALOME::SALOME_Exception);
543 * Return SMESH_MeshEditor that would not modify the mesh but
544 * fill MeshPreviewStruct
546 SMESH_MeshEditor GetMeshEditPreviewer()
547 raises (SALOME::SALOME_Exception);
550 * Return true if the mesh has been edited since a total re-compute
551 * and those modifications may prevent successful partial re-compute
553 boolean HasModificationsToDiscard()
554 raises (SALOME::SALOME_Exception);
556 /*! Check group names for duplications.
557 * Consider maximum group name length stored in MED file.
559 boolean HasDuplicatedGroupNamesMED();
562 * Export Mesh to different MED Formats
564 * - file : name of the MED file
565 * - auto_groups : boolean parameter for creating/not creating
566 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
567 * the typical use is auto_groups=false.
568 * - version : define the version of format of MED file, that will be created
569 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
571 void ExportToMEDX( in string file,
572 in boolean auto_groups,
573 in MED_VERSION version,
574 in boolean overwrite ) raises (SALOME::SALOME_Exception);
577 * Export a part of Mesh into a MED file
579 * - meshPart : a part of mesh to store
580 * - file : name of the MED file
581 * - version : define the version of format of MED file, that will be created
582 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
584 void ExportPartToMED( in SMESH_IDSource meshPart,
586 in boolean auto_groups,
587 in MED_VERSION version,
588 in boolean overwrite ) raises (SALOME::SALOME_Exception);
591 * Export Mesh to different MED Formats
592 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
593 * The method is kept in order to support old functionality
595 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
596 raises (SALOME::SALOME_Exception);
599 * Export Mesh to MED_V2_1 MED format
600 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
601 * and overwrite parameter equal to true
602 * The method is kept in order to support old functionality
604 void ExportMED( in string file, in boolean auto_groups )
605 raises (SALOME::SALOME_Exception);
608 * Return string representation of a MED file version comprising nbDigits
610 string GetVersionString(in MED_VERSION version, in short nbDigits);
613 * Export Mesh to DAT, UNV and STL Formats
614 * (UNV supported version is I-DEAS 10)
616 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
617 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
618 void ExportSTL( in string file,
619 in boolean isascii ) raises (SALOME::SALOME_Exception);
620 void ExportPartToDAT( in SMESH_IDSource meshPart,
621 in string file ) raises (SALOME::SALOME_Exception);
622 void ExportPartToUNV( in SMESH_IDSource meshPart,
623 in string file ) raises (SALOME::SALOME_Exception);
624 void ExportPartToSTL( in SMESH_IDSource meshPart,
626 in boolean isascii ) raises (SALOME::SALOME_Exception);
631 SALOME_MED::MESH GetMEDMesh()
632 raises (SALOME::SALOME_Exception);
635 * Get informations about mesh contents
638 raises (SALOME::SALOME_Exception);
641 raises (SALOME::SALOME_Exception);
644 raises (SALOME::SALOME_Exception);
647 raises (SALOME::SALOME_Exception);
649 long NbEdgesOfOrder(in ElementOrder order)
650 raises (SALOME::SALOME_Exception);
653 raises (SALOME::SALOME_Exception);
655 long NbFacesOfOrder(in ElementOrder order)
656 raises (SALOME::SALOME_Exception);
659 raises (SALOME::SALOME_Exception);
661 long NbTrianglesOfOrder(in ElementOrder order)
662 raises (SALOME::SALOME_Exception);
665 raises (SALOME::SALOME_Exception);
667 long NbQuadranglesOfOrder(in ElementOrder order)
668 raises (SALOME::SALOME_Exception);
671 raises (SALOME::SALOME_Exception);
674 raises (SALOME::SALOME_Exception);
676 long NbVolumesOfOrder(in ElementOrder order)
677 raises (SALOME::SALOME_Exception);
680 raises (SALOME::SALOME_Exception);
682 long NbTetrasOfOrder(in ElementOrder order)
683 raises (SALOME::SALOME_Exception);
686 raises (SALOME::SALOME_Exception);
688 long NbHexasOfOrder(in ElementOrder order)
689 raises (SALOME::SALOME_Exception);
692 raises (SALOME::SALOME_Exception);
694 long NbPyramidsOfOrder(in ElementOrder order)
695 raises (SALOME::SALOME_Exception);
698 raises (SALOME::SALOME_Exception);
700 long NbPrismsOfOrder(in ElementOrder order)
701 raises (SALOME::SALOME_Exception);
704 raises (SALOME::SALOME_Exception);
707 raises (SALOME::SALOME_Exception);
709 long_array GetElementsId()
710 raises (SALOME::SALOME_Exception);
712 long_array GetElementsByType( in ElementType theType )
713 raises (SALOME::SALOME_Exception);
715 long_array GetNodesId()
716 raises (SALOME::SALOME_Exception);
719 * Returns type of mesh element
721 ElementType GetElementType( in long id, in boolean iselem )
722 raises (SALOME::SALOME_Exception);
724 EntityType GetElementGeomType( in long id )
725 raises (SALOME::SALOME_Exception);
727 long_array GetSubMeshElementsId(in long ShapeID)
728 raises (SALOME::SALOME_Exception);
730 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
731 raises (SALOME::SALOME_Exception);
733 ElementType GetSubMeshElementType(in long ShapeID)
734 raises (SALOME::SALOME_Exception);
738 * Methods to set meshing order of submeshes
742 * \brief Return submesh objects list in meshing order
744 submesh_array_array GetMeshOrder();
747 * \brief Set submesh object order
749 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
753 * Get mesh description
760 long long GetMeshPtr();
763 * Get XYZ coordinates of node as list of double
764 * If there is not node for given ID - returns empty list
766 double_array GetNodeXYZ(in long id);
769 * For given node returns list of IDs of inverse elements
770 * If there is not node for given ID - returns empty list
772 long_array GetNodeInverseElements(in long id);
775 * \brief Return position of a node on shape
777 NodePosition GetNodePosition(in long NodeID);
780 * If given element is node returns IDs of shape from position
781 * If there is not node for given ID - returns -1
783 long GetShapeID(in long id);
786 * For given element returns ID of result shape after
787 * ::FindShape() from SMESH_MeshEditor
788 * If there is not element for given ID - returns -1
790 long GetShapeIDForElem(in long id);
793 * Returns number of nodes for given element
794 * If there is not element for given ID - returns -1
796 long GetElemNbNodes(in long id);
799 * Returns IDs of nodes of given element
801 long_array GetElemNodes(in long id);
804 * Returns ID of node by given index for given element
805 * If there is not element for given ID - returns -1
806 * If there is not node for given index - returns -2
808 long GetElemNode(in long id, in long index);
811 * Returns true if given node is medium node
812 * in given quadratic element
814 boolean IsMediumNode(in long ide, in long idn);
817 * Returns true if given node is medium node
818 * in one of quadratic elements
820 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
823 * Returns number of edges for given element
825 long ElemNbEdges(in long id);
828 * Returns number of faces for given element
830 long ElemNbFaces(in long id);
833 * Returns nodes of given face (counted from zero) for given volumic element.
835 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
838 * Returns an element based on all given nodes.
840 long FindElementByNodes(in long_array nodes);
843 * Returns true if given element is polygon
845 boolean IsPoly(in long id);
848 * Returns true if given element is quadratic
850 boolean IsQuadratic(in long id);
853 * Returns XYZ coordinates of bary center for given element
855 * If there is not element for given ID - returns empty list
857 double_array BaryCenter(in long id);
859 /*! Gets information about imported MED file */
860 SALOME_MED::MedFileInfo GetMEDFileInfo();
863 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
864 * \param theParameters is a string containing the notebook variables
866 void SetParameters (in string theParameters);
869 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
871 string GetParameters();
874 * Returns list of notebook variables used for last Mesh operation
876 string_array GetLastParameters();
879 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
884 long GetNumberOfElements()
885 raises (SALOME::SALOME_Exception);
890 long GetNumberOfNodes( in boolean all )
891 raises (SALOME::SALOME_Exception);
896 long_array GetElementsId()
897 raises (SALOME::SALOME_Exception);
902 long_array GetElementsByType( in ElementType theType )
903 raises (SALOME::SALOME_Exception);
906 * Return type of submesh element
908 ElementType GetElementType( in long id, in boolean iselem )
909 raises (SALOME::SALOME_Exception);
914 long_array GetNodesId()
915 raises (SALOME::SALOME_Exception);
918 * Get geom shape the submesh is dedicated to
920 GEOM::GEOM_Object GetSubShape()
921 raises (SALOME::SALOME_Exception);
924 * Get SMESH_Mesh which stores nodes coordinates & elements definition
926 SMESH_Mesh GetFather()
927 raises (SALOME::SALOME_Exception);
930 * Get the internal Id
937 SALOME_MED::FAMILY GetFamily()
938 raises (SALOME::SALOME_Exception);