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_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)
37 #include CORBA_CLIENT_HEADER(MED)
39 #include "SMESH_Hypothesis.hxx"
40 #include "SMESH_Mesh.hxx"
41 #include "SMESH_subMesh.hxx"
43 #include "SALOME_GenericObj_i.hh"
46 class SMESH_GroupBase_i;
47 class SMESH_subMesh_i;
48 class SMESH_PreMeshInfo;
52 class SMESH_I_EXPORT SMESH_Mesh_i:
53 public virtual POA_SMESH::SMESH_Mesh,
54 public virtual SALOME::GenericObj_i
57 SMESH_Mesh_i(const SMESH_Mesh_i&);
59 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
61 CORBA::Long studyId );
63 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 );
168 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
169 // throw (SALOME::SALOME_Exception);
171 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
172 throw (SALOME::SALOME_Exception);
174 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
176 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
178 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
181 throw (SALOME::SALOME_Exception);
184 throw (SALOME::SALOME_Exception);
186 CORBA::Long GetStudyId()
187 throw (SALOME::SALOME_Exception);
190 void SetImpl(::SMESH_Mesh* impl);
191 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
193 SMESH_Gen_i* GetGen() { return _gen_i; }
195 int ImportUNVFile( const char* theFileName )
196 throw (SALOME::SALOME_Exception);
198 int ImportSTLFile( const char* theFileName )
199 throw (SALOME::SALOME_Exception);
201 SMESH::ComputeError* ImportGMFFile( const char* theFileName,
202 bool theMakeRequiredGroups)
203 throw (SALOME::SALOME_Exception);
206 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
208 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
209 throw (SALOME::SALOME_Exception);
211 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
212 const int theMeshIndex,
213 std::string& theMeshName)
214 throw (SALOME::SALOME_Exception);
219 void SetAutoColor(CORBA::Boolean theAutoColor)
220 throw (SALOME::SALOME_Exception);
222 CORBA::Boolean GetAutoColor()
223 throw (SALOME::SALOME_Exception);
225 /*! Check group names for duplications.
226 * Consider maximum group name length stored in MED file.
228 CORBA::Boolean HasDuplicatedGroupNamesMED();
230 * Return string representation of a MED file version comprising nbDigits
232 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
234 void ExportToMEDX( const char* file,
235 CORBA::Boolean auto_groups,
236 SMESH::MED_VERSION version,
237 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
238 void ExportToMED ( const char* file,
239 CORBA::Boolean auto_groups,
240 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
241 void ExportMED ( const char* file,
242 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
244 void ExportSAUV( const char* file, CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
246 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
247 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
248 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
249 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
251 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
252 void ExportGMF(SMESH::SMESH_IDSource_ptr meshPart,
254 CORBA::Boolean withRequiredGroups) throw (SALOME::SALOME_Exception);
256 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
258 CORBA::Boolean auto_groups,
259 SMESH::MED_VERSION version,
260 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
261 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
262 const char* file) throw (SALOME::SALOME_Exception);
263 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
264 const char* file) throw (SALOME::SALOME_Exception);
265 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
267 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
269 SALOME_MED::MESH_ptr GetMEDMesh()
270 throw (SALOME::SALOME_Exception);
272 CORBA::Long NbNodes()
273 throw (SALOME::SALOME_Exception);
275 CORBA::Long NbElements()
276 throw (SALOME::SALOME_Exception);
278 CORBA::Long Nb0DElements()
279 throw (SALOME::SALOME_Exception);
281 CORBA::Long NbBalls()
282 throw (SALOME::SALOME_Exception);
284 CORBA::Long NbEdges()
285 throw (SALOME::SALOME_Exception);
287 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
288 throw (SALOME::SALOME_Exception);
290 CORBA::Long NbFaces()
291 throw (SALOME::SALOME_Exception);
293 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
294 throw (SALOME::SALOME_Exception);
296 CORBA::Long NbTriangles()
297 throw (SALOME::SALOME_Exception);
299 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
300 throw (SALOME::SALOME_Exception);
302 CORBA::Long NbQuadrangles()
303 throw (SALOME::SALOME_Exception);
305 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
306 throw (SALOME::SALOME_Exception);
308 CORBA::Long NbBiQuadQuadrangles()
309 throw (SALOME::SALOME_Exception);
311 CORBA::Long NbPolygons()
312 throw (SALOME::SALOME_Exception);
314 CORBA::Long NbVolumes()
315 throw (SALOME::SALOME_Exception);
317 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
318 throw (SALOME::SALOME_Exception);
320 CORBA::Long NbTetras()
321 throw (SALOME::SALOME_Exception);
323 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
324 throw (SALOME::SALOME_Exception);
326 CORBA::Long NbHexas()
327 throw (SALOME::SALOME_Exception);
329 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
330 throw (SALOME::SALOME_Exception);
332 CORBA::Long NbTriQuadraticHexas()
333 throw (SALOME::SALOME_Exception);
335 CORBA::Long NbPyramids()
336 throw (SALOME::SALOME_Exception);
338 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
339 throw (SALOME::SALOME_Exception);
341 CORBA::Long NbPrisms()
342 throw (SALOME::SALOME_Exception);
344 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
345 throw (SALOME::SALOME_Exception);
347 CORBA::Long NbHexagonalPrisms()
348 throw (SALOME::SALOME_Exception);
350 CORBA::Long NbPolyhedrons()
351 throw (SALOME::SALOME_Exception);
353 CORBA::Long NbSubMesh()
354 throw (SALOME::SALOME_Exception);
356 SMESH::long_array* GetElementsId()
357 throw (SALOME::SALOME_Exception);
359 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
360 throw (SALOME::SALOME_Exception);
362 SMESH::long_array* GetNodesId()
363 throw (SALOME::SALOME_Exception);
365 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
366 throw (SALOME::SALOME_Exception);
368 SMESH::EntityType GetElementGeomType( CORBA::Long id )
369 throw (SALOME::SALOME_Exception);
372 * Returns ID of elements for given submesh
374 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
375 throw (SALOME::SALOME_Exception);
378 * Returns ID of nodes for given submesh
379 * If param all==true - returns all nodes, else -
380 * returns only nodes on shapes.
382 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
383 throw (SALOME::SALOME_Exception);
386 * Returns type of elements for given submesh
388 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
389 throw (SALOME::SALOME_Exception);
393 // Internal methods not available through CORBA
394 // They are called by corresponding interface methods
395 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
396 SMESH::SMESH_Hypothesis_ptr anHyp);
398 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
399 SMESH::SMESH_Hypothesis_ptr anHyp);
401 static SMESH::Hypothesis_Status
402 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
404 static void PrepareForWriting (const char* file, bool overwrite = true);
406 //int importMEDFile( const char* theFileName, const char* theMeshName );
408 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
410 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
411 GEOM::GEOM_Object_ptr theSubShapeObject );
413 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
415 const TopoDS_Shape& theShape = TopoDS_Shape(),
416 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
418 void removeGroup( const int theId );
420 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
421 // return an existing subMesh object for the shapeID. shapeID == submeshID.
423 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
424 // return an existing group object.
426 void onHypothesisModified();
427 // callback from _impl to forget not loaded mesh data (issue 0021208)
429 void checkMeshLoaded();
432 * \brief Update hypotheses assigned to geom groups if the latter change
434 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
436 void CheckGeomGroupModif();
438 CORBA::LongLong GetMeshPtr();
441 * \brief Assure that all groups are published
443 void CreateGroupServants();
446 * \brief Return groups cantained in _mapGroups by their IDs
448 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
451 * Get XYZ coordinates of node as list of double
452 * If there is not node for given ID - returns empty list
454 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
457 * For given node returns list of IDs of inverse elements
458 * If there is not node for given ID - returns empty list
460 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
463 * \brief Return position of a node on shape
465 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
468 * If given element is node returns IDs of shape from position
469 * If there is not node for given ID - returns -1
471 CORBA::Long GetShapeID(CORBA::Long id);
474 * For given element returns ID of result shape after
475 * ::FindShape() from SMESH_MeshEditor
476 * If there is not element for given ID - returns -1
478 CORBA::Long GetShapeIDForElem(CORBA::Long id);
481 * Returns number of nodes for given element
482 * If there is not element for given ID - returns -1
484 CORBA::Long GetElemNbNodes(CORBA::Long id);
487 * Returns IDs of nodes of given element
489 SMESH::long_array* GetElemNodes(CORBA::Long id);
492 * Returns ID of node by given index for given element
493 * If there is not element for given ID - returns -1
494 * If there is not node for given index - returns -2
496 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
499 * Returns true if given node is medium node
500 * in given quadratic element
502 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
505 * Returns true if given node is medium node
506 * in one of quadratic elements
508 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
509 SMESH::ElementType theElemType);
512 * Returns number of edges for given element
514 CORBA::Long ElemNbEdges(CORBA::Long id);
517 * Returns number of faces for given element
519 CORBA::Long ElemNbFaces(CORBA::Long id);
521 * Returns nodes of given face (counted from zero) for given element.
523 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
526 * Returns an element based on all given nodes.
528 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
531 * Returns true if given element is polygon
533 CORBA::Boolean IsPoly(CORBA::Long id);
536 * Returns true if given element is quadratic
538 CORBA::Boolean IsQuadratic(CORBA::Long id);
541 * Returns diameter of ball discrete element or zero in case of an invalid \a id
543 CORBA::Double GetBallDiameter(CORBA::Long id);
546 * Returns bary center for given element
548 SMESH::double_array* BaryCenter(CORBA::Long id);
551 * Returns information about imported MED file
553 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
556 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
558 void SetParameters (const char* theParameters);
561 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
563 char* GetParameters();
566 * Returns list of notebook variables used for last Mesh operation
568 SMESH::string_array* GetLastParameters();
571 * Collect statistic of mesh elements given by iterator
573 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
574 SMESH::long_array& theInfo);
577 * \brief Return submesh objects list in meshing order
579 virtual SMESH::submesh_array_array* GetMeshOrder();
581 * \brief Set submesh object order
583 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
586 // =========================
587 // SMESH_IDSource interface
588 // =========================
590 virtual SMESH::long_array* GetIDs();
592 * Returns statistic of mesh elements
593 * Result array of number enityties
594 * Inherited from SMESH_IDSource
596 virtual SMESH::long_array* GetMeshInfo();
598 * Returns types of elements it contains
600 virtual SMESH::array_of_ElementType* GetTypes();
604 virtual SMESH::SMESH_Mesh_ptr GetMesh();
606 * Returns false if GetMeshInfo() returns incorrect information that may
607 * happen if mesh data is not yet fully loaded from the file of study.
609 bool IsMeshInfoCorrect();
611 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
612 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
615 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
618 * Check and correct names of mesh groups
620 void checkGroupNames();
623 * Convert submesh ids into submesh interfaces
625 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
626 SMESH::submesh_array_array& theSubMeshOrder,
627 const bool theIsDump);
631 static int _idGenerator;
632 ::SMESH_Mesh* _impl; // :: force no namespace here
634 int _id; // id given by creator (unique within the creator instance)
636 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
637 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
638 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
639 SALOME_MED::MedFileInfo_var _medFileInfo;
640 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
642 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
643 friend class SMESH_PreMeshInfo;
647 // Data used to track changes of GEOM groups
648 struct TGeomGroupData {
649 // keep study entry but not ior because GEOM_Object actually changes if
650 // number of items in a group varies (1) <-> (>1)
651 std::string _groupEntry;
652 std::set<int> _indices; // indices of group items within group's main shape
653 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
655 std::list<TGeomGroupData> _geomGroupData;
658 * Remember GEOM group data
660 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
661 CORBA::Object_ptr theSmeshObj);
663 * Remove GEOM group data relating to removed smesh object
665 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
667 * \brief Return new group contents if it has been changed and update group data
669 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);