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"
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"
38 #include "Utils_SALOME_Exception.hxx"
40 #include <TopoDS_Shape.hxx>
41 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
42 #include <TopTools_ListOfShape.hxx>
44 #include "MEDCouplingMemArray.hxx"
52 #include <boost/filesystem.hpp>
55 #pragma warning(disable:4251) // Warning DLL Interface ...
56 #pragma warning(disable:4290) // Warning Exception ...
59 class SMESHDS_Command;
60 class SMESHDS_Document;
61 class SMESHDS_GroupBase;
62 class SMESHDS_Hypothesis;
66 class SMESH_HypoFilter;
70 class DriverMED_W_SMESHDS_Mesh;
72 typedef std::list<int> TListOfInt;
73 typedef std::list<TListOfInt> TListOfListOfInt;
75 class SMESH_EXPORT SMESH_Mesh
78 SMESH_Mesh(int theLocalId,
80 bool theIsEmbeddedMode,
81 SMESHDS_Document* theDocument);
83 virtual ~SMESH_Mesh();
86 * \brief Set geometry to be meshed
88 void ShapeToMesh(const TopoDS_Shape & aShape);
90 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
92 TopoDS_Shape GetShapeToMesh() const;
94 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
96 bool HasShapeToMesh() const { return _isShapeToMesh; }
98 void UndefShapeToMesh() { _isShapeToMesh = false; }
101 * \brief Return diagonal size of bounding box of shape to mesh.
103 double GetShapeDiagonalSize() const;
105 * \brief Return diagonal size of bounding box of a shape.
107 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
109 * \brief Return a solid which is returned by GetShapeToMesh() if
110 * a real geometry to be meshed was not set
112 static const TopoDS_Solid& PseudoShape();
115 * \brief Load mesh from study file
119 * \brief Remove all nodes and elements
123 * \brief Remove all nodes and elements of indicated shape
125 void ClearSubMesh(const int theShapeId);
128 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
130 int UNVToMesh(const char* theFileName);
132 int MEDToMesh(const char* theFileName, const char* theMeshName);
134 std::string STLToMesh(const char* theFileName);
136 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
138 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
139 bool theMakeRequiredGroups = true );
141 SMESH_Hypothesis::Hypothesis_Status
142 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
144 SMESH_Hypothesis::Hypothesis_Status
145 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
147 const std::list <const SMESHDS_Hypothesis * >&
148 GetHypothesisList(const TopoDS_Shape & aSubShape) const;
150 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
151 const SMESH_HypoFilter& aFilter,
152 const bool andAncestors,
153 TopoDS_Shape* assignedTo=0) const;
155 int GetHypotheses(const TopoDS_Shape & aSubShape,
156 const SMESH_HypoFilter& aFilter,
157 std::list< const SMESHDS_Hypothesis * >& aHypList,
158 const bool andAncestors,
159 std::list< TopoDS_Shape > * assignedTo=0) const;
161 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
162 const SMESH_HypoFilter& aFilter,
163 const bool andAncestors,
164 TopoDS_Shape* assignedTo=0) const;
166 int GetHypotheses(const SMESH_subMesh * aSubMesh,
167 const SMESH_HypoFilter& aFilter,
168 std::list< const SMESHDS_Hypothesis * >& aHypList,
169 const bool andAncestors,
170 std::list< TopoDS_Shape > * assignedTo=0) const;
172 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
174 const std::list<SMESHDS_Command*> & GetLog();
178 int GetId() const { return _id; }
180 bool MeshExists( int meshId ) const;
182 SMESH_Mesh* FindMesh( int meshId ) const;
184 SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
186 const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
188 SMESH_Gen *GetGen() { return _gen; }
190 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
192 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
194 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
196 * \brief Return submeshes of groups containing the given subshape
198 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
200 * \brief Say all submeshes that theChangedHyp has been modified
202 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
204 // const std::list < SMESH_subMesh * >&
205 // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
207 * \brief Return True if anHyp is used to mesh aSubShape
209 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
210 const SMESH_subMesh * aSubMesh);
212 * \brief check if a hypothesis allowing notconform mesh is present
214 bool IsNotConformAllowed() const;
216 bool IsMainShape(const TopoDS_Shape& theShape) const;
218 TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
221 * \brief Return list of ancestors of theSubShape in the order
222 * that lower dimension shapes come first
224 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
226 void SetAutoColor(bool theAutoColor);
231 * \brief Set the flag meaning that the mesh has been edited "manually".
232 * It is to set to false after Clear() and to set to true by MeshEditor
234 void SetIsModified(bool isModified);
236 bool GetIsModified() const { return _isModified; }
239 * \brief Return true if the mesh has been edited since a total re-compute
240 * and those modifications may prevent successful partial re-compute.
241 * As a side effect reset _isModified flag if mesh is empty
243 bool HasModificationsToDiscard() const;
246 * \brief Return true if all sub-meshes are computed OK - to update an icon
251 * \brief Return data map of descendant to ancestor shapes
253 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
254 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
257 * \brief Check group names for duplications.
258 * Consider maximum group name length stored in MED file
260 bool HasDuplicatedGroupNamesMED();
263 * \brief Exception thrown by Export*() in case if a mesh is too large for export
264 * due to limitation of a format
266 struct TooLargeForExport : public std::runtime_error
268 TooLargeForExport(const char* format):runtime_error(format) {}
271 MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
272 ExportMEDCoupling(const char* theMeshName = NULL,
273 bool theAutoGroups = true,
274 const SMESHDS_Mesh* theMeshPart = 0,
275 bool theAutoDimension = false,
276 bool theAddODOnVertices = false,
277 double theZTolerance = -1.,
278 bool theSaveNumbers = true);
280 void ExportMED(const char * theFile,
281 const char* theMeshName = NULL,
282 bool theAutoGroups = true,
284 const SMESHDS_Mesh* theMeshPart = 0,
285 bool theAutoDimension = false,
286 bool theAddODOnVertices = false,
287 double theZTolerance = -1.,
288 bool theSaveNumbers = true);
290 void ExportDAT(const char * file,
291 const SMESHDS_Mesh* meshPart = 0,
292 const bool renumber = true);
293 void ExportUNV(const char * file,
294 const SMESHDS_Mesh* meshPart = 0,
295 const bool renumber = true);
296 void ExportSTL(const char * file,
298 const char * name = 0,
299 const SMESHDS_Mesh* meshPart = 0);
300 void ExportCGNS(const char * file,
301 const SMESHDS_Mesh* mesh,
302 const char * meshName = 0,
303 const bool groupElemsByType = false);
304 void ExportGMF(const char * file,
305 const SMESHDS_Mesh* mesh,
306 bool withRequiredGroups = true );
308 double GetComputeProgress() const;
310 smIdType NbNodes() const;
311 smIdType Nb0DElements() const;
312 smIdType NbBalls() const;
314 smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
316 smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
317 smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
318 smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
319 smIdType NbBiQuadQuadrangles() const;
320 smIdType NbBiQuadTriangles() const;
321 smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
323 smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
324 smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
325 smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
326 smIdType NbTriQuadraticHexas() const;
327 smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
328 smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
329 smIdType NbQuadPrisms() const;
330 smIdType NbBiQuadPrisms() const;
331 smIdType NbHexagonalPrisms() const;
332 smIdType NbPolyhedrons() const;
334 smIdType NbSubMesh() const;
336 size_t NbGroup() const { return _mapGroup.size(); }
338 int NbMeshes() const; // nb meshes in the Study
340 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
342 const int theId = -1,
343 const TopoDS_Shape& theShape = TopoDS_Shape(),
344 const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
346 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
348 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
349 GroupIteratorPtr GetGroups() const;
351 std::list<int> GetGroupIds() const;
353 SMESH_Group* GetGroup (const int theGroupID) const;
355 bool RemoveGroup (const int theGroupID);
357 SMESH_Group* ConvertToStandalone ( int theGroupID );
359 struct TCallUp // callback from SMESH to SMESH_I level
361 virtual void RemoveGroup( const int theGroupID )=0;
362 virtual void HypothesisModified( int hypID, bool updateIcons )=0;
363 virtual void Load()=0;
364 virtual bool IsLoaded()=0;
365 virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
366 virtual ~TCallUp() {}
368 void SetCallUp( TCallUp * upCaller );
370 bool SynchronizeGroups();
373 SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
375 void ClearMeshOrder();
376 void SetMeshOrder(const TListOfListOfInt& theOrder );
377 const TListOfListOfInt& GetMeshOrder() const;
379 // sort submeshes according to stored mesh order
380 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
382 // return true if given order of sub-meshes is OK
383 bool IsOrderOK( const SMESH_subMesh* smBefore,
384 const SMESH_subMesh* smAfter ) const;
386 std::ostream& Dump(std::ostream & save);
388 // Data for parallel computation
390 void Lock() {_my_lock.lock();};
391 void Unlock() {_my_lock.unlock();};
393 int GetNbThreads(){return _NbThreads;};
394 void SetNbThreads(int nbThreads){_NbThreads=nbThreads;};
396 // Temporary folder used during parallel Computation
397 boost::filesystem::path tmp_folder;
401 void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
402 const char* theMeshName,
404 const SMESHDS_Mesh* meshPart,
405 bool theAutoDimension,
406 bool theAddODOnVertices,
407 double theZTolerance,
408 bool theSaveNumbers);
411 void fillAncestorsMap(const TopoDS_Shape& theShape);
412 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
413 std::vector< SMESH_subMesh* >& theSubMeshes) const;
416 int _id; // id given by creator (unique within the creator instance)
417 int _groupId; // id generator for group objects
418 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
419 bool _isShapeToMesh;// set to true when a shape is given (only once)
420 SMESHDS_Document * _document;
421 SMESHDS_Mesh * _meshDS;
423 std::map <int, SMESH_Group*> _mapGroup;
426 SubMeshHolder* _subMeshHolder;
429 bool _isModified; //!< modified since last total re-compute, issue 0020693
431 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
433 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
435 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
437 TListOfListOfInt _subMeshOrder;
439 // Struct calling methods at CORBA API implementation level, used to
440 // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
441 // when group removal is invoked by hyp modification (issue 0020918)
442 // 2) to forget not loaded mesh data at hyp modification
445 // Mutex for multhitreading write in SMESH_Mesh
451 SMESH_Mesh(const SMESH_Mesh&) {};