1 // Copyright (C) 2007-2023 CEA, EDF, 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"
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"
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"
53 #include <boost/filesystem.hpp>
54 #include <boost/asio/thread_pool.hpp>
56 #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::set<int> TSetOfInt;
77 typedef std::list<int> TListOfInt;
78 typedef std::list<TListOfInt> TListOfListOfInt;
80 class SMESH_EXPORT SMESH_Mesh
83 SMESH_Mesh(int theLocalId,
85 bool theIsEmbeddedMode,
86 SMESHDS_Document* theDocument);
88 virtual ~SMESH_Mesh();
91 * \brief Set geometry to be meshed
93 void ShapeToMesh(const TopoDS_Shape & aShape);
95 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
97 TopoDS_Shape GetShapeToMesh() const;
99 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
101 bool HasShapeToMesh() const { return _isShapeToMesh; }
103 void UndefShapeToMesh() { _isShapeToMesh = false; }
106 * \brief Return diagonal size of bounding box of shape to mesh.
108 double GetShapeDiagonalSize() const;
110 * \brief Return diagonal size of bounding box of a shape.
112 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
114 * \brief Return a solid which is returned by GetShapeToMesh() if
115 * a real geometry to be meshed was not set
117 static const TopoDS_Solid& PseudoShape();
120 * \brief Load mesh from study file
124 * \brief Remove all nodes and elements
128 * \brief Remove all nodes and elements of indicated shape
130 void ClearSubMesh(const int theShapeId);
133 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
135 int UNVToMesh(const char* theFileName);
137 int MEDToMesh(const char* theFileName, const char* theMeshName);
139 std::string STLToMesh(const char* theFileName);
141 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
143 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
144 bool theMakeRequiredGroups = true );
146 SMESH_Hypothesis::Hypothesis_Status
147 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
149 SMESH_Hypothesis::Hypothesis_Status
150 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
152 const std::list <const SMESHDS_Hypothesis * >&
153 GetHypothesisList(const TopoDS_Shape & aSubShape) const;
155 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
156 const SMESH_HypoFilter& aFilter,
157 const bool andAncestors,
158 TopoDS_Shape* assignedTo=0) const;
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;
166 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
167 const SMESH_HypoFilter& aFilter,
168 const bool andAncestors,
169 TopoDS_Shape* assignedTo=0) const;
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;
177 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
179 const std::list<SMESHDS_Command*> & GetLog();
183 int GetId() const { return _id; }
185 bool MeshExists( int meshId ) const;
187 SMESH_Mesh* FindMesh( int meshId ) const;
189 SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
191 const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
193 SMESH_Gen *GetGen() { return _gen; }
195 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
197 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
199 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
201 * \brief Return submeshes of groups containing the given subshape
203 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
205 * \brief Say all submeshes that theChangedHyp has been modified
207 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
209 // const std::list < SMESH_subMesh * >&
210 // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
212 * \brief Return True if anHyp is used to mesh aSubShape
214 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
215 const SMESH_subMesh * aSubMesh);
217 * \brief check if a hypothesis allowing notconform mesh is present
219 bool IsNotConformAllowed() const;
221 bool IsMainShape(const TopoDS_Shape& theShape) const;
223 TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
226 * \brief Return list of ancestors of theSubShape in the order
227 * that lower dimension shapes come first
229 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
231 void SetAutoColor(bool theAutoColor);
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
239 void SetIsModified(bool isModified);
241 bool GetIsModified() const { return _isModified; }
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
248 bool HasModificationsToDiscard() const;
251 * \brief Return true if all sub-meshes are computed OK - to update an icon
256 * \brief Return data map of descendant to ancestor shapes
258 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
259 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
262 * \brief Check group names for duplications.
263 * Consider maximum group name length stored in MED file
265 bool HasDuplicatedGroupNamesMED();
268 * \brief Exception thrown by Export*() in case if a mesh is too large for export
269 * due to limitation of a format
271 struct TooLargeForExport : public std::runtime_error
273 TooLargeForExport(const char* format):runtime_error(format) {}
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);
285 void ExportMED(const char * theFile,
286 const char* theMeshName = NULL,
287 bool theAutoGroups = true,
289 const SMESHDS_Mesh* theMeshPart = 0,
290 bool theAutoDimension = false,
291 bool theAddODOnVertices = false,
292 double theZTolerance = -1.,
293 bool theSaveNumbers = true);
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,
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 );
313 double GetComputeProgress() const;
315 smIdType NbNodes() const;
316 smIdType Nb0DElements() const;
317 smIdType NbBalls() const;
319 smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
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;
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;
339 smIdType NbSubMesh() const;
341 size_t NbGroup() const { return _mapGroup.size(); }
343 int NbMeshes() const; // nb meshes in the Study
345 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
347 const int theId = -1,
348 const TopoDS_Shape& theShape = TopoDS_Shape(),
349 const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
351 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
353 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
354 GroupIteratorPtr GetGroups() const;
356 std::list<int> GetGroupIds() const;
358 SMESH_Group* GetGroup (const int theGroupID) const;
360 bool RemoveGroup (const int theGroupID);
362 SMESH_Group* ConvertToStandalone ( int theGroupID );
364 struct TCallUp // callback from SMESH to SMESH_I level
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() {}
373 void SetCallUp( TCallUp * upCaller );
375 bool SynchronizeGroups();
378 SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
380 void ClearMeshOrder();
381 void SetMeshOrder(const TListOfListOfInt& theOrder );
382 const TListOfListOfInt& GetMeshOrder() const;
384 // sort submeshes according to stored mesh order
385 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
387 // return true if given order of sub-meshes is OK
388 bool IsOrderOK( const SMESH_subMesh* smBefore,
389 const SMESH_subMesh* smAfter ) const;
391 std::ostream& Dump(std::ostream & save);
393 // Parallel computation functions
395 virtual void Lock(){};
396 virtual void Unlock(){};
398 virtual int GetNbThreads(){return 0;};
399 virtual void SetNbThreads(long nbThreads){(void) nbThreads;};
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;};
405 virtual bool IsParallel(){std::cout << "Should not pass here: IsParallel" << std::endl;return false;};
408 virtual boost::filesystem::path GetTmpFolder() {return "";};
409 virtual boost::asio::thread_pool* GetPool() {return NULL;};
412 virtual bool ComputeSubMeshes(
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;};
426 void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
427 const char* theMeshName,
429 const SMESHDS_Mesh* meshPart,
430 bool theAutoDimension,
431 bool theAddODOnVertices,
432 double theZTolerance,
433 bool theSaveNumbers);
436 void fillAncestorsMap(const TopoDS_Shape& theShape);
437 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
438 std::vector< SMESH_subMesh* >& theSubMeshes) const;
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;
448 std::map <int, SMESH_Group*> _mapGroup;
451 SubMeshHolder* _subMeshHolder;
454 bool _isModified; //!< modified since last total re-compute, issue 0020693
456 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
458 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
460 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
462 TListOfListOfInt _subMeshOrder;
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
470 // Mutex for multhitreading write in SMESH_Mesh
472 boost::mutex _my_lock;
478 SMESH_Mesh(const SMESH_Mesh&) {};