1 // Copyright (C) 2007-2011 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"
34 #include "SMESH_Controls.hxx"
36 #include "SMESHDS_Mesh.hxx"
37 #include "SMESHDS_Command.hxx"
38 #include "SMDSAbs_ElementType.hxx"
40 #include "Utils_SALOME_Exception.hxx"
42 #include <TopoDS_Shape.hxx>
43 #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_Hypothesis::Hypothesis_Status
126 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
127 throw(SALOME_Exception);
129 SMESH_Hypothesis::Hypothesis_Status
130 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
131 throw(SALOME_Exception);
133 const std::list <const SMESHDS_Hypothesis * >&
134 GetHypothesisList(const TopoDS_Shape & aSubShape) const
135 throw(SALOME_Exception);
137 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
138 const SMESH_HypoFilter& aFilter,
139 const bool andAncestors,
140 TopoDS_Shape* assignedTo=0) const;
142 int GetHypotheses(const TopoDS_Shape & aSubShape,
143 const SMESH_HypoFilter& aFilter,
144 std::list <const SMESHDS_Hypothesis * >& aHypList,
145 const bool andAncestors) const;
147 const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
149 void ClearLog() throw(SALOME_Exception);
151 int GetId() const { return _id; }
153 bool MeshExists( int meshId ) const;
155 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
157 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
159 SMESH_Gen *GetGen() { return _gen; }
161 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
162 throw(SALOME_Exception);
164 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
165 throw(SALOME_Exception);
167 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
168 throw(SALOME_Exception);
170 * \brief Return submeshes of groups containing the given subshape
172 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
173 throw(SALOME_Exception);
175 * \brief Say all submeshes that theChangedHyp has been modified
177 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
179 const std::list < SMESH_subMesh * >&
180 GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
182 * \brief Return True if anHyp is used to mesh aSubShape
184 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
185 const SMESH_subMesh * aSubMesh);
187 * \brief check if a hypothesis alowing notconform mesh is present
189 bool IsNotConformAllowed() const;
191 bool IsMainShape(const TopoDS_Shape& theShape) const;
193 * \brief Return list of ancestors of theSubShape in the order
194 * that lower dimention shapes come first
196 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
198 void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
200 bool GetAutoColor() throw(SALOME_Exception);
203 * \brief Set the flag meaning that the mesh has been edited "manually".
204 * It is to set to false after Clear() and to set to true by MeshEditor
206 void SetIsModified(bool isModified);
208 bool GetIsModified() const { return _isModified; }
211 * \brief Return true if the mesh has been edited since a total re-compute
212 * and those modifications may prevent successful partial re-compute.
213 * As a side effect reset _isModified flag if mesh is empty
215 bool HasModificationsToDiscard() const;
218 * \brief Return data map of descendant to ancestor shapes
220 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
221 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
223 * \brief Check group names for duplications.
224 * Consider maximum group name length stored in MED file
226 bool HasDuplicatedGroupNamesMED();
228 void ExportMED(const char *file,
229 const char* theMeshName = NULL,
230 bool theAutoGroups = true,
232 const SMESHDS_Mesh* meshPart = 0)
233 throw(SALOME_Exception);
235 void ExportDAT(const char * file,
236 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
237 void ExportUNV(const char * file,
238 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
239 void ExportSTL(const char * file,
241 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
242 void ExportCGNS(const char * file,
243 const SMESHDS_Mesh* mesh);
244 void ExportSAUV(const char *file,
245 const char* theMeshName = NULL,
246 bool theAutoGroups = true) throw(SALOME_Exception);
248 int NbNodes() const throw(SALOME_Exception);
250 int Nb0DElements() const throw(SALOME_Exception);
252 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
254 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
256 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
258 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
260 int NbBiQuadQuadrangles() const throw(SALOME_Exception);
262 int NbPolygons() const throw(SALOME_Exception);
264 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
266 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
268 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
270 int NbTriQuadraticHexas() const throw(SALOME_Exception);
272 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
274 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
276 int NbHexagonalPrisms() const throw(SALOME_Exception);
278 int NbPolyhedrons() const throw(SALOME_Exception);
280 int NbSubMesh() const throw(SALOME_Exception);
282 int NbGroup() const { return _mapGroup.size(); }
284 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
287 const TopoDS_Shape& theShape=TopoDS_Shape(),
288 const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
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;
320 * \brief sort submeshes according to stored mesh order
321 * \param theListToSort in out list to be sorted
322 * \return FALSE if nothing sorted
324 bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
328 ostream& Dump(ostream & save);
332 void fillAncestorsMap(const TopoDS_Shape& theShape);
333 std::list<SMESH_subMesh*> getAncestorsSubMeshes
334 (const TopoDS_Shape& theSubShape) const;
337 int _id; // id given by creator (unique within the creator instance)
339 int _idDoc; // id given by SMESHDS_Document
340 int _groupId; // id generator for group objects
341 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
342 bool _isShapeToMesh;// set to true when a shape is given (only once)
343 std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
344 SMESHDS_Document * _myDocument;
345 SMESHDS_Mesh * _myMeshDS;
347 std::map <int, SMESH_subMesh*> _mapSubMesh;
348 std::map <int, SMESH_Group*> _mapGroup;
351 bool _isModified; //!< modified since last total re-compute, issue 0020693
353 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
355 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
357 TListOfListOfInt _mySubMeshOrder;
359 // Struct calling methods at CORBA API implementation level, used to
360 // 1) make an upper level be consistent with a lower one when group removal
361 // is invoked by hyp modification (issue 0020918)
362 // 2) to forget not loaded mesh data at hyp modification
367 SMESH_Mesh(const SMESH_Mesh&) {};