1 // Copyright (C) 2007-2010 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 // SMESH SMESH : implementaion of SMESH idl descriptions
24 // File : SMESH_Mesh.hxx
25 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_MESH_HXX_
29 #define _SMESH_MESH_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMESH_Hypothesis.hxx"
35 #include "SMESHDS_Mesh.hxx"
36 #include "SMESHDS_Command.hxx"
37 #include "SMDSAbs_ElementType.hxx"
39 #include "Utils_SALOME_Exception.hxx"
41 #include <TopoDS_Shape.hxx>
42 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
48 #pragma warning(disable:4251) // Warning DLL Interface ...
49 #pragma warning(disable:4290) // Warning Exception ...
53 class SMESHDS_Document;
55 class TopTools_ListOfShape;
57 class SMESH_HypoFilter;
60 typedef std::list<int> TListOfInt;
61 typedef std::list<TListOfInt> TListOfListOfInt;
63 class SMESH_EXPORT SMESH_Mesh
66 SMESH_Mesh(int theLocalId,
69 bool theIsEmbeddedMode,
70 SMESHDS_Document* theDocument);
72 virtual ~SMESH_Mesh();
75 * \brief Set geometry to be meshed
77 void ShapeToMesh(const TopoDS_Shape & aShape);
79 * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
81 TopoDS_Shape GetShapeToMesh() const;
83 * \brief Return true if there is a geometry to be meshed, not PseudoShape()
85 bool HasShapeToMesh() const { return _isShapeToMesh; }
87 * \brief Return diagonal size of bounding box of shape to mesh.
89 double GetShapeDiagonalSize() const;
91 * \brief Return diagonal size of bounding box of a shape.
93 static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
95 * \brief Return a solid which is returned by GetShapeToMesh() if
96 * a real geometry to be meshed was not set
98 static const TopoDS_Solid& PseudoShape();
101 * \brief Remove all nodes and elements
106 * \brief Remove all nodes and elements of indicated shape
108 void ClearSubMesh(const int theShapeId);
110 int UNVToMesh(const char* theFileName);
112 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
114 int MEDToMesh(const char* theFileName, const char* theMeshName);
116 int STLToMesh(const char* theFileName);
118 SMESH_Hypothesis::Hypothesis_Status
119 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
120 throw(SALOME_Exception);
122 SMESH_Hypothesis::Hypothesis_Status
123 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
124 throw(SALOME_Exception);
126 const std::list <const SMESHDS_Hypothesis * >&
127 GetHypothesisList(const TopoDS_Shape & aSubShape) const
128 throw(SALOME_Exception);
130 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
131 const SMESH_HypoFilter& aFilter,
132 const bool andAncestors,
133 TopoDS_Shape* assignedTo=0) const;
135 int GetHypotheses(const TopoDS_Shape & aSubShape,
136 const SMESH_HypoFilter& aFilter,
137 std::list <const SMESHDS_Hypothesis * >& aHypList,
138 const bool andAncestors) const;
140 const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
142 void ClearLog() throw(SALOME_Exception);
144 int GetId() const { return _id; }
146 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
148 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
150 SMESH_Gen *GetGen() { return _gen; }
152 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
153 throw(SALOME_Exception);
155 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
156 throw(SALOME_Exception);
158 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
159 throw(SALOME_Exception);
161 * \brief Return submeshes of groups containing the given subshape
163 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
164 throw(SALOME_Exception);
166 * \brief Say all submeshes that theChangedHyp has been modified
168 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
170 const std::list < SMESH_subMesh * >&
171 GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
173 * \brief Return True if anHyp is used to mesh aSubShape
175 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
176 const SMESH_subMesh * aSubMesh);
178 * \brief check if a hypothesis alowing notconform mesh is present
180 bool IsNotConformAllowed() const;
182 bool IsMainShape(const TopoDS_Shape& theShape) const;
184 * \brief Return list of ancestors of theSubShape in the order
185 * that lower dimention shapes come first
187 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
189 void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
191 bool GetAutoColor() throw(SALOME_Exception);
194 * \brief Set the flag meaning that the mesh has been edited "manually".
195 * It is to set to false after Clear() and to set to true by MeshEditor
197 void SetIsModified(bool isModified);
199 bool GetIsModified() const { return _isModified; }
202 * \brief Return true if the mesh has been edited since a total re-compute
203 * and those modifications may prevent successful partial re-compute.
204 * As a side effect reset _isModified flag if mesh is empty
206 bool HasModificationsToDiscard() const;
209 * \brief Return data map of descendant to ancestor shapes
211 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
212 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
214 * \brief Check group names for duplications.
215 * Consider maximum group name length stored in MED file
217 bool HasDuplicatedGroupNamesMED();
219 void ExportMED(const char *file,
220 const char* theMeshName = NULL,
221 bool theAutoGroups = true,
223 throw(SALOME_Exception);
225 void ExportDAT(const char *file) throw(SALOME_Exception);
226 void ExportUNV(const char *file) throw(SALOME_Exception);
227 void ExportSTL(const char *file, const bool isascii) throw(SALOME_Exception);
229 int NbNodes() const throw(SALOME_Exception);
231 int Nb0DElements() const throw(SALOME_Exception);
233 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
235 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
237 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
239 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
241 int NbPolygons() const throw(SALOME_Exception);
243 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
245 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
247 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
249 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
251 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
253 int NbPolyhedrons() const throw(SALOME_Exception);
255 int NbSubMesh() const throw(SALOME_Exception);
257 int NbGroup() const { return _mapGroup.size(); }
259 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
262 const TopoDS_Shape& theShape=TopoDS_Shape());
264 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
265 GroupIteratorPtr GetGroups() const;
267 std::list<int> GetGroupIds() const;
269 SMESH_Group* GetGroup (const int theGroupID);
271 bool RemoveGroup (const int theGroupID);
273 SMESH_Group* ConvertToStandalone ( int theGroupID );
275 struct TRmGroupCallUp
277 virtual void RemoveGroup (const int theGroupID)=0;
278 virtual ~TRmGroupCallUp() {}
280 void SetRemoveGroupCallUp( TRmGroupCallUp * upCaller );
283 SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
285 void ClearMeshOrder();
286 void SetMeshOrder(const TListOfListOfInt& theOrder );
287 const TListOfListOfInt& GetMeshOrder() const;
290 * \brief sort submeshes according to stored mesh order
291 * \param theListToSort in out list to be sorted
292 * \return FALSE if nothing sorted
294 bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
298 ostream& Dump(ostream & save);
302 void fillAncestorsMap(const TopoDS_Shape& theShape);
303 std::list<SMESH_subMesh*> getAncestorsSubMeshes
304 (const TopoDS_Shape& theSubShape) const;
307 int _id; // id given by creator (unique within the creator instance)
309 int _idDoc; // id given by SMESHDS_Document
310 int _groupId; // id generator for group objects
311 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
312 bool _isShapeToMesh;// set to true when a shape is given (only once)
313 std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
314 SMESHDS_Document * _myDocument;
315 SMESHDS_Mesh * _myMeshDS;
317 std::map <int, SMESH_subMesh*> _mapSubMesh;
318 std::map <int, SMESH_Group*> _mapGroup;
321 bool _isModified; //!< modified since last total re-compute, issue 0020693
323 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
325 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
327 TListOfListOfInt _mySubMeshOrder;
329 // Struct calling RemoveGroup at CORBA API implementation level, used
330 // to make an upper level be consistent with a lower one when group removal
331 // is invoked by hyp modification
332 TRmGroupCallUp* _rmGroupCallUp;
336 SMESH_Mesh(const SMESH_Mesh&) {};