]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESH/SMESH_Mesh.hxx
Salome HOME
Revert "Adding Multinode method for smesh parallelism + cleanup and doc"
[modules/smesh.git] / src / SMESH / SMESH_Mesh.hxx
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 #include <boost/asio/thread_pool.hpp>
55 #endif
56 #include <boost/thread.hpp>
57
58 #ifdef WIN32
59 #pragma warning(disable:4251) // Warning DLL Interface ...
60 #pragma warning(disable:4290) // Warning Exception ...
61 #endif
62
63 class SMESHDS_Command;
64 class SMESHDS_Document;
65 class SMESHDS_GroupBase;
66 class SMESHDS_Hypothesis;
67 class SMESHDS_Mesh;
68 class SMESH_Gen;
69 class SMESH_Group;
70 class SMESH_HypoFilter;
71 class SMESH_subMesh;
72 class TopoDS_Solid;
73
74 class DriverMED_W_SMESHDS_Mesh;
75
76 typedef std::set<int> TSetOfInt;
77 typedef std::list<int> TListOfInt;
78 typedef std::list<TListOfInt> TListOfListOfInt;
79
80 class SMESH_EXPORT SMESH_Mesh
81 {
82  public:
83   SMESH_Mesh(int               theLocalId,
84              SMESH_Gen*        theGen,
85              bool              theIsEmbeddedMode,
86              SMESHDS_Document* theDocument);
87
88   virtual ~SMESH_Mesh();
89
90   /*!
91    * \brief Set geometry to be meshed
92    */
93   void ShapeToMesh(const TopoDS_Shape & aShape);
94   /*!
95    * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
96    */
97   TopoDS_Shape GetShapeToMesh() const;
98   /*!
99    * \brief Return true if there is a geometry to be meshed, not PseudoShape()
100    */
101   bool HasShapeToMesh() const { return _isShapeToMesh; }
102
103   void UndefShapeToMesh() { _isShapeToMesh = false; }
104
105   /*!
106    * \brief Return diagonal size of bounding box of shape to mesh.
107    */
108   double GetShapeDiagonalSize() const;
109   /*!
110    * \brief Return diagonal size of bounding box of a shape.
111    */
112   static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
113   /*!
114    * \brief Return a solid which is returned by GetShapeToMesh() if
115    *        a real geometry to be meshed was not set
116    */
117   static const TopoDS_Solid& PseudoShape();
118
119   /*!
120    * \brief Load mesh from study file
121    */
122   void Load();
123   /*!
124    * \brief Remove all nodes and elements
125    */
126   void Clear();
127   /*!
128    * \brief Remove all nodes and elements of indicated shape
129    */
130   void ClearSubMesh(const int theShapeId);
131
132   /*!
133    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
134    */
135   int UNVToMesh(const char* theFileName);
136
137   int MEDToMesh(const char* theFileName, const char* theMeshName);
138
139   std::string STLToMesh(const char* theFileName);
140
141   int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
142
143   SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
144                                   bool        theMakeRequiredGroups = true );
145
146   SMESH_Hypothesis::Hypothesis_Status
147   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
148
149   SMESH_Hypothesis::Hypothesis_Status
150   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
151
152   const std::list <const SMESHDS_Hypothesis * >&
153   GetHypothesisList(const TopoDS_Shape & aSubShape) const;
154
155   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
156                                          const SMESH_HypoFilter& aFilter,
157                                          const bool              andAncestors,
158                                          TopoDS_Shape*           assignedTo=0) const;
159
160   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
161                     const SMESH_HypoFilter&                  aFilter,
162                     std::list< const SMESHDS_Hypothesis * >& aHypList,
163                     const bool                               andAncestors,
164                     std::list< TopoDS_Shape > *              assignedTo=0) const;
165
166   const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh *   aSubMesh,
167                                          const SMESH_HypoFilter& aFilter,
168                                          const bool              andAncestors,
169                                          TopoDS_Shape*           assignedTo=0) const;
170
171   int GetHypotheses(const SMESH_subMesh *                    aSubMesh,
172                     const SMESH_HypoFilter&                  aFilter,
173                     std::list< const SMESHDS_Hypothesis * >& aHypList,
174                     const bool                               andAncestors,
175                     std::list< TopoDS_Shape > *              assignedTo=0) const;
176
177   SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
178
179   const std::list<SMESHDS_Command*> & GetLog();
180
181   void ClearLog();
182
183   int GetId() const          { return _id; }
184
185   bool MeshExists( int meshId ) const;
186
187   SMESH_Mesh* FindMesh( int meshId ) const;
188
189   SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
190
191   const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
192
193   SMESH_Gen *GetGen()        { return _gen; }
194
195   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
196
197   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
198
199   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
200   /*!
201    * \brief Return submeshes of groups containing the given subshape
202    */
203   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
204   /*!
205    * \brief Say all submeshes that theChangedHyp has been modified
206    */
207   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
208
209   // const std::list < SMESH_subMesh * >&
210   // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
211   /*!
212    * \brief Return True if anHyp is used to mesh aSubShape
213    */
214   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
215                         const SMESH_subMesh * aSubMesh);
216   /*!
217    * \brief check if a hypothesis allowing notconform mesh is present
218    */
219   bool IsNotConformAllowed() const;
220
221   bool IsMainShape(const TopoDS_Shape& theShape) const;
222
223   TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
224
225   /*!
226    * \brief Return list of ancestors of theSubShape in the order
227    *        that lower dimension shapes come first
228    */
229   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
230
231   void SetAutoColor(bool theAutoColor);
232
233   bool GetAutoColor();
234
235   /*!
236    * \brief Set the flag meaning that the mesh has been edited "manually".
237    * It is to set to false after Clear() and to set to true by MeshEditor
238    */
239   void SetIsModified(bool isModified);
240
241   bool GetIsModified() const { return _isModified; }
242
243   /*!
244    * \brief Return true if the mesh has been edited since a total re-compute
245    *        and those modifications may prevent successful partial re-compute.
246    *        As a side effect reset _isModified flag if mesh is empty
247    */
248   bool HasModificationsToDiscard() const;
249
250   /*!
251    * \brief Return true if all sub-meshes are computed OK - to update an icon
252    */
253   bool IsComputedOK();
254
255   /*!
256    * \brief Return data map of descendant to ancestor shapes
257    */
258   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
259   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
260
261   /*!
262    * \brief Check group names for duplications.
263    *  Consider maximum group name length stored in MED file
264    */
265   bool HasDuplicatedGroupNamesMED();
266
267   /*!
268    * \brief Exception thrown by Export*() in case if a mesh is too large for export
269    *        due to limitation of a format
270    */
271   struct TooLargeForExport : public std::runtime_error
272   {
273     TooLargeForExport(const char* format):runtime_error(format) {}
274   };
275
276   MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
277     ExportMEDCoupling(const char*         theMeshName = NULL,
278                       bool                theAutoGroups = true,
279                       const SMESHDS_Mesh* theMeshPart = 0,
280                       bool                theAutoDimension = false,
281                       bool                theAddODOnVertices = false,
282                       double              theZTolerance = -1.,
283                       bool                theSaveNumbers = true);
284
285   void ExportMED(const char *        theFile,
286                  const char*         theMeshName = NULL,
287                  bool                theAutoGroups = true,
288                  int                 theVersion = -1,
289                  const SMESHDS_Mesh* theMeshPart = 0,
290                  bool                theAutoDimension = false,
291                  bool                theAddODOnVertices = false,
292                  double              theZTolerance = -1.,
293                  bool                theSaveNumbers = true);
294
295   void ExportDAT(const char *        file,
296                  const SMESHDS_Mesh* meshPart = 0,
297                  const bool          renumber = true);
298   void ExportUNV(const char *        file,
299                  const SMESHDS_Mesh* meshPart = 0,
300                  const bool          renumber = true);
301   void ExportSTL(const char *        file,
302                  const bool          isascii,
303                  const char *        name = 0,
304                  const SMESHDS_Mesh* meshPart = 0);
305   void ExportCGNS(const char *        file,
306                   const SMESHDS_Mesh* mesh,
307                   const char *        meshName = 0,
308                   const bool          groupElemsByType = false);
309   void ExportGMF(const char *        file,
310                  const SMESHDS_Mesh* mesh,
311                  bool                withRequiredGroups = true );
312
313   double GetComputeProgress() const;
314
315   smIdType NbNodes() const;
316   smIdType Nb0DElements() const;
317   smIdType NbBalls() const;
318
319   smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
320
321   smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
322   smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
323   smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
324   smIdType NbBiQuadQuadrangles() const;
325   smIdType NbBiQuadTriangles() const;
326   smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
327
328   smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
329   smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
330   smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
331   smIdType NbTriQuadraticHexas() const;
332   smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
333   smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
334   smIdType NbQuadPrisms() const;
335   smIdType NbBiQuadPrisms() const;
336   smIdType NbHexagonalPrisms() const;
337   smIdType NbPolyhedrons() const;
338
339   smIdType NbSubMesh() const;
340
341   size_t NbGroup() const { return _mapGroup.size(); }
342
343   int NbMeshes() const; // nb meshes in the Study
344
345   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
346                          const char*               theName,
347                          const int                 theId = -1,
348                          const TopoDS_Shape&       theShape = TopoDS_Shape(),
349                          const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
350
351   SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
352
353   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
354   GroupIteratorPtr GetGroups() const;
355
356   std::list<int> GetGroupIds() const;
357
358   SMESH_Group* GetGroup (const int theGroupID) const;
359
360   bool RemoveGroup (const int theGroupID);
361
362   SMESH_Group* ConvertToStandalone ( int theGroupID );
363
364   struct TCallUp // callback from SMESH to SMESH_I level
365   {
366     virtual void RemoveGroup( const int theGroupID )=0;
367     virtual void HypothesisModified( int hypID, bool updateIcons )=0;
368     virtual void Load()=0;
369     virtual bool IsLoaded()=0;
370     virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
371     virtual ~TCallUp() {}
372   };
373   void SetCallUp( TCallUp * upCaller );
374
375   bool SynchronizeGroups();
376
377
378   SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
379
380   void ClearMeshOrder();
381   void SetMeshOrder(const TListOfListOfInt& theOrder );
382   const TListOfListOfInt& GetMeshOrder() const;
383
384   // sort submeshes according to stored mesh order
385   bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
386
387   // return true if given order of sub-meshes is OK
388   bool IsOrderOK( const SMESH_subMesh* smBefore,
389                   const SMESH_subMesh* smAfter ) const;
390
391   std::ostream& Dump(std::ostream & save);
392
393   // Parallel computation functions
394
395   virtual void Lock(){};
396   virtual void Unlock(){};
397
398   virtual int GetNbThreads(){return 0;};
399   virtual void SetNbThreads(long nbThreads){(void) nbThreads;};
400
401   virtual void InitPoolThreads(){std::cout << "Should not pass here: InitPoolThread" << std::endl;};
402   virtual void DeletePoolThreads(){std::cout << "Should not pass here: DeletePoolThread" << std::endl;};
403   virtual void wait(){std::cout << "Should not pass here: wait" << std::endl;};
404
405   virtual bool IsParallel(){std::cout << "Should not pass here: IsParallel" << std::endl;return false;};
406
407 #ifndef WIN32
408   virtual boost::filesystem::path GetTmpFolder() {return "";};
409   virtual boost::asio::thread_pool* GetPool() {return NULL;};
410 #endif
411
412   virtual bool ComputeSubMeshes(
413             SMESH_Gen* gen,
414             SMESH_Mesh & aMesh,
415             const TopoDS_Shape & aShape,
416             const ::MeshDimension       aDim,
417             TSetOfInt*                  aShapesId /*=0*/,
418             TopTools_IndexedMapOfShape* allowedSubShapes,
419             SMESH_subMesh::compute_event &computeEvent,
420             const bool includeSelf,
421             const bool complexShapeFirst,
422             const bool aShapeOnly){(void) gen;(void) aMesh;(void) aShape;(void) aDim;(void) aShapesId;(void) allowedSubShapes;(void) computeEvent;(void) includeSelf;(void) complexShapeFirst;(void) aShapeOnly;std::cout << "Should not pass here: computesubmesh" << std::endl;return false;};
423
424 private:
425
426   void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
427                         const char*               theMeshName,
428                         bool                      theAutoGroups,
429                         const SMESHDS_Mesh*       meshPart,
430                         bool                      theAutoDimension,
431                         bool                      theAddODOnVertices,
432                         double                    theZTolerance,
433                         bool                      theSaveNumbers);
434
435  private:
436   void fillAncestorsMap(const TopoDS_Shape& theShape);
437   void getAncestorsSubMeshes(const TopoDS_Shape&            theSubShape,
438                              std::vector< SMESH_subMesh* >& theSubMeshes) const;
439
440 protected:
441   int                        _id;           // id given by creator (unique within the creator instance)
442   int                        _groupId;      // id generator for group objects
443   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
444   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
445   SMESHDS_Document *         _document;
446   SMESHDS_Mesh *             _meshDS;
447   SMESH_Gen *                _gen;
448   std::map <int, SMESH_Group*> _mapGroup;
449
450   class SubMeshHolder;
451   SubMeshHolder*             _subMeshHolder;
452
453   bool                       _isAutoColor;
454   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
455
456   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
457
458   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
459
460   mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
461
462   TListOfListOfInt           _subMeshOrder;
463
464   // Struct calling methods at CORBA API implementation level, used to
465   // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
466   // when group removal is invoked by hyp modification (issue 0020918)
467   // 2) to forget not loaded mesh data at hyp modification
468   TCallUp*                    _callUp;
469
470   // Mutex for multhitreading write in SMESH_Mesh
471 #ifndef WIN32
472   boost::mutex _my_lock;
473 #endif
474   int _NbThreads=-1;
475
476 protected:
477   SMESH_Mesh();
478   SMESH_Mesh(const SMESH_Mesh&) {};
479 };
480 #endif