1 // Copyright (C) 2007-2021 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 #pragma warning(disable:4251) // Warning DLL Interface ...
53 #pragma warning(disable:4290) // Warning Exception ...
56 class SMESHDS_Command;
57 class SMESHDS_Document;
58 class SMESHDS_GroupBase;
59 class SMESHDS_Hypothesis;
63 class SMESH_HypoFilter;
67 class DriverMED_W_SMESHDS_Mesh;
69 typedef std::list<int> TListOfInt;
70 typedef std::list<TListOfInt> TListOfListOfInt;
72 class SMESH_EXPORT SMESH_Mesh
75 SMESH_Mesh(int theLocalId,
77 bool theIsEmbeddedMode,
78 SMESHDS_Document* theDocument);
80 virtual ~SMESH_Mesh();
83 * \brief Set geometry to be meshed
85 void ShapeToMesh(const TopoDS_Shape & aShape);
87 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
89 TopoDS_Shape GetShapeToMesh() const;
91 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
93 bool HasShapeToMesh() const { return _isShapeToMesh; }
95 void UndefShapeToMesh() { _isShapeToMesh = false; }
98 * \brief Return diagonal size of bounding box of shape to mesh.
100 double GetShapeDiagonalSize() const;
102 * \brief Return diagonal size of bounding box of a shape.
104 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
106 * \brief Return a solid which is returned by GetShapeToMesh() if
107 * a real geometry to be meshed was not set
109 static const TopoDS_Solid& PseudoShape();
112 * \brief Load mesh from study file
116 * \brief Remove all nodes and elements
120 * \brief Remove all nodes and elements of indicated shape
122 void ClearSubMesh(const int theShapeId);
125 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
127 int UNVToMesh(const char* theFileName);
129 int MEDToMesh(const char* theFileName, const char* theMeshName);
131 std::string STLToMesh(const char* theFileName);
133 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
135 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
136 bool theMakeRequiredGroups = true );
138 SMESH_Hypothesis::Hypothesis_Status
139 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
141 SMESH_Hypothesis::Hypothesis_Status
142 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
144 const std::list <const SMESHDS_Hypothesis * >&
145 GetHypothesisList(const TopoDS_Shape & aSubShape) const;
147 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
148 const SMESH_HypoFilter& aFilter,
149 const bool andAncestors,
150 TopoDS_Shape* assignedTo=0) const;
152 int GetHypotheses(const TopoDS_Shape & aSubShape,
153 const SMESH_HypoFilter& aFilter,
154 std::list< const SMESHDS_Hypothesis * >& aHypList,
155 const bool andAncestors,
156 std::list< TopoDS_Shape > * assignedTo=0) const;
158 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
159 const SMESH_HypoFilter& aFilter,
160 const bool andAncestors,
161 TopoDS_Shape* assignedTo=0) const;
163 int GetHypotheses(const SMESH_subMesh * aSubMesh,
164 const SMESH_HypoFilter& aFilter,
165 std::list< const SMESHDS_Hypothesis * >& aHypList,
166 const bool andAncestors,
167 std::list< TopoDS_Shape > * assignedTo=0) const;
169 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
171 const std::list<SMESHDS_Command*> & GetLog();
175 int GetId() const { return _id; }
177 bool MeshExists( int meshId ) const;
179 SMESH_Mesh* FindMesh( int meshId ) const;
181 SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
183 const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
185 SMESH_Gen *GetGen() { return _gen; }
187 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
189 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
191 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
193 * \brief Return submeshes of groups containing the given subshape
195 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
197 * \brief Say all submeshes that theChangedHyp has been modified
199 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
201 // const std::list < SMESH_subMesh * >&
202 // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
204 * \brief Return True if anHyp is used to mesh aSubShape
206 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
207 const SMESH_subMesh * aSubMesh);
209 * \brief check if a hypothesis allowing notconform mesh is present
211 bool IsNotConformAllowed() const;
213 bool IsMainShape(const TopoDS_Shape& theShape) const;
215 TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
218 * \brief Return list of ancestors of theSubShape in the order
219 * that lower dimension shapes come first
221 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
223 void SetAutoColor(bool theAutoColor);
228 * \brief Set the flag meaning that the mesh has been edited "manually".
229 * It is to set to false after Clear() and to set to true by MeshEditor
231 void SetIsModified(bool isModified);
233 bool GetIsModified() const { return _isModified; }
236 * \brief Return true if the mesh has been edited since a total re-compute
237 * and those modifications may prevent successful partial re-compute.
238 * As a side effect reset _isModified flag if mesh is empty
240 bool HasModificationsToDiscard() const;
243 * \brief Return true if all sub-meshes are computed OK - to update an icon
248 * \brief Return data map of descendant to ancestor shapes
250 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
251 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
254 * \brief Check group names for duplications.
255 * Consider maximum group name length stored in MED file
257 bool HasDuplicatedGroupNamesMED();
260 * \brief Exception thrown by Export*() in case if a mesh is too large for export
261 * due to limitation of a format
263 struct TooLargeForExport : public std::runtime_error
265 TooLargeForExport(const char* format):runtime_error(format) {}
268 MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
269 ExportMEDCoupling(const char* theMeshName = NULL,
270 bool theAutoGroups = true,
271 const SMESHDS_Mesh* theMeshPart = 0,
272 bool theAutoDimension = false,
273 bool theAddODOnVertices = false,
274 double theZTolerance = -1.,
275 bool theSaveNumbers = true);
277 void ExportMED(const char * theFile,
278 const char* theMeshName = NULL,
279 bool theAutoGroups = true,
281 const SMESHDS_Mesh* theMeshPart = 0,
282 bool theAutoDimension = false,
283 bool theAddODOnVertices = false,
284 double theZTolerance = -1.,
285 bool theSaveNumbers = true);
287 void ExportDAT(const char * file,
288 const SMESHDS_Mesh* meshPart = 0,
289 const bool renumber = true);
290 void ExportUNV(const char * file,
291 const SMESHDS_Mesh* meshPart = 0,
292 const bool renumber = true);
293 void ExportSTL(const char * file,
295 const char * name = 0,
296 const SMESHDS_Mesh* meshPart = 0);
297 void ExportCGNS(const char * file,
298 const SMESHDS_Mesh* mesh,
299 const char * meshName = 0,
300 const bool groupElemsByType = false);
301 void ExportGMF(const char * file,
302 const SMESHDS_Mesh* mesh,
303 bool withRequiredGroups = true );
305 double GetComputeProgress() const;
307 smIdType NbNodes() const;
308 smIdType Nb0DElements() const;
309 smIdType NbBalls() const;
311 smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
313 smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
314 smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
315 smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
316 smIdType NbBiQuadQuadrangles() const;
317 smIdType NbBiQuadTriangles() const;
318 smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
320 smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
321 smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
322 smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
323 smIdType NbTriQuadraticHexas() const;
324 smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
325 smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
326 smIdType NbQuadPrisms() const;
327 smIdType NbBiQuadPrisms() const;
328 smIdType NbHexagonalPrisms() const;
329 smIdType NbPolyhedrons() const;
331 smIdType NbSubMesh() const;
333 size_t NbGroup() const { return _mapGroup.size(); }
335 int NbMeshes() const; // nb meshes in the Study
337 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
339 const int theId = -1,
340 const TopoDS_Shape& theShape = TopoDS_Shape(),
341 const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
343 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
345 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
346 GroupIteratorPtr GetGroups() const;
348 std::list<int> GetGroupIds() const;
350 SMESH_Group* GetGroup (const int theGroupID) const;
352 bool RemoveGroup (const int theGroupID);
354 SMESH_Group* ConvertToStandalone ( int theGroupID );
356 struct TCallUp // callback from SMESH to SMESH_I level
358 virtual void RemoveGroup( const int theGroupID )=0;
359 virtual void HypothesisModified( int hypID, bool updateIcons )=0;
360 virtual void Load()=0;
361 virtual bool IsLoaded()=0;
362 virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
363 virtual ~TCallUp() {}
365 void SetCallUp( TCallUp * upCaller );
367 bool SynchronizeGroups();
370 SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
372 void ClearMeshOrder();
373 void SetMeshOrder(const TListOfListOfInt& theOrder );
374 const TListOfListOfInt& GetMeshOrder() const;
376 // sort submeshes according to stored mesh order
377 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
379 // return true if given order of sub-meshes is OK
380 bool IsOrderOK( const SMESH_subMesh* smBefore,
381 const SMESH_subMesh* smAfter ) const;
383 std::ostream& Dump(std::ostream & save);
387 void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
388 const char* theMeshName,
390 const SMESHDS_Mesh* meshPart,
391 bool theAutoDimension,
392 bool theAddODOnVertices,
393 double theZTolerance,
394 bool theSaveNumbers);
397 void fillAncestorsMap(const TopoDS_Shape& theShape);
398 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
399 std::vector< SMESH_subMesh* >& theSubMeshes) const;
402 int _id; // id given by creator (unique within the creator instance)
403 int _groupId; // id generator for group objects
404 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
405 bool _isShapeToMesh;// set to true when a shape is given (only once)
406 SMESHDS_Document * _document;
407 SMESHDS_Mesh * _meshDS;
409 std::map <int, SMESH_Group*> _mapGroup;
412 SubMeshHolder* _subMeshHolder;
415 bool _isModified; //!< modified since last total re-compute, issue 0020693
417 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
419 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
421 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
423 TListOfListOfInt _subMeshOrder;
425 // Struct calling methods at CORBA API implementation level, used to
426 // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
427 // when group removal is invoked by hyp modification (issue 0020918)
428 // 2) to forget not loaded mesh data at hyp modification
433 SMESH_Mesh(const SMESH_Mesh&) {};