Version: 8.3.0
SMESH_Mesh.hxx
Go to the documentation of this file.
1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, 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 "SMDS_Iterator.hxx"
37 
38 #include "Utils_SALOME_Exception.hxx"
39 
40 #include <TopoDS_Shape.hxx>
41 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
42 #include <TopTools_ListOfShape.hxx>
43 
44 #include <map>
45 #include <list>
46 #include <vector>
47 
48 #ifdef WIN32
49 #pragma warning(disable:4251) // Warning DLL Interface ...
50 #pragma warning(disable:4290) // Warning Exception ...
51 #endif
52 
53 class SMESHDS_Command;
54 class SMESHDS_Document;
55 class SMESHDS_GroupBase;
56 class SMESHDS_Hypothesis;
57 class SMESHDS_Mesh;
58 class SMESH_Gen;
59 class SMESH_Group;
60 class SMESH_HypoFilter;
61 class SMESH_subMesh;
62 class TopoDS_Solid;
63 
64 typedef std::list<int> TListOfInt;
65 typedef std::list<TListOfInt> TListOfListOfInt;
66 
67 class SMESH_EXPORT SMESH_Mesh
68 {
69  public:
70  SMESH_Mesh(int theLocalId,
71  int theStudyId,
72  SMESH_Gen* theGen,
73  bool theIsEmbeddedMode,
74  SMESHDS_Document* theDocument);
75 
76  virtual ~SMESH_Mesh();
77 
81  void ShapeToMesh(const TopoDS_Shape & aShape);
85  TopoDS_Shape GetShapeToMesh() const;
89  bool HasShapeToMesh() const { return _isShapeToMesh; }
93  double GetShapeDiagonalSize() const;
97  static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
102  static const TopoDS_Solid& PseudoShape();
103 
107  void Load();
111  void Clear();
115  void ClearSubMesh(const int theShapeId);
116 
120  int UNVToMesh(const char* theFileName);
121 
122  int MEDToMesh(const char* theFileName, const char* theMeshName);
123 
124  std::string STLToMesh(const char* theFileName);
125 
126  int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
127 
128  SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
129  bool theMakeRequiredGroups = true );
130 
131  SMESH_Hypothesis::Hypothesis_Status
132  AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0)
133  throw(SALOME_Exception);
134 
135  SMESH_Hypothesis::Hypothesis_Status
136  RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
137  throw(SALOME_Exception);
138 
139  const std::list <const SMESHDS_Hypothesis * >&
140  GetHypothesisList(const TopoDS_Shape & aSubShape) const
141  throw(SALOME_Exception);
142 
143  const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
144  const SMESH_HypoFilter& aFilter,
145  const bool andAncestors,
146  TopoDS_Shape* assignedTo=0) const;
147 
148  int GetHypotheses(const TopoDS_Shape & aSubShape,
149  const SMESH_HypoFilter& aFilter,
150  std::list< const SMESHDS_Hypothesis * >& aHypList,
151  const bool andAncestors,
152  std::list< TopoDS_Shape > * assignedTo=0) const;
153 
154  const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
155  const SMESH_HypoFilter& aFilter,
156  const bool andAncestors,
157  TopoDS_Shape* assignedTo=0) const;
158 
159  int GetHypotheses(const SMESH_subMesh * aSubMesh,
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  SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
166 
167  const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
168 
169  void ClearLog() throw(SALOME_Exception);
170 
171  int GetId() const { return _id; }
172 
173  bool MeshExists( int meshId ) const;
174 
175  SMESH_Mesh* FindMesh( int meshId ) const;
176 
177  SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
178 
179  const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
180 
181  SMESH_Gen *GetGen() { return _gen; }
182 
183  SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
184  throw(SALOME_Exception);
185 
186  SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
187  throw(SALOME_Exception);
188 
189  SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
190  throw(SALOME_Exception);
194  std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
195  throw(SALOME_Exception);
199  void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
200 
201  // const std::list < SMESH_subMesh * >&
202  // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
206  bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
207  const SMESH_subMesh * aSubMesh);
211  bool IsNotConformAllowed() const;
212 
213  bool IsMainShape(const TopoDS_Shape& theShape) const;
218  const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
219 
220  void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
221 
222  bool GetAutoColor() throw(SALOME_Exception);
223 
228  void SetIsModified(bool isModified);
229 
230  bool GetIsModified() const { return _isModified; }
231 
237  bool HasModificationsToDiscard() const;
238 
242  typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
243  const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
248  bool HasDuplicatedGroupNamesMED();
249 
250  void ExportMED(const char * theFile,
251  const char* theMeshName = NULL,
252  bool theAutoGroups = true,
253  int theVersion = 0,
254  const SMESHDS_Mesh* theMeshPart = 0,
255  bool theAutoDimension = false,
256  bool theAddODOnVertices = false,
257  bool theAllElemsToGroup = false)
258  throw(SALOME_Exception);
259 
260  void ExportDAT(const char * file,
261  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
262  void ExportUNV(const char * file,
263  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
264  void ExportSTL(const char * file,
265  const bool isascii,
266  const char * name = 0,
267  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
268  void ExportCGNS(const char * file,
269  const SMESHDS_Mesh* mesh,
270  const char * meshName = 0);
271  void ExportGMF(const char * file,
272  const SMESHDS_Mesh* mesh,
273  bool withRequiredGroups = true );
274  void ExportSAUV(const char *file,
275  const char* theMeshName = NULL,
276  bool theAutoGroups = true) throw(SALOME_Exception);
277 
278  double GetComputeProgress() const;
279 
280  int NbNodes() const throw(SALOME_Exception);
281  int Nb0DElements() const throw(SALOME_Exception);
282  int NbBalls() const throw(SALOME_Exception);
283 
284  int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
285 
286  int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
287  int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
288  int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
289  int NbBiQuadQuadrangles() const throw(SALOME_Exception);
290  int NbBiQuadTriangles() const throw(SALOME_Exception);
291  int NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
292 
293  int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
294  int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
295  int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
296  int NbTriQuadraticHexas() const throw(SALOME_Exception);
297  int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
298  int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
299  int NbHexagonalPrisms() const throw(SALOME_Exception);
300  int NbPolyhedrons() const throw(SALOME_Exception);
301 
302  int NbSubMesh() const throw(SALOME_Exception);
303 
304  int NbGroup() const { return _mapGroup.size(); }
305 
306  int NbMeshes() const; // nb meshes in the Study
307 
308  SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
309  const char* theName,
310  int& theId,
311  const TopoDS_Shape& theShape=TopoDS_Shape(),
312  const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
313 
314  SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
315 
316  typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
317  GroupIteratorPtr GetGroups() const;
318 
319  std::list<int> GetGroupIds() const;
320 
321  SMESH_Group* GetGroup (const int theGroupID);
322 
323  bool RemoveGroup (const int theGroupID);
324 
325  SMESH_Group* ConvertToStandalone ( int theGroupID );
326 
327  struct TCallUp // callback from SMESH to SMESH_I level
328  {
329  virtual void RemoveGroup (const int theGroupID)=0;
330  virtual void HypothesisModified ()=0;
331  virtual void Load ()=0;
332  virtual ~TCallUp() {}
333  };
334  void SetCallUp( TCallUp * upCaller );
335 
336  bool SynchronizeGroups();
337 
338 
339  SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
340 
341  void ClearMeshOrder();
342  void SetMeshOrder(const TListOfListOfInt& theOrder );
343  const TListOfListOfInt& GetMeshOrder() const;
344 
345  // sort submeshes according to stored mesh order
346  bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
347 
348  // return true if given order of sub-meshes is OK
349  bool IsOrderOK( const SMESH_subMesh* smBefore,
350  const SMESH_subMesh* smAfter ) const;
351 
352  std::ostream& Dump(ostream & save);
353 
354 private:
355 
356  void fillAncestorsMap(const TopoDS_Shape& theShape);
357  void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
358  std::vector< SMESH_subMesh* >& theSubMeshes) const;
359 
360 protected:
361  int _id; // id given by creator (unique within the creator instance)
362  int _studyId;
363  int _groupId; // id generator for group objects
364  int _nbSubShapes; // initial nb of subshapes in the shape to mesh
365  bool _isShapeToMesh;// set to true when a shape is given (only once)
366  SMESHDS_Document * _myDocument;
367  SMESHDS_Mesh * _myMeshDS;
368  SMESH_Gen * _gen;
369  std::map <int, SMESH_Group*> _mapGroup;
370 
371  class SubMeshHolder;
372  SubMeshHolder* _subMeshHolder;
373 
374  bool _isAutoColor;
375  bool _isModified;
376 
377  double _shapeDiagonal;
378 
379  TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
380 
381  mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
382 
383  TListOfListOfInt _mySubMeshOrder;
384 
385  // Struct calling methods at CORBA API implementation level, used to
386  // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
387  // when group removal is invoked by hyp modification (issue 0020918)
388  // 2) to forget not loaded mesh data at hyp modification
389  TCallUp* _callUp;
390 
391 protected:
392  SMESH_Mesh();
393  SMESH_Mesh(const SMESH_Mesh&) {};
394 };
395 
396 #endif