Version: 9.12.0
SMESH_Mesh.hxx
Go to the documentation of this file.
1 // Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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, or (at your option) any later version.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 // File : SMESH_Mesh.hxx
24 // Author : Paul RASCLE, EDF
25 // Module : SMESH
26 //
27 #ifndef _SMESH_MESH_HXX_
28 #define _SMESH_MESH_HXX_
29 
30 #include "SMESH_SMESH.hxx"
31 
32 #include "SMDSAbs_ElementType.hxx"
33 #include "SMESH_ComputeError.hxx"
34 #include "SMESH_Controls.hxx"
35 #include "SMESH_Hypothesis.hxx"
36 #include "SMESH_subMesh.hxx"
37 #include "SMDS_Iterator.hxx"
38 
39 #include "Utils_SALOME_Exception.hxx"
40 
41 #include <TopoDS_Shape.hxx>
42 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
43 #include <TopTools_ListOfShape.hxx>
44 
45 #include "MEDCouplingMemArray.hxx"
46 
47 #include <map>
48 #include <list>
49 #include <vector>
50 #include <ostream>
51 
52 #ifndef WIN32
53 #include <boost/filesystem.hpp>
54 #endif
55 #include <boost/thread.hpp>
56 
57 #ifdef WIN32
58 #pragma warning(disable:4251) // Warning DLL Interface ...
59 #pragma warning(disable:4290) // Warning Exception ...
60 #endif
61 
62 class SMESHDS_Command;
63 class SMESHDS_Document;
64 class SMESHDS_GroupBase;
65 class SMESHDS_Hypothesis;
66 class SMESHDS_Mesh;
67 class SMESH_Gen;
68 class SMESH_Group;
69 class SMESH_HypoFilter;
70 class SMESH_subMesh;
71 class TopoDS_Solid;
72 
74 
75 typedef std::set<int> TSetOfInt;
76 typedef std::list<int> TListOfInt;
77 typedef std::list<TListOfInt> TListOfListOfInt;
78 
80 {
81  public:
82  SMESH_Mesh(int theLocalId,
83  SMESH_Gen* theGen,
84  bool theIsEmbeddedMode,
85  SMESHDS_Document* theDocument);
86 
87  virtual ~SMESH_Mesh();
88 
92  void ShapeToMesh(const TopoDS_Shape & aShape);
96  TopoDS_Shape GetShapeToMesh() const;
100  bool HasShapeToMesh() const { return _isShapeToMesh; }
101 
102  void UndefShapeToMesh() { _isShapeToMesh = false; }
103 
107  double GetShapeDiagonalSize() const;
111  static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
116  static const TopoDS_Solid& PseudoShape();
117 
121  void Load();
125  void Clear();
129  void ClearSubMesh(const int theShapeId);
130 
134  int UNVToMesh(const char* theFileName);
135 
136  int MEDToMesh(const char* theFileName, const char* theMeshName);
137 
138  std::string STLToMesh(const char* theFileName);
139 
140  int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
141 
142  SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
143  bool theMakeRequiredGroups = true );
144 
146  AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
147 
149  RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
150 
151  const std::list <const SMESHDS_Hypothesis * >&
152  GetHypothesisList(const TopoDS_Shape & aSubShape) const;
153 
154  const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
155  const SMESH_HypoFilter& aFilter,
156  const bool andAncestors,
157  TopoDS_Shape* assignedTo=0) const;
158 
159  int GetHypotheses(const TopoDS_Shape & aSubShape,
160  const SMESH_HypoFilter& aFilter,
161  std::list< const SMESHDS_Hypothesis * >& aHypList,
162  const bool andAncestors,
163  std::list< TopoDS_Shape > * assignedTo=0) const;
164 
165  const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
166  const SMESH_HypoFilter& aFilter,
167  const bool andAncestors,
168  TopoDS_Shape* assignedTo=0) const;
169 
170  int GetHypotheses(const SMESH_subMesh * aSubMesh,
171  const SMESH_HypoFilter& aFilter,
172  std::list< const SMESHDS_Hypothesis * >& aHypList,
173  const bool andAncestors,
174  std::list< TopoDS_Shape > * assignedTo=0) const;
175 
176  SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
177 
178  const std::list<SMESHDS_Command*> & GetLog();
179 
180  void ClearLog();
181 
182  int GetId() const { return _id; }
183 
184  bool MeshExists( int meshId ) const;
185 
186  SMESH_Mesh* FindMesh( int meshId ) const;
187 
188  SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
189 
190  const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
191 
192  SMESH_Gen *GetGen() { return _gen; }
193 
194  SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
195 
196  SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
197 
198  SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
202  std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
206  void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
207 
208  // const std::list < SMESH_subMesh * >&
209  // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
213  bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
214  const SMESH_subMesh * aSubMesh);
218  bool IsNotConformAllowed() const;
219 
220  bool IsMainShape(const TopoDS_Shape& theShape) const;
221 
222  TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
223 
228  const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
229 
230  void SetAutoColor(bool theAutoColor);
231 
232  bool GetAutoColor();
233 
238  void SetIsModified(bool isModified);
239 
240  bool GetIsModified() const { return _isModified; }
241 
247  bool HasModificationsToDiscard() const;
248 
252  bool IsComputedOK();
253 
257  typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
258  const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
259 
264  bool HasDuplicatedGroupNamesMED();
265 
270  struct TooLargeForExport : public std::runtime_error
271  {
272  TooLargeForExport(const char* format):runtime_error(format) {}
273  };
274 
275  MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
276  ExportMEDCoupling(const char* theMeshName = NULL,
277  bool theAutoGroups = true,
278  const SMESHDS_Mesh* theMeshPart = 0,
279  bool theAutoDimension = false,
280  bool theAddODOnVertices = false,
281  double theZTolerance = -1.,
282  bool theSaveNumbers = true);
283 
284  void ExportMED(const char * theFile,
285  const char* theMeshName = NULL,
286  bool theAutoGroups = true,
287  int theVersion = -1,
288  const SMESHDS_Mesh* theMeshPart = 0,
289  bool theAutoDimension = false,
290  bool theAddODOnVertices = false,
291  double theZTolerance = -1.,
292  bool theSaveNumbers = true);
293 
294  void ExportDAT(const char * file,
295  const SMESHDS_Mesh* meshPart = 0,
296  const bool renumber = true);
297  void ExportUNV(const char * file,
298  const SMESHDS_Mesh* meshPart = 0,
299  const bool renumber = true);
300  void ExportSTL(const char * file,
301  const bool isascii,
302  const char * name = 0,
303  const SMESHDS_Mesh* meshPart = 0);
304  void ExportCGNS(const char * file,
305  const SMESHDS_Mesh* mesh,
306  const char * meshName = 0,
307  const bool groupElemsByType = false);
308  void ExportGMF(const char * file,
309  const SMESHDS_Mesh* mesh,
310  bool withRequiredGroups = true );
311 
312  double GetComputeProgress() const;
313 
314  smIdType NbNodes() const;
315  smIdType Nb0DElements() const;
316  smIdType NbBalls() const;
317 
318  smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
319 
320  smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
321  smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
322  smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
323  smIdType NbBiQuadQuadrangles() const;
324  smIdType NbBiQuadTriangles() const;
325  smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
326 
327  smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
328  smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
329  smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
330  smIdType NbTriQuadraticHexas() const;
331  smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
332  smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
333  smIdType NbQuadPrisms() const;
334  smIdType NbBiQuadPrisms() const;
335  smIdType NbHexagonalPrisms() const;
336  smIdType NbPolyhedrons() const;
337 
338  smIdType NbSubMesh() const;
339 
340  size_t NbGroup() const { return _mapGroup.size(); }
341 
342  int NbMeshes() const; // nb meshes in the Study
343 
344  SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
345  const char* theName,
346  const int theId = -1,
347  const TopoDS_Shape& theShape = TopoDS_Shape(),
348  const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
349 
351 
352  typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
353  GroupIteratorPtr GetGroups() const;
354 
355  std::list<int> GetGroupIds() const;
356 
357  SMESH_Group* GetGroup (const int theGroupID) const;
358 
359  bool RemoveGroup (const int theGroupID);
360 
361  SMESH_Group* ConvertToStandalone ( int theGroupID );
362 
363  struct TCallUp // callback from SMESH to SMESH_I level
364  {
365  virtual void RemoveGroup( const int theGroupID )=0;
366  virtual void HypothesisModified( int hypID, bool updateIcons )=0;
367  virtual void Load()=0;
368  virtual bool IsLoaded()=0;
369  virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
370  virtual ~TCallUp() {}
371  };
372  void SetCallUp( TCallUp * upCaller );
373 
374  bool SynchronizeGroups();
375 
376 
377  SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
378 
379  void ClearMeshOrder();
380  void SetMeshOrder(const TListOfListOfInt& theOrder );
381  const TListOfListOfInt& GetMeshOrder() const;
382 
383  // sort submeshes according to stored mesh order
384  bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
385 
386  // return true if given order of sub-meshes is OK
387  bool IsOrderOK( const SMESH_subMesh* smBefore,
388  const SMESH_subMesh* smAfter ) const;
389 
390  std::ostream& Dump(std::ostream & save);
391 
392  // Parallel computation functions
393 
394  virtual void Lock(){};
395  virtual void Unlock(){};
396 
397  virtual void wait(){};
398 
399  virtual bool IsParallel(){throw SALOME_Exception("Calling SMESH_Mesh::IsParallel");return false;};
400 
401  virtual bool ComputeSubMeshes(
402  SMESH_Gen* gen,
403  SMESH_Mesh & aMesh,
404  const TopoDS_Shape & aShape,
406  TSetOfInt* aShapesId /*=0*/,
407  TopTools_IndexedMapOfShape* allowedSubShapes,
408  SMESH_subMesh::compute_event &computeEvent,
409  const bool includeSelf,
410  const bool complexShapeFirst,
411  const bool aShapeOnly){(void) gen;(void) aMesh;(void) aShape;(void) aDim;(void) aShapesId;(void) allowedSubShapes;(void) computeEvent;(void) includeSelf;(void) complexShapeFirst;(void) aShapeOnly;throw SALOME_Exception("Calling SMESH_Mesh::ComputeSubMeshes");return false;};
412 
413 private:
414 
415  void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
416  const char* theMeshName,
417  bool theAutoGroups,
418  const SMESHDS_Mesh* meshPart,
419  bool theAutoDimension,
420  bool theAddODOnVertices,
421  double theZTolerance,
422  bool theSaveNumbers);
423 
424  private:
425  void fillAncestorsMap(const TopoDS_Shape& theShape);
426  void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
427  std::vector< SMESH_subMesh* >& theSubMeshes) const;
428 
429 protected:
430  int _id; // id given by creator (unique within the creator instance)
431  int _groupId; // id generator for group objects
432  int _nbSubShapes; // initial nb of subshapes in the shape to mesh
433  bool _isShapeToMesh;// set to true when a shape is given (only once)
437  std::map <int, SMESH_Group*> _mapGroup;
438 
439  class SubMeshHolder;
441 
443  bool _isModified;
444 
445  double _shapeDiagonal;
446 
447  TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
448 
449  mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
450 
452 
453  // Struct calling methods at CORBA API implementation level, used to
454  // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
455  // when group removal is invoked by hyp modification (issue 0020918)
456  // 2) to forget not loaded mesh data at hyp modification
458 
459 protected:
460  SMESH_Mesh();
461  SMESH_Mesh(const SMESH_Mesh&) {};
462 };
463 #endif
SMDSAbs_ElementOrder
Definition: SMDSAbs_ElementType.hxx:70
@ ORDER_ANY
Definition: SMDSAbs_ElementType.hxx:71
SMDSAbs_ElementType
Type (node, edge, face or volume) of elements.
Definition: SMDSAbs_ElementType.hxx:34
boost::shared_ptr< SMESH_ComputeError > SMESH_ComputeErrorPtr
Definition: SMESH_ComputeError.hxx:36
SMESH::Controls::PredicatePtr SMESH_PredicatePtr
Definition: SMESH_Controls.hxx:81
std::set< int > TSetOfInt
Definition: SMESH_Gen.hxx:65
MeshDimension
Definition: SMESH_Hypothesis.hxx:40
std::list< int > TListOfInt
Definition: SMESH_Mesh.hxx:76
std::list< TListOfInt > TListOfListOfInt
Definition: SMESH_Mesh.hxx:77
std::set< int > TSetOfInt
Definition: SMESH_Mesh.hxx:73
#define SMESH_EXPORT
Definition: SMESH_SMESH.hxx:37
Write a mesh to a MED file.
Definition: DriverMED_W_SMESHDS_Mesh.h:49
Definition: SMESHDS_Command.hxx:38
Definition: SMESHDS_Document.hxx:38
Definition: SMESHDS_GroupBase.hxx:42
Definition: SMESHDS_Hypothesis.hxx:37
Definition: SMESHDS_Mesh.hxx:68
Definition: SMESH_Gen.hxx:68
Definition: SMESH_Group.hxx:43
Definition: SMESH_HypoFilter.hxx:57
Definition: SMESH_Hypothesis.hxx:48
Hypothesis_Status
Definition: SMESH_Hypothesis.hxx:51
Definition: SMESH_Mesh.cxx:96
Definition: SMESH_Mesh.hxx:80
SMESH_Gen * GetGen()
Definition: SMESH_Mesh.hxx:192
bool GetIsModified() const
Definition: SMESH_Mesh.hxx:240
std::map< int, SMESH_Group * > _mapGroup
Definition: SMESH_Mesh.hxx:437
virtual void Unlock()
Definition: SMESH_Mesh.hxx:395
bool _isModified
modified since last total re-compute, issue 0020693
Definition: SMESH_Mesh.hxx:443
bool HasShapeToMesh() const
Return true if there is a geometry to be meshed, not PseudoShape()
Definition: SMESH_Mesh.hxx:100
const SMESHDS_Mesh * GetMeshDS() const
Definition: SMESH_Mesh.hxx:190
virtual bool ComputeSubMeshes(SMESH_Gen *gen, SMESH_Mesh &aMesh, const TopoDS_Shape &aShape, const ::MeshDimension aDim, TSetOfInt *aShapesId, TopTools_IndexedMapOfShape *allowedSubShapes, SMESH_subMesh::compute_event &computeEvent, const bool includeSelf, const bool complexShapeFirst, const bool aShapeOnly)
Definition: SMESH_Mesh.hxx:401
double _shapeDiagonal
diagonal size of bounding box of shape to mesh
Definition: SMESH_Mesh.hxx:445
SubMeshHolder * _subMeshHolder
Definition: SMESH_Mesh.hxx:439
std::vector< SMESH_subMesh * > _ancestorSubMeshes
Definition: SMESH_Mesh.hxx:449
TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors
Definition: SMESH_Mesh.hxx:447
SMESHDS_Mesh * _meshDS
Definition: SMESH_Mesh.hxx:435
std::ostream & Dump(std::ostream &save)
void UndefShapeToMesh()
Definition: SMESH_Mesh.hxx:102
boost::shared_ptr< SMDS_Iterator< SMESH_Group * > > GroupIteratorPtr
Definition: SMESH_Mesh.hxx:352
SMESH_Mesh(const SMESH_Mesh &)
Definition: SMESH_Mesh.hxx:461
bool _isShapeToMesh
Definition: SMESH_Mesh.hxx:433
SMESH_Gen * _gen
Definition: SMESH_Mesh.hxx:436
int GetId() const
Definition: SMESH_Mesh.hxx:182
int _groupId
Definition: SMESH_Mesh.hxx:431
int _nbSubShapes
Definition: SMESH_Mesh.hxx:432
const TAncestorMap & GetAncestorMap() const
Definition: SMESH_Mesh.hxx:258
size_t NbGroup() const
Definition: SMESH_Mesh.hxx:340
SMESHDS_Mesh * GetMeshDS()
Definition: SMESH_Mesh.hxx:188
SMESHDS_Document * _document
Definition: SMESH_Mesh.hxx:434
bool _isAutoColor
Definition: SMESH_Mesh.hxx:442
TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap
Return data map of descendant to ancestor shapes.
Definition: SMESH_Mesh.hxx:257
int _id
Definition: SMESH_Mesh.hxx:430
virtual void Lock()
Definition: SMESH_Mesh.hxx:394
virtual void wait()
Definition: SMESH_Mesh.hxx:397
TCallUp * _callUp
Definition: SMESH_Mesh.hxx:457
TListOfListOfInt _subMeshOrder
Definition: SMESH_Mesh.hxx:451
virtual bool IsParallel()
Definition: SMESH_Mesh.hxx:399
Definition: SMESH_subMesh.hxx:61
compute_event
Definition: SMESH_subMesh.hxx:116
SMESH::SMESH_Group_var AddGroup(SMESH::SMESH_Mesh_ptr theMesh, SMESH::ElementType theType, const QString &theGroupName)
Definition: SMESHGUI_GroupUtils.cxx:38
Definition: SMESH_Mesh.hxx:364
virtual TopoDS_Shape GetShapeByEntry(const std::string &entry)=0
virtual void Load()=0
virtual void RemoveGroup(const int theGroupID)=0
virtual void HypothesisModified(int hypID, bool updateIcons)=0
virtual ~TCallUp()
Definition: SMESH_Mesh.hxx:370
virtual bool IsLoaded()=0
Exception thrown by Export*() in case if a mesh is too large for export due to limitation of a format...
Definition: SMESH_Mesh.hxx:271
TooLargeForExport(const char *format)
Definition: SMESH_Mesh.hxx:272