1 // Copyright (C) 2007-2015 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 "SMESHDS_Command.hxx"
34 #include "SMESHDS_Mesh.hxx"
35 #include "SMESH_ComputeError.hxx"
36 #include "SMESH_Controls.hxx"
37 #include "SMESH_Hypothesis.hxx"
39 #include "Utils_SALOME_Exception.hxx"
41 #include <TopoDS_Shape.hxx>
42 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
49 #pragma warning(disable:4251) // Warning DLL Interface ...
50 #pragma warning(disable:4290) // Warning Exception ...
54 class SMESHDS_Document;
56 class TopTools_ListOfShape;
58 class SMESH_HypoFilter;
61 typedef std::list<int> TListOfInt;
62 typedef std::list<TListOfInt> TListOfListOfInt;
64 class SMESH_EXPORT SMESH_Mesh
67 SMESH_Mesh(int theLocalId,
70 bool theIsEmbeddedMode,
71 SMESHDS_Document* theDocument);
73 virtual ~SMESH_Mesh();
76 * \brief Set geometry to be meshed
78 void ShapeToMesh(const TopoDS_Shape & aShape);
80 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
82 TopoDS_Shape GetShapeToMesh() const;
84 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
86 bool HasShapeToMesh() const { return _isShapeToMesh; }
88 * \brief Return diagonal size of bounding box of shape to mesh.
90 double GetShapeDiagonalSize() const;
92 * \brief Return diagonal size of bounding box of a shape.
94 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
96 * \brief Return a solid which is returned by GetShapeToMesh() if
97 * a real geometry to be meshed was not set
99 static const TopoDS_Solid& PseudoShape();
102 * \brief Load mesh from study file
106 * \brief Remove all nodes and elements
110 * \brief Remove all nodes and elements of indicated shape
112 void ClearSubMesh(const int theShapeId);
115 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
117 int UNVToMesh(const char* theFileName);
119 int MEDToMesh(const char* theFileName, const char* theMeshName);
121 int STLToMesh(const char* theFileName);
123 int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
125 SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
126 bool theMakeRequiredGroups = true );
128 SMESH_Hypothesis::Hypothesis_Status
129 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0)
130 throw(SALOME_Exception);
132 SMESH_Hypothesis::Hypothesis_Status
133 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
134 throw(SALOME_Exception);
136 const std::list <const SMESHDS_Hypothesis * >&
137 GetHypothesisList(const TopoDS_Shape & aSubShape) const
138 throw(SALOME_Exception);
140 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
141 const SMESH_HypoFilter& aFilter,
142 const bool andAncestors,
143 TopoDS_Shape* assignedTo=0) const;
145 int GetHypotheses(const TopoDS_Shape & aSubShape,
146 const SMESH_HypoFilter& aFilter,
147 std::list< const SMESHDS_Hypothesis * >& aHypList,
148 const bool andAncestors,
149 std::list< TopoDS_Shape > * assignedTo=0) const;
151 const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh * aSubMesh,
152 const SMESH_HypoFilter& aFilter,
153 const bool andAncestors,
154 TopoDS_Shape* assignedTo=0) const;
156 int GetHypotheses(const SMESH_subMesh * aSubMesh,
157 const SMESH_HypoFilter& aFilter,
158 std::list< const SMESHDS_Hypothesis * >& aHypList,
159 const bool andAncestors,
160 std::list< TopoDS_Shape > * assignedTo=0) const;
162 SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
164 const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
166 void ClearLog() throw(SALOME_Exception);
168 int GetId() const { return _id; }
170 bool MeshExists( int meshId ) const;
172 SMESH_Mesh* FindMesh( int meshId ) const;
174 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
176 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
178 SMESH_Gen *GetGen() { return _gen; }
180 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
181 throw(SALOME_Exception);
183 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
184 throw(SALOME_Exception);
186 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
187 throw(SALOME_Exception);
189 * \brief Return submeshes of groups containing the given subshape
191 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
192 throw(SALOME_Exception);
194 * \brief Say all submeshes that theChangedHyp has been modified
196 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
198 // const std::list < SMESH_subMesh * >&
199 // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
201 * \brief Return True if anHyp is used to mesh aSubShape
203 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
204 const SMESH_subMesh * aSubMesh);
206 * \brief check if a hypothesis alowing notconform mesh is present
208 bool IsNotConformAllowed() const;
210 bool IsMainShape(const TopoDS_Shape& theShape) const;
212 * \brief Return list of ancestors of theSubShape in the order
213 * that lower dimention shapes come first
215 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
217 void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
219 bool GetAutoColor() throw(SALOME_Exception);
222 * \brief Set the flag meaning that the mesh has been edited "manually".
223 * It is to set to false after Clear() and to set to true by MeshEditor
225 void SetIsModified(bool isModified);
227 bool GetIsModified() const { return _isModified; }
230 * \brief Return true if the mesh has been edited since a total re-compute
231 * and those modifications may prevent successful partial re-compute.
232 * As a side effect reset _isModified flag if mesh is empty
234 bool HasModificationsToDiscard() const;
237 * \brief Return data map of descendant to ancestor shapes
239 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
240 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
242 * \brief Check group names for duplications.
243 * Consider maximum group name length stored in MED file
245 bool HasDuplicatedGroupNamesMED();
247 void ExportMED(const char * theFile,
248 const char* theMeshName = NULL,
249 bool theAutoGroups = true,
251 const SMESHDS_Mesh* theMeshPart = 0,
252 bool theAutoDimension = false,
253 bool theAddODOnVertices = false)
254 throw(SALOME_Exception);
256 void ExportDAT(const char * file,
257 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
258 void ExportUNV(const char * file,
259 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
260 void ExportSTL(const char * file,
262 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
263 void ExportCGNS(const char * file,
264 const SMESHDS_Mesh* mesh,
265 const char * meshName = 0);
266 void ExportGMF(const char * file,
267 const SMESHDS_Mesh* mesh,
268 bool withRequiredGroups = true );
269 void ExportSAUV(const char *file,
270 const char* theMeshName = NULL,
271 bool theAutoGroups = true) throw(SALOME_Exception);
273 double GetComputeProgress() const;
275 int NbNodes() const throw(SALOME_Exception);
276 int Nb0DElements() const throw(SALOME_Exception);
277 int NbBalls() const throw(SALOME_Exception);
279 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
281 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
282 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
283 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
284 int NbBiQuadQuadrangles() const throw(SALOME_Exception);
285 int NbBiQuadTriangles() const throw(SALOME_Exception);
286 int NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
288 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
289 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
290 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
291 int NbTriQuadraticHexas() const throw(SALOME_Exception);
292 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
293 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
294 int NbHexagonalPrisms() const throw(SALOME_Exception);
295 int NbPolyhedrons() const throw(SALOME_Exception);
297 int NbSubMesh() const throw(SALOME_Exception);
299 int NbGroup() const { return _mapGroup.size(); }
301 int NbMeshes() const; // nb meshes in the Study
303 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
306 const TopoDS_Shape& theShape=TopoDS_Shape(),
307 const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
309 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
311 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
312 GroupIteratorPtr GetGroups() const;
314 std::list<int> GetGroupIds() const;
316 SMESH_Group* GetGroup (const int theGroupID);
318 bool RemoveGroup (const int theGroupID);
320 SMESH_Group* ConvertToStandalone ( int theGroupID );
322 struct TCallUp // callback from SMESH to SMESH_I level
324 virtual void RemoveGroup (const int theGroupID)=0;
325 virtual void HypothesisModified ()=0;
326 virtual void Load ()=0;
327 virtual ~TCallUp() {}
329 void SetCallUp( TCallUp * upCaller );
331 bool SynchronizeGroups();
334 SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
336 void ClearMeshOrder();
337 void SetMeshOrder(const TListOfListOfInt& theOrder );
338 const TListOfListOfInt& GetMeshOrder() const;
340 // sort submeshes according to stored mesh order
341 bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
343 // return true if given order of sub-meshes is OK
344 bool IsOrderOK( const SMESH_subMesh* smBefore,
345 const SMESH_subMesh* smAfter ) const;
347 std::ostream& Dump(ostream & save);
351 void fillAncestorsMap(const TopoDS_Shape& theShape);
352 void getAncestorsSubMeshes(const TopoDS_Shape& theSubShape,
353 std::vector< SMESH_subMesh* >& theSubMeshes) const;
356 int _id; // id given by creator (unique within the creator instance)
358 int _groupId; // id generator for group objects
359 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
360 bool _isShapeToMesh;// set to true when a shape is given (only once)
361 SMESHDS_Document * _myDocument;
362 SMESHDS_Mesh * _myMeshDS;
364 std::map <int, SMESH_Group*> _mapGroup;
367 SubMeshHolder* _subMeshHolder;
370 bool _isModified; //!< modified since last total re-compute, issue 0020693
372 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
374 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
376 mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
378 TListOfListOfInt _mySubMeshOrder;
380 // Struct calling methods at CORBA API implementation level, used to
381 // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
382 // when group removal is invoked by hyp modification (issue 0020918)
383 // 2) to forget not loaded mesh data at hyp modification
388 SMESH_Mesh(const SMESH_Mesh&) {};