1 // Copyright (C) 2007-2022 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, or (at your option) any later version.
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
23 // File : SMESH_Mesh.hxx
24 // Author : Paul RASCLE, EDF
27 #ifndef _SMESH_MESH_HXX_
28 #define _SMESH_MESH_HXX_
30 #include "SMESH_SMESH.hxx"
33 #include "SMDSAbs_ElementType.hxx"
34 #include "SMESH_ComputeError.hxx"
35 #include "SMESH_Controls.hxx"
36 #include "SMESH_Hypothesis.hxx"
37 #include "SMDS_Iterator.hxx"
39 #include "Utils_SALOME_Exception.hxx"
41 #include <TopoDS_Shape.hxx>
42 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
43 #include <TopTools_ListOfShape.hxx>
45 #include "MEDCouplingMemArray.hxx"
52 #include <boost/filesystem.hpp>
53 #ifndef DISABLE_PARASMESH
54 #include <boost/asio/thread_pool.hpp>
55 #include <boost/thread.hpp>
59 #pragma warning(disable:4251) // Warning DLL Interface ...
60 #pragma warning(disable:4290) // Warning Exception ...
63 class SMESHDS_Command;
64 class SMESHDS_Document;
65 class SMESHDS_GroupBase;
66 class SMESHDS_Hypothesis;
70 class SMESH_HypoFilter;
74 class DriverMED_W_SMESHDS_Mesh;
76 typedef std::list<int> TListOfInt;
77 typedef std::list<TListOfInt> TListOfListOfInt;
79 class SMESH_EXPORT SMESH_Mesh
82 SMESH_Mesh(int theLocalId,
84 bool theIsEmbeddedMode,
85 SMESHDS_Document* theDocument);
87 virtual ~SMESH_Mesh();
90 * \brief Set geometry to be meshed
92 void ShapeToMesh(const TopoDS_Shape & aShape);
94 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
96 TopoDS_Shape GetShapeToMesh() const;
98 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
100 bool HasShapeToMesh() const { return _isShapeToMesh; }
102 void UndefShapeToMesh() { _isShapeToMesh = false; }
105 * \brief Return diagonal size of bounding box of shape to mesh.
107 double GetShapeDiagonalSize() const;
109 * \brief Return diagonal size of bounding box of a shape.
111 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
113 * \brief Return a solid which is returned by GetShapeToMesh() if
114 * a real geometry to be meshed was not set
116 static const TopoDS_Solid& PseudoShape();
119 * \brief Load mesh from study file
123 * \brief Remove all nodes and elements
127 * \brief Remove all nodes and elements of indicated shape
129 void ClearSubMesh(const int theShapeId);
132 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
134 int UNVToMesh(const char* theFileName);
136 int MEDToMesh(const char* theFileName, const char* theMeshName);
138 std::string STLToMesh(const char* theFileName);
140 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
142 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
143 bool theMakeRequiredGroups = true );
145 SMESH_Hypothesis::Hypothesis_Status
146 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
148 SMESH_Hypothesis::Hypothesis_Status
149 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
151 const std::list <const SMESHDS_Hypothesis * >&
152 GetHypothesisList(const TopoDS_Shape & aSubShape) const;
154 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
155 const SMESH_HypoFilter& aFilter,
156 const bool andAncestors,
157 TopoDS_Shape* assignedTo=0) const;
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;
165 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
166 const SMESH_HypoFilter& aFilter,
167 const bool andAncestors,
168 TopoDS_Shape* assignedTo=0) const;
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;
176 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
178 const std::list<SMESHDS_Command*> & GetLog();
182 int GetId() const { return _id; }
184 bool MeshExists( int meshId ) const;
186 SMESH_Mesh* FindMesh( int meshId ) const;
188 SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
190 const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
192 SMESH_Gen *GetGen() { return _gen; }
194 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
196 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
198 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
200 * \brief Return submeshes of groups containing the given subshape
202 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
204 * \brief Say all submeshes that theChangedHyp has been modified
206 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
208 // const std::list < SMESH_subMesh * >&
209 // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
211 * \brief Return True if anHyp is used to mesh aSubShape
213 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
214 const SMESH_subMesh * aSubMesh);
216 * \brief check if a hypothesis allowing notconform mesh is present
218 bool IsNotConformAllowed() const;
220 bool IsMainShape(const TopoDS_Shape& theShape) const;
222 TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
225 * \brief Return list of ancestors of theSubShape in the order
226 * that lower dimension shapes come first
228 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
230 void SetAutoColor(bool theAutoColor);
235 * \brief Set the flag meaning that the mesh has been edited "manually".
236 * It is to set to false after Clear() and to set to true by MeshEditor
238 void SetIsModified(bool isModified);
240 bool GetIsModified() const { return _isModified; }
243 * \brief Return true if the mesh has been edited since a total re-compute
244 * and those modifications may prevent successful partial re-compute.
245 * As a side effect reset _isModified flag if mesh is empty
247 bool HasModificationsToDiscard() const;
250 * \brief Return true if all sub-meshes are computed OK - to update an icon
255 * \brief Return data map of descendant to ancestor shapes
257 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
258 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
261 * \brief Check group names for duplications.
262 * Consider maximum group name length stored in MED file
264 bool HasDuplicatedGroupNamesMED();
267 * \brief Exception thrown by Export*() in case if a mesh is too large for export
268 * due to limitation of a format
270 struct TooLargeForExport : public std::runtime_error
272 TooLargeForExport(const char* format):runtime_error(format) {}
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);
284 void ExportMED(const char * theFile,
285 const char* theMeshName = NULL,
286 bool theAutoGroups = true,
288 const SMESHDS_Mesh* theMeshPart = 0,
289 bool theAutoDimension = false,
290 bool theAddODOnVertices = false,
291 double theZTolerance = -1.,
292 bool theSaveNumbers = true);
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,
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 );
312 double GetComputeProgress() const;
314 smIdType NbNodes() const;
315 smIdType Nb0DElements() const;
316 smIdType NbBalls() const;
318 smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
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;
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;
338 smIdType NbSubMesh() const;
340 size_t NbGroup() const { return _mapGroup.size(); }
342 int NbMeshes() const; // nb meshes in the Study
344 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
346 const int theId = -1,
347 const TopoDS_Shape& theShape = TopoDS_Shape(),
348 const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
350 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
352 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
353 GroupIteratorPtr GetGroups() const;
355 std::list<int> GetGroupIds() const;
357 SMESH_Group* GetGroup (const int theGroupID) const;
359 bool RemoveGroup (const int theGroupID);
361 SMESH_Group* ConvertToStandalone ( int theGroupID );
363 struct TCallUp // callback from SMESH to SMESH_I level
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() {}
372 void SetCallUp( TCallUp * upCaller );
374 bool SynchronizeGroups();
377 SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
379 void ClearMeshOrder();
380 void SetMeshOrder(const TListOfListOfInt& theOrder );
381 const TListOfListOfInt& GetMeshOrder() const;
383 // sort submeshes according to stored mesh order
384 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
386 // return true if given order of sub-meshes is OK
387 bool IsOrderOK( const SMESH_subMesh* smBefore,
388 const SMESH_subMesh* smAfter ) const;
390 std::ostream& Dump(std::ostream & save);
392 // Parallel computation functions
394 #ifdef DISABLE_PARASMESH
398 int GetNbThreads(){return _NbThreads;};
399 void SetNbThreads(int nbThreads){std::cout << "Warning Parallel Meshing is disabled on Windows it will behave as a slower normal compute" << std::endl;_NbThreads=nbThreads;};
401 void InitPoolThreads(){};
402 void DeletePoolThreads(){};
405 bool IsParallel(){return _NbThreads > 0;}
407 void Lock() {_my_lock.lock();};
408 void Unlock() {_my_lock.unlock();};
410 int GetNbThreads(){return _NbThreads;};
411 void SetNbThreads(int nbThreads){_NbThreads=nbThreads;};
413 void InitPoolThreads(){_pool = new boost::asio::thread_pool(_NbThreads);};
414 void DeletePoolThreads(){delete _pool;};
416 void wait(){_pool->join(); DeletePoolThreads(); InitPoolThreads(); }
418 bool IsParallel(){return _NbThreads > 0;}
421 // Temporary folder used during parallel Computation
422 boost::filesystem::path tmp_folder;
423 #ifndef DISABLE_PARASMESH
424 boost::asio::thread_pool * _pool = nullptr; //thread pool for computation
430 void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
431 const char* theMeshName,
433 const SMESHDS_Mesh* meshPart,
434 bool theAutoDimension,
435 bool theAddODOnVertices,
436 double theZTolerance,
437 bool theSaveNumbers);
440 void fillAncestorsMap(const TopoDS_Shape& theShape);
441 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
442 std::vector< SMESH_subMesh* >& theSubMeshes) const;
445 int _id; // id given by creator (unique within the creator instance)
446 int _groupId; // id generator for group objects
447 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
448 bool _isShapeToMesh;// set to true when a shape is given (only once)
449 SMESHDS_Document * _document;
450 SMESHDS_Mesh * _meshDS;
452 std::map <int, SMESH_Group*> _mapGroup;
455 SubMeshHolder* _subMeshHolder;
458 bool _isModified; //!< modified since last total re-compute, issue 0020693
460 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
462 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
464 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
466 TListOfListOfInt _subMeshOrder;
468 // Struct calling methods at CORBA API implementation level, used to
469 // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
470 // when group removal is invoked by hyp modification (issue 0020918)
471 // 2) to forget not loaded mesh data at hyp modification
474 // Mutex for multhitreading write in SMESH_Mesh
475 #ifndef DISABLE_PARASMESH
476 boost::mutex _my_lock;
482 SMESH_Mesh(const SMESH_Mesh&) {};