1 // Copyright (C) 2007-2013 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.
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)
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 std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
153 void ClearLog() throw(SALOME_Exception);
155 int GetId() const { return _id; }
157 bool MeshExists( int meshId ) const;
159 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
161 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
163 SMESH_Gen *GetGen() { return _gen; }
165 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
166 throw(SALOME_Exception);
168 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
169 throw(SALOME_Exception);
171 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
172 throw(SALOME_Exception);
174 * \brief Return submeshes of groups containing the given subshape
176 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
177 throw(SALOME_Exception);
179 * \brief Say all submeshes that theChangedHyp has been modified
181 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
183 const std::list < SMESH_subMesh * >&
184 GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
186 * \brief Return True if anHyp is used to mesh aSubShape
188 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
189 const SMESH_subMesh * aSubMesh);
191 * \brief check if a hypothesis alowing notconform mesh is present
193 bool IsNotConformAllowed() const;
195 bool IsMainShape(const TopoDS_Shape& theShape) const;
197 * \brief Return list of ancestors of theSubShape in the order
198 * that lower dimention shapes come first
200 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
202 void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
204 bool GetAutoColor() throw(SALOME_Exception);
207 * \brief Set the flag meaning that the mesh has been edited "manually".
208 * It is to set to false after Clear() and to set to true by MeshEditor
210 void SetIsModified(bool isModified);
212 bool GetIsModified() const { return _isModified; }
215 * \brief Return true if the mesh has been edited since a total re-compute
216 * and those modifications may prevent successful partial re-compute.
217 * As a side effect reset _isModified flag if mesh is empty
219 bool HasModificationsToDiscard() const;
222 * \brief Return data map of descendant to ancestor shapes
224 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
225 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
227 * \brief Check group names for duplications.
228 * Consider maximum group name length stored in MED file
230 bool HasDuplicatedGroupNamesMED();
232 void ExportMED(const char * theFile,
233 const char* theMeshName = NULL,
234 bool theAutoGroups = true,
236 const SMESHDS_Mesh* theMeshPart = 0,
237 bool theAutoDimension = false)
238 throw(SALOME_Exception);
240 void ExportDAT(const char * file,
241 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
242 void ExportUNV(const char * file,
243 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
244 void ExportSTL(const char * file,
246 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
247 void ExportCGNS(const char * file,
248 const SMESHDS_Mesh* mesh);
249 void ExportGMF(const char * file,
250 const SMESHDS_Mesh* mesh,
251 bool withRequiredGroups = true );
252 void ExportSAUV(const char *file,
253 const char* theMeshName = NULL,
254 bool theAutoGroups = true) throw(SALOME_Exception);
256 int NbNodes() const throw(SALOME_Exception);
257 int Nb0DElements() const throw(SALOME_Exception);
258 int NbBalls() const throw(SALOME_Exception);
260 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
262 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
263 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
264 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
265 int NbBiQuadQuadrangles() const throw(SALOME_Exception);
266 int NbBiQuadTriangles() const throw(SALOME_Exception);
267 int NbPolygons() const throw(SALOME_Exception);
269 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
270 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
271 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
272 int NbTriQuadraticHexas() const throw(SALOME_Exception);
273 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
274 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
275 int NbHexagonalPrisms() const throw(SALOME_Exception);
276 int NbPolyhedrons() const throw(SALOME_Exception);
278 int NbSubMesh() const throw(SALOME_Exception);
280 int NbGroup() const { return _mapGroup.size(); }
282 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
285 const TopoDS_Shape& theShape=TopoDS_Shape(),
286 const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
288 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
290 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
291 GroupIteratorPtr GetGroups() const;
293 std::list<int> GetGroupIds() const;
295 SMESH_Group* GetGroup (const int theGroupID);
297 bool RemoveGroup (const int theGroupID);
299 SMESH_Group* ConvertToStandalone ( int theGroupID );
301 struct TCallUp // callback from SMESH to SMESH_I level
303 virtual void RemoveGroup (const int theGroupID)=0;
304 virtual void HypothesisModified ()=0;
305 virtual void Load ()=0;
306 virtual ~TCallUp() {}
308 void SetCallUp( TCallUp * upCaller );
310 bool SynchronizeGroups();
313 SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
315 void ClearMeshOrder();
316 void SetMeshOrder(const TListOfListOfInt& theOrder );
317 const TListOfListOfInt& GetMeshOrder() const;
319 // sort submeshes according to stored mesh order
320 bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
322 // return true if given order of sub-meshes is OK
323 bool IsOrderOK( const SMESH_subMesh* smBefore,
324 const SMESH_subMesh* smAfter ) const;
326 ostream& Dump(ostream & save);
330 void fillAncestorsMap(const TopoDS_Shape& theShape);
331 std::list<SMESH_subMesh*> getAncestorsSubMeshes
332 (const TopoDS_Shape& theSubShape) const;
335 int _id; // id given by creator (unique within the creator instance)
337 int _groupId; // id generator for group objects
338 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
339 bool _isShapeToMesh;// set to true when a shape is given (only once)
340 std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
341 SMESHDS_Document * _myDocument;
342 SMESHDS_Mesh * _myMeshDS;
344 std::map <int, SMESH_subMesh*> _mapSubMesh;
345 std::map <int, SMESH_Group*> _mapGroup;
348 bool _isModified; //!< modified since last total re-compute, issue 0020693
350 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
352 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
354 TListOfListOfInt _mySubMeshOrder;
356 // Struct calling methods at CORBA API implementation level, used to
357 // 1) make an upper level be consistent with a lower one when group removal
358 // is invoked by hyp modification (issue 0020918)
359 // 2) to forget not loaded mesh data at hyp modification
364 SMESH_Mesh(const SMESH_Mesh&) {};