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
269 array_of_ElementType GetTypes();
274 SMESH_Mesh GetMesh();
277 interface SMESH_Group;
278 interface SMESH_GroupOnGeom;
280 interface SMESH_GroupOnFilter;
281 interface SMESH_subMesh;
282 interface SMESH_MeshEditor;
284 typedef sequence<SMESH_subMesh> submesh_array;
285 typedef sequence<submesh_array> submesh_array_array;
287 interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
290 * Return true if there is a geometry to be meshed
292 boolean HasShapeToMesh()
293 raises (SALOME::SALOME_Exception);
296 * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
297 * to know if a returned shape
299 GEOM::GEOM_Object GetShapeToMesh()
300 raises (SALOME::SALOME_Exception);
303 * Remove all nodes and elements
306 raises (SALOME::SALOME_Exception);
309 * Remove all nodes and elements of submesh
311 void ClearSubMesh(in long ShapeID)
312 raises (SALOME::SALOME_Exception);
315 * Get the subMesh object associated to a subShape. The subMesh object
316 * gives access to nodes and elements IDs.
317 * SubMesh will be used instead of SubShape in a next idl version to
318 * adress a specific subMesh...
320 SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
321 raises (SALOME::SALOME_Exception);
326 void RemoveSubMesh(in SMESH_subMesh aSubMesh)
327 raises (SALOME::SALOME_Exception);
333 SMESH_Group CreateGroup( in ElementType elem_type,
335 raises (SALOME::SALOME_Exception);
338 * Create a group from geometry
340 SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elemType,
342 in GEOM::GEOM_Object geomObject )
343 raises (SALOME::SALOME_Exception);
346 * Create a group from filter
348 SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType elemType,
350 in SMESH::Filter filter )
351 raises (SALOME::SALOME_Exception);
356 void RemoveGroup(in SMESH_GroupBase aGroup)
357 raises (SALOME::SALOME_Exception);
360 * Remove group with its contents
362 void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
363 raises (SALOME::SALOME_Exception);
366 * Get the list of groups existing in the mesh
368 ListOfGroups GetGroups()
369 raises (SALOME::SALOME_Exception);
372 * Get number of groups existing in the mesh
375 raises (SALOME::SALOME_Exception);
378 * Union of two groups
379 * New group is created. All mesh elements that are
380 * present in initial groups are added to the new one
382 SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
383 in SMESH_GroupBase aGroup2,
385 raises (SALOME::SALOME_Exception);
388 * Union of list of groups
389 * New group is created. All mesh elements that are
390 * present in initial groups are added to the new one
392 SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
394 raises (SALOME::SALOME_Exception);
397 * Intersection of two groups
398 * New group is created. All mesh elements that are
399 * present in both initial groups are added to the new one.
401 SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
402 in SMESH_GroupBase aGroup2,
404 raises (SALOME::SALOME_Exception);
407 * Intersection of list of groups
408 * New group is created. All mesh elements that are
409 * present in all initial groups simultaneously are added to the new one.
411 SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
413 raises (SALOME::SALOME_Exception);
417 * New group is created. All mesh elements that are present in
418 * main group but do not present in tool group are added to the new one
420 SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
421 in SMESH_GroupBase aToolGroup,
423 raises (SALOME::SALOME_Exception);
426 * Cut of lists of groups
427 * New group is created. All mesh elements that are present in
428 * main groups but do not present in tool groups are added to the new one
430 SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
431 in ListOfGroups aToolGroups,
433 raises (SALOME::SALOME_Exception);
436 * Create groups of entities from existing groups of superior dimensions
437 * New group is created. System
438 * 1) extracts all nodes from each group,
439 * 2) combines all elements of specified dimension laying on these nodes.
441 SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
442 in ElementType anElemType,
444 raises (SALOME::SALOME_Exception);
447 * Convert group on geometry or on filter into standalone group
449 SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
450 raises (SALOME::SALOME_Exception);
453 * Add hypothesis to the mesh, under a particular subShape
454 * (or the main shape itself)
455 * The Add method is only used to prepare the build of the mesh and store
456 * the algorithms and associated parameters.
457 * Actual job of mesh the shape is done by MESH_Gen.
459 * - aSubShape : subShape obtained by a shape explode in GEOM
461 * - anHyp : hypothesis object
463 * - OK if the hypothesis is compatible with the subShape
464 * (and all previous hypothesis on the subShape)
465 * - NOK if the hypothesis is not compatible with the subShape
466 * (or one previous hypothesis on the subShape)
467 * raises exception if hypothesis has not been created
469 Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
470 in SMESH_Hypothesis anHyp)
471 raises (SALOME::SALOME_Exception);
472 // boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
473 // raises (SALOME::SALOME_Exception);
476 * Remove an hypothesis previouly added with AddHypothesis.
478 Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
479 in SMESH_Hypothesis anHyp)
480 raises (SALOME::SALOME_Exception);
481 // boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
482 // in SMESH_Hypothesis anHyp)
483 // raises (SALOME::SALOME_Exception);
486 * Get the list of hypothesis added on a subShape
488 ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
489 raises (SALOME::SALOME_Exception);
490 // ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
491 // raises (SALOME::SALOME_Exception);
494 * Get the log of nodes and elements added or removed since previous
497 * - clearAfterGet : log is emptied after Get (safe if concurrents access)
499 // string_array GetLog(in boolean clearAfterGet)
500 // raises (SALOME::SALOME_Exception);
501 log_array GetLog(in boolean clearAfterGet)
502 raises (SALOME::SALOME_Exception);
505 * Clear the log of nodes and elements added or removed since previous
506 * clear. Must be used immediately after GetLog if clearAfterGet is false.
509 raises (SALOME::SALOME_Exception);
512 * Toggle auto color mode on the object.
514 * - theAutoColor : flag which toggles auto color mode.
516 void SetAutoColor(in boolean theAutoColor)
517 raises (SALOME::SALOME_Exception);
520 * Get flag of object's auto color mode.
522 boolean GetAutoColor()
523 raises (SALOME::SALOME_Exception);
526 * Get the internal Id
536 * Obtain instance of SMESH_MeshEditor
538 SMESH_MeshEditor GetMeshEditor()
539 raises (SALOME::SALOME_Exception);
542 * Return SMESH_MeshEditor that would not modify the mesh but
543 * fill MeshPreviewStruct
545 SMESH_MeshEditor GetMeshEditPreviewer()
546 raises (SALOME::SALOME_Exception);
549 * Return true if the mesh has been edited since a total re-compute
550 * and those modifications may prevent successful partial re-compute
552 boolean HasModificationsToDiscard()
553 raises (SALOME::SALOME_Exception);
555 /*! Check group names for duplications.
556 * Consider maximum group name length stored in MED file.
558 boolean HasDuplicatedGroupNamesMED();
561 * Export Mesh to different MED Formats
563 * - file : name of the MED file
564 * - auto_groups : boolean parameter for creating/not creating
565 * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
566 * the typical use is auto_groups=false.
567 * - version : define the version of format of MED file, that will be created
568 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
570 void ExportToMEDX( in string file,
571 in boolean auto_groups,
572 in MED_VERSION version,
573 in boolean overwrite ) raises (SALOME::SALOME_Exception);
576 * Export a part of Mesh into a MED file
578 * - meshPart : a part of mesh to store
579 * - file : name of the MED file
580 * - version : define the version of format of MED file, that will be created
581 * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
583 void ExportPartToMED( in SMESH_IDSource meshPart,
585 in boolean auto_groups,
586 in MED_VERSION version,
587 in boolean overwrite ) raises (SALOME::SALOME_Exception);
590 * Export Mesh to different MED Formats
591 * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
592 * The method is kept in order to support old functionality
594 void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
595 raises (SALOME::SALOME_Exception);
598 * Export Mesh to MED_V2_1 MED format
599 * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
600 * and overwrite parameter equal to true
601 * The method is kept in order to support old functionality
603 void ExportMED( in string file, in boolean auto_groups )
604 raises (SALOME::SALOME_Exception);
607 * Return string representation of a MED file version comprising nbDigits
609 string GetVersionString(in MED_VERSION version, in short nbDigits);
612 * Export Mesh to DAT, UNV and STL Formats
613 * (UNV supported version is I-DEAS 10)
615 void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
616 void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
617 void ExportSTL( in string file,
618 in boolean isascii ) raises (SALOME::SALOME_Exception);
619 void ExportPartToDAT( in SMESH_IDSource meshPart,
620 in string file ) raises (SALOME::SALOME_Exception);
621 void ExportPartToUNV( in SMESH_IDSource meshPart,
622 in string file ) raises (SALOME::SALOME_Exception);
623 void ExportPartToSTL( in SMESH_IDSource meshPart,
625 in boolean isascii ) raises (SALOME::SALOME_Exception);
630 SALOME_MED::MESH GetMEDMesh()
631 raises (SALOME::SALOME_Exception);
634 * Get informations about mesh contents
637 raises (SALOME::SALOME_Exception);
640 raises (SALOME::SALOME_Exception);
643 raises (SALOME::SALOME_Exception);
646 raises (SALOME::SALOME_Exception);
648 long NbEdgesOfOrder(in ElementOrder order)
649 raises (SALOME::SALOME_Exception);
652 raises (SALOME::SALOME_Exception);
654 long NbFacesOfOrder(in ElementOrder order)
655 raises (SALOME::SALOME_Exception);
658 raises (SALOME::SALOME_Exception);
660 long NbTrianglesOfOrder(in ElementOrder order)
661 raises (SALOME::SALOME_Exception);
664 raises (SALOME::SALOME_Exception);
666 long NbQuadranglesOfOrder(in ElementOrder order)
667 raises (SALOME::SALOME_Exception);
670 raises (SALOME::SALOME_Exception);
673 raises (SALOME::SALOME_Exception);
675 long NbVolumesOfOrder(in ElementOrder order)
676 raises (SALOME::SALOME_Exception);
679 raises (SALOME::SALOME_Exception);
681 long NbTetrasOfOrder(in ElementOrder order)
682 raises (SALOME::SALOME_Exception);
685 raises (SALOME::SALOME_Exception);
687 long NbHexasOfOrder(in ElementOrder order)
688 raises (SALOME::SALOME_Exception);
691 raises (SALOME::SALOME_Exception);
693 long NbPyramidsOfOrder(in ElementOrder order)
694 raises (SALOME::SALOME_Exception);
697 raises (SALOME::SALOME_Exception);
699 long NbPrismsOfOrder(in ElementOrder order)
700 raises (SALOME::SALOME_Exception);
703 raises (SALOME::SALOME_Exception);
706 raises (SALOME::SALOME_Exception);
708 long_array GetElementsId()
709 raises (SALOME::SALOME_Exception);
711 long_array GetElementsByType( in ElementType theType )
712 raises (SALOME::SALOME_Exception);
714 long_array GetNodesId()
715 raises (SALOME::SALOME_Exception);
718 * Returns type of mesh element
720 ElementType GetElementType( in long id, in boolean iselem )
721 raises (SALOME::SALOME_Exception);
723 EntityType GetElementGeomType( in long id )
724 raises (SALOME::SALOME_Exception);
726 long_array GetSubMeshElementsId(in long ShapeID)
727 raises (SALOME::SALOME_Exception);
729 long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
730 raises (SALOME::SALOME_Exception);
732 ElementType GetSubMeshElementType(in long ShapeID)
733 raises (SALOME::SALOME_Exception);
737 * Methods to set meshing order of submeshes
741 * \brief Return submesh objects list in meshing order
743 submesh_array_array GetMeshOrder();
746 * \brief Set submesh object order
748 boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
752 * Get mesh description
759 long long GetMeshPtr();
762 * Get XYZ coordinates of node as list of double
763 * If there is not node for given ID - returns empty list
765 double_array GetNodeXYZ(in long id);
768 * For given node returns list of IDs of inverse elements
769 * If there is not node for given ID - returns empty list
771 long_array GetNodeInverseElements(in long id);
774 * \brief Return position of a node on shape
776 NodePosition GetNodePosition(in long NodeID);
779 * If given element is node returns IDs of shape from position
780 * If there is not node for given ID - returns -1
782 long GetShapeID(in long id);
785 * For given element returns ID of result shape after
786 * ::FindShape() from SMESH_MeshEditor
787 * If there is not element for given ID - returns -1
789 long GetShapeIDForElem(in long id);
792 * Returns number of nodes for given element
793 * If there is not element for given ID - returns -1
795 long GetElemNbNodes(in long id);
798 * Returns IDs of nodes of given element
800 long_array GetElemNodes(in long id);
803 * Returns ID of node by given index for given element
804 * If there is not element for given ID - returns -1
805 * If there is not node for given index - returns -2
807 long GetElemNode(in long id, in long index);
810 * Returns true if given node is medium node
811 * in given quadratic element
813 boolean IsMediumNode(in long ide, in long idn);
816 * Returns true if given node is medium node
817 * in one of quadratic elements
819 boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
822 * Returns number of edges for given element
824 long ElemNbEdges(in long id);
827 * Returns number of faces for given element
829 long ElemNbFaces(in long id);
832 * Returns nodes of given face (counted from zero) for given volumic element.
834 long_array GetElemFaceNodes(in long elemId, in short faceIndex);
837 * Returns an element based on all given nodes.
839 long FindElementByNodes(in long_array nodes);
842 * Returns true if given element is polygon
844 boolean IsPoly(in long id);
847 * Returns true if given element is quadratic
849 boolean IsQuadratic(in long id);
852 * Returns XYZ coordinates of bary center for given element
854 * If there is not element for given ID - returns empty list
856 double_array BaryCenter(in long id);
858 /*! Gets information about imported MED file */
859 SALOME_MED::MedFileInfo GetMEDFileInfo();
862 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
863 * \param theParameters is a string containing the notebook variables
865 void SetParameters (in string theParameters);
868 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
870 string GetParameters();
873 * Returns list of notebook variables used for last Mesh operation
875 string_array GetLastParameters();
878 interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
883 long GetNumberOfElements()
884 raises (SALOME::SALOME_Exception);
889 long GetNumberOfNodes( in boolean all )
890 raises (SALOME::SALOME_Exception);
895 long_array GetElementsId()
896 raises (SALOME::SALOME_Exception);
901 long_array GetElementsByType( in ElementType theType )
902 raises (SALOME::SALOME_Exception);
905 * Return type of submesh element
907 ElementType GetElementType( in long id, in boolean iselem )
908 raises (SALOME::SALOME_Exception);
913 long_array GetNodesId()
914 raises (SALOME::SALOME_Exception);
917 * Get geom shape the submesh is dedicated to
919 GEOM::GEOM_Object GetSubShape()
920 raises (SALOME::SALOME_Exception);
923 * Get SMESH_Mesh which stores nodes coordinates & elements definition
925 SMESH_Mesh GetFather()
926 raises (SALOME::SALOME_Exception);
929 * Get the internal Id
936 SALOME_MED::FAMILY GetFamily()
937 raises (SALOME::SALOME_Exception);