1 // Copyright (C) 2007-2020 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>
50 #pragma warning(disable:4251) // Warning DLL Interface ...
51 #pragma warning(disable:4290) // Warning Exception ...
54 class SMESHDS_Command;
55 class SMESHDS_Document;
56 class SMESHDS_GroupBase;
57 class SMESHDS_Hypothesis;
61 class SMESH_HypoFilter;
65 typedef std::list<int> TListOfInt;
66 typedef std::list<TListOfInt> TListOfListOfInt;
68 class SMESH_EXPORT SMESH_Mesh
71 SMESH_Mesh(int theLocalId,
73 bool theIsEmbeddedMode,
74 SMESHDS_Document* theDocument);
76 virtual ~SMESH_Mesh();
79 * \brief Set geometry to be meshed
81 void ShapeToMesh(const TopoDS_Shape & aShape);
83 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
85 TopoDS_Shape GetShapeToMesh() const;
87 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
89 bool HasShapeToMesh() const { return _isShapeToMesh; }
91 void UndefShapeToMesh() { _isShapeToMesh = false; }
94 * \brief Return diagonal size of bounding box of shape to mesh.
96 double GetShapeDiagonalSize() const;
98 * \brief Return diagonal size of bounding box of a shape.
100 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
102 * \brief Return a solid which is returned by GetShapeToMesh() if
103 * a real geometry to be meshed was not set
105 static const TopoDS_Solid& PseudoShape();
108 * \brief Load mesh from study file
112 * \brief Remove all nodes and elements
116 * \brief Remove all nodes and elements of indicated shape
118 void ClearSubMesh(const int theShapeId);
121 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
123 int UNVToMesh(const char* theFileName);
125 int MEDToMesh(const char* theFileName, const char* theMeshName);
127 std::string STLToMesh(const char* theFileName);
129 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
131 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
132 bool theMakeRequiredGroups = true );
134 SMESH_Hypothesis::Hypothesis_Status
135 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0)
136 throw(SALOME_Exception);
138 SMESH_Hypothesis::Hypothesis_Status
139 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
140 throw(SALOME_Exception);
142 const std::list <const SMESHDS_Hypothesis * >&
143 GetHypothesisList(const TopoDS_Shape & aSubShape) const
144 throw(SALOME_Exception);
146 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
147 const SMESH_HypoFilter& aFilter,
148 const bool andAncestors,
149 TopoDS_Shape* assignedTo=0) const;
151 int GetHypotheses(const TopoDS_Shape & aSubShape,
152 const SMESH_HypoFilter& aFilter,
153 std::list< const SMESHDS_Hypothesis * >& aHypList,
154 const bool andAncestors,
155 std::list< TopoDS_Shape > * assignedTo=0) const;
157 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
158 const SMESH_HypoFilter& aFilter,
159 const bool andAncestors,
160 TopoDS_Shape* assignedTo=0) const;
162 int GetHypotheses(const SMESH_subMesh * aSubMesh,
163 const SMESH_HypoFilter& aFilter,
164 std::list< const SMESHDS_Hypothesis * >& aHypList,
165 const bool andAncestors,
166 std::list< TopoDS_Shape > * assignedTo=0) const;
168 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
170 const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
172 void ClearLog() throw(SALOME_Exception);
174 int GetId() const { return _id; }
176 bool MeshExists( int meshId ) const;
178 SMESH_Mesh* FindMesh( int meshId ) const;
180 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
182 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
184 SMESH_Gen *GetGen() { return _gen; }
186 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
187 throw(SALOME_Exception);
189 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
190 throw(SALOME_Exception);
192 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
193 throw(SALOME_Exception);
195 * \brief Return submeshes of groups containing the given subshape
197 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
198 throw(SALOME_Exception);
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) throw(SALOME_Exception);
228 bool GetAutoColor() throw(SALOME_Exception);
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; }
256 * \brief Check group names for duplications.
257 * Consider maximum group name length stored in MED file
259 bool HasDuplicatedGroupNamesMED();
261 void ExportMED(const char * theFile,
262 const char* theMeshName = NULL,
263 bool theAutoGroups = true,
265 const SMESHDS_Mesh* theMeshPart = 0,
266 bool theAutoDimension = false,
267 bool theAddODOnVertices = false,
268 double theZTolerance = -1.,
269 bool theAllElemsToGroup = false)
270 throw(SALOME_Exception);
272 void ExportDAT(const char * file,
273 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
274 void ExportUNV(const char * file,
275 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
276 void ExportSTL(const char * file,
278 const char * name = 0,
279 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
280 void ExportCGNS(const char * file,
281 const SMESHDS_Mesh* mesh,
282 const char * meshName = 0,
283 const bool groupElemsByType = false);
284 void ExportGMF(const char * file,
285 const SMESHDS_Mesh* mesh,
286 bool withRequiredGroups = true );
287 void ExportSAUV(const char *file,
288 const char* theMeshName = NULL,
289 bool theAutoGroups = true) throw(SALOME_Exception);
291 double GetComputeProgress() const;
293 int NbNodes() const throw(SALOME_Exception);
294 int Nb0DElements() const throw(SALOME_Exception);
295 int NbBalls() const throw(SALOME_Exception);
297 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
299 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
300 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
301 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
302 int NbBiQuadQuadrangles() const throw(SALOME_Exception);
303 int NbBiQuadTriangles() const throw(SALOME_Exception);
304 int NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
306 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
307 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
308 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
309 int NbTriQuadraticHexas() const throw(SALOME_Exception);
310 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
311 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
312 int NbQuadPrisms() const throw(SALOME_Exception);
313 int NbBiQuadPrisms() const throw(SALOME_Exception);
314 int NbHexagonalPrisms() const throw(SALOME_Exception);
315 int NbPolyhedrons() const throw(SALOME_Exception);
317 int NbSubMesh() const throw(SALOME_Exception);
319 int NbGroup() const { return _mapGroup.size(); }
321 int NbMeshes() const; // nb meshes in the Study
323 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
325 const int theId = -1,
326 const TopoDS_Shape& theShape = TopoDS_Shape(),
327 const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
329 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
331 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
332 GroupIteratorPtr GetGroups() const;
334 std::list<int> GetGroupIds() const;
336 SMESH_Group* GetGroup (const int theGroupID) const;
338 bool RemoveGroup (const int theGroupID);
340 SMESH_Group* ConvertToStandalone ( int theGroupID );
342 struct TCallUp // callback from SMESH to SMESH_I level
344 virtual void RemoveGroup( const int theGroupID )=0;
345 virtual void HypothesisModified( int hypID, bool updateIcons )=0;
346 virtual void Load()=0;
347 virtual bool IsLoaded()=0;
348 virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
349 virtual ~TCallUp() {}
351 void SetCallUp( TCallUp * upCaller );
353 bool SynchronizeGroups();
356 SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
358 void ClearMeshOrder();
359 void SetMeshOrder(const TListOfListOfInt& theOrder );
360 const TListOfListOfInt& GetMeshOrder() const;
362 // sort submeshes according to stored mesh order
363 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
365 // return true if given order of sub-meshes is OK
366 bool IsOrderOK( const SMESH_subMesh* smBefore,
367 const SMESH_subMesh* smAfter ) const;
369 std::ostream& Dump(std::ostream & save);
373 void fillAncestorsMap(const TopoDS_Shape& theShape);
374 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
375 std::vector< SMESH_subMesh* >& theSubMeshes) const;
378 int _id; // id given by creator (unique within the creator instance)
379 int _groupId; // id generator for group objects
380 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
381 bool _isShapeToMesh;// set to true when a shape is given (only once)
382 SMESHDS_Document * _myDocument;
383 SMESHDS_Mesh * _myMeshDS;
385 std::map <int, SMESH_Group*> _mapGroup;
388 SubMeshHolder* _subMeshHolder;
391 bool _isModified; //!< modified since last total re-compute, issue 0020693
393 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
395 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
397 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
399 TListOfListOfInt _mySubMeshOrder;
401 // Struct calling methods at CORBA API implementation level, used to
402 // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
403 // when group removal is invoked by hyp modification (issue 0020918)
404 // 2) to forget not loaded mesh data at hyp modification
409 SMESH_Mesh(const SMESH_Mesh&) {};