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
22 // File : SMESH_Mesh_i.hxx
23 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_MESH_I_HXX_
27 #define _SMESH_MESH_I_HXX_
31 #include <SALOMEconfig.h>
32 #include CORBA_SERVER_HEADER(SMESH_Gen)
33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
34 #include CORBA_SERVER_HEADER(SMESH_Group)
35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
38 #include "SMESH_Hypothesis.hxx"
39 #include "SMESH_Mesh.hxx"
40 #include "SMESH_subMesh.hxx"
42 #include "SALOME_GenericObj_i.hh"
45 class SMESH_GroupBase_i;
46 class SMESH_subMesh_i;
47 class SMESH_PreMeshInfo;
51 class SMESH_I_EXPORT SMESH_Mesh_i:
52 public virtual POA_SMESH::SMESH_Mesh,
53 public virtual SALOME::GenericObj_i
56 SMESH_Mesh_i(const SMESH_Mesh_i&);
58 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
60 CORBA::Long studyId );
62 virtual ~SMESH_Mesh_i();
66 void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
67 throw (SALOME::SALOME_Exception);
69 CORBA::Boolean HasShapeToMesh()
70 throw (SALOME::SALOME_Exception);
72 GEOM::GEOM_Object_ptr GetShapeToMesh()
73 throw (SALOME::SALOME_Exception);
75 CORBA::Boolean IsLoaded()
76 throw (SALOME::SALOME_Exception);
79 throw (SALOME::SALOME_Exception);
82 throw (SALOME::SALOME_Exception);
84 void ClearSubMesh(CORBA::Long ShapeID)
85 throw (SALOME::SALOME_Exception);
87 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
88 SMESH::SMESH_Hypothesis_ptr anHyp)
89 throw (SALOME::SALOME_Exception);
91 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
92 SMESH::SMESH_Hypothesis_ptr anHyp)
93 throw (SALOME::SALOME_Exception);
95 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
96 throw (SALOME::SALOME_Exception);
98 SMESH::submesh_array* GetSubMeshes()
99 throw (SALOME::SALOME_Exception);
101 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
102 throw (SALOME::SALOME_Exception);
104 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
105 throw (SALOME::SALOME_Exception);
107 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
108 throw (SALOME::SALOME_Exception);
110 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
112 GEOM::GEOM_Object_ptr theGeomObj )
113 throw (SALOME::SALOME_Exception);
115 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
117 SMESH::Filter_ptr theFilter )
118 throw (SALOME::SALOME_Exception);
120 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
121 throw (SALOME::SALOME_Exception);
123 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
124 throw (SALOME::SALOME_Exception);
126 SMESH::ListOfGroups* GetGroups()
127 throw (SALOME::SALOME_Exception);
129 CORBA::Long NbGroups()
130 throw (SALOME::SALOME_Exception);
132 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
133 SMESH::SMESH_GroupBase_ptr theGroup2,
134 const char* theName )
135 throw (SALOME::SALOME_Exception);
137 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
139 throw (SALOME::SALOME_Exception);
141 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
142 SMESH::SMESH_GroupBase_ptr theGroup2,
143 const char* theName )
144 throw (SALOME::SALOME_Exception);
146 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
147 const char* theName )
148 throw (SALOME::SALOME_Exception);
150 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
151 SMESH::SMESH_GroupBase_ptr theGroup2,
152 const char* theName )
153 throw (SALOME::SALOME_Exception);
155 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
156 const SMESH::ListOfGroups& theToolGroups,
157 const char* theName )
158 throw (SALOME::SALOME_Exception);
160 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
161 SMESH::ElementType theElemType,
162 const char* theName )
163 throw (SALOME::SALOME_Exception);
166 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn )
167 throw (SALOME::SALOME_Exception);
169 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
170 throw (SALOME::SALOME_Exception);
172 SMESH::SMESH_MeshEditor_ptr GetMeshEditor() throw (SALOME::SALOME_Exception);
174 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer() throw (SALOME::SALOME_Exception);
176 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
178 void ClearLog() throw (SALOME::SALOME_Exception);
180 CORBA::Long GetId() throw (SALOME::SALOME_Exception);
182 CORBA::Long GetStudyId() throw (SALOME::SALOME_Exception);
186 void SetImpl(::SMESH_Mesh* impl);
187 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
189 SMESH_Gen_i* GetGen() { return _gen_i; }
191 int ImportUNVFile( const char* theFileName )
192 throw (SALOME::SALOME_Exception);
194 int ImportSTLFile( const char* theFileName )
195 throw (SALOME::SALOME_Exception);
197 SMESH::ComputeError* ImportGMFFile( const char* theFileName,
198 bool theMakeRequiredGroups)
199 throw (SALOME::SALOME_Exception);
202 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
204 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
205 throw (SALOME::SALOME_Exception);
207 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
208 const int theMeshIndex,
209 std::string& theMeshName)
210 throw (SALOME::SALOME_Exception);
215 void SetAutoColor(CORBA::Boolean theAutoColor)
216 throw (SALOME::SALOME_Exception);
218 CORBA::Boolean GetAutoColor()
219 throw (SALOME::SALOME_Exception);
221 /*! Check group names for duplications.
222 * Consider maximum group name length stored in MED file.
224 CORBA::Boolean HasDuplicatedGroupNamesMED();
226 * Return string representation of a MED file version comprising nbDigits
228 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
230 void ExportToMEDX( const char* file,
231 CORBA::Boolean auto_groups,
232 SMESH::MED_VERSION version,
233 CORBA::Boolean overwrite,
234 CORBA::Boolean autoDimension=true) throw (SALOME::SALOME_Exception);
235 void ExportToMED ( const char* file,
236 CORBA::Boolean auto_groups,
237 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
238 void ExportMED ( const char* file,
239 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
241 void ExportSAUV( const char* file, CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
243 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
244 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
245 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
246 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
248 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
249 void ExportGMF(SMESH::SMESH_IDSource_ptr meshPart,
251 CORBA::Boolean withRequiredGroups) throw (SALOME::SALOME_Exception);
253 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
255 CORBA::Boolean auto_groups,
256 SMESH::MED_VERSION version,
257 CORBA::Boolean overwrite,
258 CORBA::Boolean autoDim=true) throw (SALOME::SALOME_Exception);
259 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
260 const char* file) throw (SALOME::SALOME_Exception);
261 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
262 const char* file) throw (SALOME::SALOME_Exception);
263 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
265 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
267 CORBA::Long NbNodes()
268 throw (SALOME::SALOME_Exception);
270 CORBA::Long NbElements()
271 throw (SALOME::SALOME_Exception);
273 CORBA::Long Nb0DElements()
274 throw (SALOME::SALOME_Exception);
276 CORBA::Long NbBalls()
277 throw (SALOME::SALOME_Exception);
279 CORBA::Long NbEdges()
280 throw (SALOME::SALOME_Exception);
282 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
283 throw (SALOME::SALOME_Exception);
285 CORBA::Long NbFaces()
286 throw (SALOME::SALOME_Exception);
288 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
289 throw (SALOME::SALOME_Exception);
291 CORBA::Long NbTriangles()
292 throw (SALOME::SALOME_Exception);
294 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
295 throw (SALOME::SALOME_Exception);
297 CORBA::Long NbBiQuadTriangles()
298 throw (SALOME::SALOME_Exception);
300 CORBA::Long NbQuadrangles()
301 throw (SALOME::SALOME_Exception);
303 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
304 throw (SALOME::SALOME_Exception);
306 CORBA::Long NbBiQuadQuadrangles()
307 throw (SALOME::SALOME_Exception);
309 CORBA::Long NbPolygons()
310 throw (SALOME::SALOME_Exception);
312 CORBA::Long NbVolumes()
313 throw (SALOME::SALOME_Exception);
315 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
316 throw (SALOME::SALOME_Exception);
318 CORBA::Long NbTetras()
319 throw (SALOME::SALOME_Exception);
321 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
322 throw (SALOME::SALOME_Exception);
324 CORBA::Long NbHexas()
325 throw (SALOME::SALOME_Exception);
327 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
328 throw (SALOME::SALOME_Exception);
330 CORBA::Long NbTriQuadraticHexas()
331 throw (SALOME::SALOME_Exception);
333 CORBA::Long NbPyramids()
334 throw (SALOME::SALOME_Exception);
336 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
337 throw (SALOME::SALOME_Exception);
339 CORBA::Long NbPrisms()
340 throw (SALOME::SALOME_Exception);
342 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
343 throw (SALOME::SALOME_Exception);
345 CORBA::Long NbHexagonalPrisms()
346 throw (SALOME::SALOME_Exception);
348 CORBA::Long NbPolyhedrons()
349 throw (SALOME::SALOME_Exception);
351 CORBA::Long NbSubMesh()
352 throw (SALOME::SALOME_Exception);
354 SMESH::long_array* GetElementsId()
355 throw (SALOME::SALOME_Exception);
357 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
358 throw (SALOME::SALOME_Exception);
360 SMESH::long_array* GetNodesId()
361 throw (SALOME::SALOME_Exception);
363 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
364 throw (SALOME::SALOME_Exception);
366 SMESH::EntityType GetElementGeomType( CORBA::Long id )
367 throw (SALOME::SALOME_Exception);
370 * Returns ID of elements for given submesh
372 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
373 throw (SALOME::SALOME_Exception);
376 * Returns ID of nodes for given submesh
377 * If param all==true - returns all nodes, else -
378 * returns only nodes on shapes.
380 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
381 throw (SALOME::SALOME_Exception);
384 * Returns type of elements for given submesh
386 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
387 throw (SALOME::SALOME_Exception);
391 // Create groups of elements preventing computation of a sub-shape
392 SMESH::ListOfGroups* MakeGroupsOfBadInputElements( int theSubShapeID,
393 const char* theGroupName)
394 throw (SALOME::SALOME_Exception);
396 // Internal methods not available through CORBA
397 // They are called by corresponding interface methods
398 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
399 SMESH::SMESH_Hypothesis_ptr anHyp);
401 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
402 SMESH::SMESH_Hypothesis_ptr anHyp);
404 static SMESH::Hypothesis_Status
405 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
407 static void PrepareForWriting (const char* file, bool overwrite = true);
409 //int importMEDFile( const char* theFileName, const char* theMeshName );
411 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
413 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
414 GEOM::GEOM_Object_ptr theSubShapeObject );
416 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
418 const TopoDS_Shape& theShape = TopoDS_Shape(),
419 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
421 void removeGroup( const int theId );
423 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
424 // return an existing subMesh object for the shapeID. shapeID == submeshID.
426 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
427 // return existing group objects
429 void onHypothesisModified();
430 // callback from _impl to forget not loaded mesh data (issue 0021208)
432 void checkMeshLoaded();
435 * \brief Update hypotheses assigned to geom groups if the latter change
437 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
439 void CheckGeomGroupModif();
441 CORBA::LongLong GetMeshPtr();
444 * \brief Assure that all groups are published
446 void CreateGroupServants();
449 * \brief Return groups cantained in _mapGroups by their IDs
451 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
454 * Get XYZ coordinates of node as list of double
455 * If there is not node for given ID - returns empty list
457 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
460 * For given node returns list of IDs of inverse elements
461 * If there is not node for given ID - returns empty list
463 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
466 * \brief Return position of a node on shape
468 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
471 * \brief Return position of an element on shape
473 SMESH::ElementPosition GetElementPosition(CORBA::Long ElemID);
476 * If given element is node returns IDs of shape from position
477 * If there is not node for given ID - returns -1
479 CORBA::Long GetShapeID(CORBA::Long id);
482 * For given element returns ID of result shape after
483 * ::FindShape() from SMESH_MeshEditor
484 * If there is not element for given ID - returns -1
486 CORBA::Long GetShapeIDForElem(CORBA::Long id);
489 * Returns number of nodes for given element
490 * If there is not element for given ID - returns -1
492 CORBA::Long GetElemNbNodes(CORBA::Long id);
495 * Returns IDs of nodes of given element
497 SMESH::long_array* GetElemNodes(CORBA::Long id);
500 * Returns ID of node by given index for given element
501 * If there is not element for given ID - returns -1
502 * If there is not node for given index - returns -2
504 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
507 * Returns true if given node is medium node
508 * in given quadratic element
510 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
513 * Returns true if given node is medium node
514 * in one of quadratic elements
516 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
517 SMESH::ElementType theElemType);
520 * Returns number of edges for given element
522 CORBA::Long ElemNbEdges(CORBA::Long id);
525 * Returns number of faces for given element
527 CORBA::Long ElemNbFaces(CORBA::Long id);
529 * Returns nodes of given face (counted from zero) for given element.
531 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
534 * Returns an element based on all given nodes.
536 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
539 * Returns true if given element is polygon
541 CORBA::Boolean IsPoly(CORBA::Long id);
544 * Returns true if given element is quadratic
546 CORBA::Boolean IsQuadratic(CORBA::Long id);
549 * Returns diameter of ball discrete element or zero in case of an invalid \a id
551 CORBA::Double GetBallDiameter(CORBA::Long id);
554 * Returns bary center for given element
556 SMESH::double_array* BaryCenter(CORBA::Long id);
559 * Returns information about imported MED file
561 virtual SMESH::MedFileInfo* GetMEDFileInfo();
564 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
566 void SetParameters (const char* theParameters);
569 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
571 char* GetParameters();
574 * Returns list of notebook variables used for last Mesh operation
576 SMESH::string_array* GetLastParameters();
579 * Collect statistic of mesh elements given by iterator
581 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
582 SMESH::long_array& theInfo);
585 * \brief Return submesh objects list in meshing order
587 virtual SMESH::submesh_array_array* GetMeshOrder();
589 * \brief Set submesh object order
591 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
594 // =========================
595 // SMESH_IDSource interface
596 // =========================
598 virtual SMESH::long_array* GetIDs();
600 * Returns statistic of mesh elements
601 * Result array of number enityties
602 * Inherited from SMESH_IDSource
604 virtual SMESH::long_array* GetMeshInfo();
606 * Returns types of elements it contains
608 virtual SMESH::array_of_ElementType* GetTypes();
612 virtual SMESH::SMESH_Mesh_ptr GetMesh();
614 * Returns false if GetMeshInfo() returns incorrect information that may
615 * happen if mesh data is not yet fully loaded from the file of study.
617 bool IsMeshInfoCorrect();
619 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
620 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
623 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
626 * Check and correct names of mesh groups
628 void checkGroupNames();
631 * Convert submesh ids into submesh interfaces
633 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
634 SMESH::submesh_array_array& theSubMeshOrder,
635 const bool theIsDump);
639 static int _idGenerator;
640 ::SMESH_Mesh* _impl; // :: force no namespace here
642 int _id; // id given by creator (unique within the creator instance)
644 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
645 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
646 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
647 SMESH::MedFileInfo_var _medFileInfo;
648 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
650 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
651 friend class SMESH_PreMeshInfo;
655 // Data used to track changes of GEOM groups
656 struct TGeomGroupData {
657 // keep study entry but not ior because GEOM_Object actually changes if
658 // number of items in a group varies (1) <-> (>1)
659 std::string _groupEntry;
660 std::set<int> _indices; // indices of group items within group's main shape
661 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
663 std::list<TGeomGroupData> _geomGroupData;
666 * Remember GEOM group data
668 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
669 CORBA::Object_ptr theSmeshObj);
671 * Remove GEOM group data relating to removed smesh object
673 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
675 * \brief Return new group contents if it has been changed and update group data
677 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);