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
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_Mesh)
33 #include CORBA_SERVER_HEADER(SMESH_Group)
34 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
35 #include CORBA_CLIENT_HEADER(GEOM_Gen)
36 #include CORBA_CLIENT_HEADER(MED)
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();
65 void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
66 throw (SALOME::SALOME_Exception);
68 CORBA::Boolean HasShapeToMesh()
69 throw (SALOME::SALOME_Exception);
71 GEOM::GEOM_Object_ptr GetShapeToMesh()
72 throw (SALOME::SALOME_Exception);
74 CORBA::Boolean IsLoaded()
75 throw (SALOME::SALOME_Exception);
78 throw (SALOME::SALOME_Exception);
81 throw (SALOME::SALOME_Exception);
83 void ClearSubMesh(CORBA::Long ShapeID)
84 throw (SALOME::SALOME_Exception);
86 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
87 SMESH::SMESH_Hypothesis_ptr anHyp)
88 throw (SALOME::SALOME_Exception);
90 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
91 SMESH::SMESH_Hypothesis_ptr anHyp)
92 throw (SALOME::SALOME_Exception);
94 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
95 throw (SALOME::SALOME_Exception);
97 SMESH::submesh_array* GetSubMeshes()
98 throw (SALOME::SALOME_Exception);
100 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
101 throw (SALOME::SALOME_Exception);
103 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
104 throw (SALOME::SALOME_Exception);
106 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
107 throw (SALOME::SALOME_Exception);
109 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
111 GEOM::GEOM_Object_ptr theGeomObj )
112 throw (SALOME::SALOME_Exception);
114 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
116 SMESH::Filter_ptr theFilter )
117 throw (SALOME::SALOME_Exception);
119 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
120 throw (SALOME::SALOME_Exception);
122 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
123 throw (SALOME::SALOME_Exception);
125 SMESH::ListOfGroups* GetGroups()
126 throw (SALOME::SALOME_Exception);
128 CORBA::Long NbGroups()
129 throw (SALOME::SALOME_Exception);
131 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
132 SMESH::SMESH_GroupBase_ptr theGroup2,
133 const char* theName )
134 throw (SALOME::SALOME_Exception);
136 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
138 throw (SALOME::SALOME_Exception);
140 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
141 SMESH::SMESH_GroupBase_ptr theGroup2,
142 const char* theName )
143 throw (SALOME::SALOME_Exception);
145 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
146 const char* theName )
147 throw (SALOME::SALOME_Exception);
149 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
150 SMESH::SMESH_GroupBase_ptr theGroup2,
151 const char* theName )
152 throw (SALOME::SALOME_Exception);
154 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
155 const SMESH::ListOfGroups& theToolGroups,
156 const char* theName )
157 throw (SALOME::SALOME_Exception);
159 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
160 SMESH::ElementType theElemType,
161 const char* theName )
162 throw (SALOME::SALOME_Exception);
165 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn );
167 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
168 // throw (SALOME::SALOME_Exception);
170 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
171 throw (SALOME::SALOME_Exception);
173 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
175 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
177 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
180 throw (SALOME::SALOME_Exception);
183 throw (SALOME::SALOME_Exception);
185 CORBA::Long GetStudyId()
186 throw (SALOME::SALOME_Exception);
189 void SetImpl(::SMESH_Mesh* impl);
190 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
192 SMESH_Gen_i* GetGen() { return _gen_i; }
194 int ImportUNVFile( const char* theFileName )
195 throw (SALOME::SALOME_Exception);
197 int ImportSTLFile( const char* theFileName )
198 throw (SALOME::SALOME_Exception);
201 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
203 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
204 throw (SALOME::SALOME_Exception);
206 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
207 const int theMeshIndex,
208 std::string& theMeshName)
209 throw (SALOME::SALOME_Exception);
214 void SetAutoColor(CORBA::Boolean theAutoColor)
215 throw (SALOME::SALOME_Exception);
217 CORBA::Boolean GetAutoColor()
218 throw (SALOME::SALOME_Exception);
220 /*! Check group names for duplications.
221 * Consider maximum group name length stored in MED file.
223 CORBA::Boolean HasDuplicatedGroupNamesMED();
225 * Return string representation of a MED file version comprising nbDigits
227 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
229 void ExportToMEDX( const char* file,
230 CORBA::Boolean auto_groups,
231 SMESH::MED_VERSION version,
232 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
233 void ExportToMED ( const char* file,
234 CORBA::Boolean auto_groups,
235 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
236 void ExportMED ( const char* file,
237 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
239 void ExportSAUV( const char* file, CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
241 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
242 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
243 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
244 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
246 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
248 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
250 CORBA::Boolean auto_groups,
251 SMESH::MED_VERSION version,
252 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
253 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
254 const char* file) throw (SALOME::SALOME_Exception);
255 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
256 const char* file) throw (SALOME::SALOME_Exception);
257 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
259 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
261 SALOME_MED::MESH_ptr GetMEDMesh()
262 throw (SALOME::SALOME_Exception);
264 CORBA::Long NbNodes()
265 throw (SALOME::SALOME_Exception);
267 CORBA::Long NbElements()
268 throw (SALOME::SALOME_Exception);
270 CORBA::Long Nb0DElements()
271 throw (SALOME::SALOME_Exception);
273 CORBA::Long NbBalls()
274 throw (SALOME::SALOME_Exception);
276 CORBA::Long NbEdges()
277 throw (SALOME::SALOME_Exception);
279 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
280 throw (SALOME::SALOME_Exception);
282 CORBA::Long NbFaces()
283 throw (SALOME::SALOME_Exception);
285 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
286 throw (SALOME::SALOME_Exception);
288 CORBA::Long NbTriangles()
289 throw (SALOME::SALOME_Exception);
291 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
292 throw (SALOME::SALOME_Exception);
294 CORBA::Long NbQuadrangles()
295 throw (SALOME::SALOME_Exception);
297 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
298 throw (SALOME::SALOME_Exception);
300 CORBA::Long NbBiQuadQuadrangles()
301 throw (SALOME::SALOME_Exception);
303 CORBA::Long NbPolygons()
304 throw (SALOME::SALOME_Exception);
306 CORBA::Long NbVolumes()
307 throw (SALOME::SALOME_Exception);
309 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
310 throw (SALOME::SALOME_Exception);
312 CORBA::Long NbTetras()
313 throw (SALOME::SALOME_Exception);
315 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
316 throw (SALOME::SALOME_Exception);
318 CORBA::Long NbHexas()
319 throw (SALOME::SALOME_Exception);
321 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
322 throw (SALOME::SALOME_Exception);
324 CORBA::Long NbTriQuadraticHexas()
325 throw (SALOME::SALOME_Exception);
327 CORBA::Long NbPyramids()
328 throw (SALOME::SALOME_Exception);
330 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
331 throw (SALOME::SALOME_Exception);
333 CORBA::Long NbPrisms()
334 throw (SALOME::SALOME_Exception);
336 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
337 throw (SALOME::SALOME_Exception);
339 CORBA::Long NbHexagonalPrisms()
340 throw (SALOME::SALOME_Exception);
342 CORBA::Long NbPolyhedrons()
343 throw (SALOME::SALOME_Exception);
345 CORBA::Long NbSubMesh()
346 throw (SALOME::SALOME_Exception);
348 SMESH::long_array* GetElementsId()
349 throw (SALOME::SALOME_Exception);
351 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
352 throw (SALOME::SALOME_Exception);
354 SMESH::long_array* GetNodesId()
355 throw (SALOME::SALOME_Exception);
357 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
358 throw (SALOME::SALOME_Exception);
360 SMESH::EntityType GetElementGeomType( CORBA::Long id )
361 throw (SALOME::SALOME_Exception);
364 * Returns ID of elements for given submesh
366 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
367 throw (SALOME::SALOME_Exception);
370 * Returns ID of nodes for given submesh
371 * If param all==true - returns all nodes, else -
372 * returns only nodes on shapes.
374 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
375 throw (SALOME::SALOME_Exception);
378 * Returns type of elements for given submesh
380 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
381 throw (SALOME::SALOME_Exception);
385 // Internal methods not available through CORBA
386 // They are called by corresponding interface methods
387 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
388 SMESH::SMESH_Hypothesis_ptr anHyp);
390 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
391 SMESH::SMESH_Hypothesis_ptr anHyp);
393 static SMESH::Hypothesis_Status
394 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
396 static void PrepareForWriting (const char* file, bool overwrite = true);
398 //int importMEDFile( const char* theFileName, const char* theMeshName );
400 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
402 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
403 GEOM::GEOM_Object_ptr theSubShapeObject );
405 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
407 const TopoDS_Shape& theShape = TopoDS_Shape(),
408 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
410 void removeGroup( const int theId );
412 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
413 // return an existing subMesh object for the shapeID. shapeID == submeshID.
415 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
416 // return an existing group object.
418 void onHypothesisModified();
419 // callback from _impl to forget not loaded mesh data (issue 0021208)
421 void checkMeshLoaded();
424 * \brief Update hypotheses assigned to geom groups if the latter change
426 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
428 void CheckGeomGroupModif();
430 CORBA::LongLong GetMeshPtr();
433 * \brief Assure that all groups are published
435 void CreateGroupServants();
438 * \brief Return groups cantained in _mapGroups by their IDs
440 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
443 * Get XYZ coordinates of node as list of double
444 * If there is not node for given ID - returns empty list
446 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
449 * For given node returns list of IDs of inverse elements
450 * If there is not node for given ID - returns empty list
452 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
455 * \brief Return position of a node on shape
457 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
460 * If given element is node returns IDs of shape from position
461 * If there is not node for given ID - returns -1
463 CORBA::Long GetShapeID(CORBA::Long id);
466 * For given element returns ID of result shape after
467 * ::FindShape() from SMESH_MeshEditor
468 * If there is not element for given ID - returns -1
470 CORBA::Long GetShapeIDForElem(CORBA::Long id);
473 * Returns number of nodes for given element
474 * If there is not element for given ID - returns -1
476 CORBA::Long GetElemNbNodes(CORBA::Long id);
479 * Returns IDs of nodes of given element
481 SMESH::long_array* GetElemNodes(CORBA::Long id);
484 * Returns ID of node by given index for given element
485 * If there is not element for given ID - returns -1
486 * If there is not node for given index - returns -2
488 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
491 * Returns true if given node is medium node
492 * in given quadratic element
494 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
497 * Returns true if given node is medium node
498 * in one of quadratic elements
500 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
501 SMESH::ElementType theElemType);
504 * Returns number of edges for given element
506 CORBA::Long ElemNbEdges(CORBA::Long id);
509 * Returns number of faces for given element
511 CORBA::Long ElemNbFaces(CORBA::Long id);
513 * Returns nodes of given face (counted from zero) for given element.
515 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
518 * Returns an element based on all given nodes.
520 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
523 * Returns true if given element is polygon
525 CORBA::Boolean IsPoly(CORBA::Long id);
528 * Returns true if given element is quadratic
530 CORBA::Boolean IsQuadratic(CORBA::Long id);
533 * Returns diameter of ball discrete element or zero in case of an invalid \a id
535 CORBA::Double GetBallDiameter(CORBA::Long id);
538 * Returns bary center for given element
540 SMESH::double_array* BaryCenter(CORBA::Long id);
543 * Returns information about imported MED file
545 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
548 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
550 void SetParameters (const char* theParameters);
553 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
555 char* GetParameters();
558 * Returns list of notebook variables used for last Mesh operation
560 SMESH::string_array* GetLastParameters();
563 * Collect statistic of mesh elements given by iterator
565 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
566 SMESH::long_array& theInfo);
569 * \brief Return submesh objects list in meshing order
571 virtual SMESH::submesh_array_array* GetMeshOrder();
573 * \brief Set submesh object order
575 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
578 // =========================
579 // SMESH_IDSource interface
580 // =========================
582 virtual SMESH::long_array* GetIDs();
584 * Returns statistic of mesh elements
585 * Result array of number enityties
586 * Inherited from SMESH_IDSource
588 virtual SMESH::long_array* GetMeshInfo();
590 * Returns types of elements it contains
592 virtual SMESH::array_of_ElementType* GetTypes();
596 virtual SMESH::SMESH_Mesh_ptr GetMesh();
598 * Returns false if GetMeshInfo() returns incorrect information that may
599 * happen if mesh data is not yet fully loaded from the file of study.
601 bool IsMeshInfoCorrect();
603 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
604 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
607 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
610 * Check and correct names of mesh groups
612 void checkGroupNames();
615 * Convert submesh ids into submesh interfaces
617 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
618 SMESH::submesh_array_array& theSubMeshOrder,
619 const bool theIsDump);
623 static int _idGenerator;
624 ::SMESH_Mesh* _impl; // :: force no namespace here
626 int _id; // id given by creator (unique within the creator instance)
628 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
629 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
630 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
631 SALOME_MED::MedFileInfo_var _medFileInfo;
632 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
634 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
635 friend class SMESH_PreMeshInfo;
639 // Data used to track changes of GEOM groups
640 struct TGeomGroupData {
641 // keep study entry but not ior because GEOM_Object actually changes if
642 // number of items in a group varies (1) <-> (>1)
643 std::string _groupEntry;
644 std::set<int> _indices; // indices of group items within group's main shape
645 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
647 std::list<TGeomGroupData> _geomGroupData;
650 * Remember GEOM group data
652 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
653 CORBA::Object_ptr theSmeshObj);
655 * Remove GEOM group data relating to removed smesh object
657 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
659 * \brief Return new group contents if it has been changed and update group data
661 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);