1 // Copyright (C) 2007-2012 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);
127 SMESH_Hypothesis::Hypothesis_Status
128 AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
129 throw(SALOME_Exception);
131 SMESH_Hypothesis::Hypothesis_Status
132 RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
133 throw(SALOME_Exception);
135 const std::list <const SMESHDS_Hypothesis * >&
136 GetHypothesisList(const TopoDS_Shape & aSubShape) const
137 throw(SALOME_Exception);
139 const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape & aSubShape,
140 const SMESH_HypoFilter& aFilter,
141 const bool andAncestors,
142 TopoDS_Shape* assignedTo=0) const;
144 int GetHypotheses(const TopoDS_Shape & aSubShape,
145 const SMESH_HypoFilter& aFilter,
146 std::list <const SMESHDS_Hypothesis * >& aHypList,
147 const bool andAncestors) const;
149 const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
151 void ClearLog() throw(SALOME_Exception);
153 int GetId() const { return _id; }
155 bool MeshExists( int meshId ) const;
157 SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
159 const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
161 SMESH_Gen *GetGen() { return _gen; }
163 SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
164 throw(SALOME_Exception);
166 SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
167 throw(SALOME_Exception);
169 SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
170 throw(SALOME_Exception);
172 * \brief Return submeshes of groups containing the given subshape
174 std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
175 throw(SALOME_Exception);
177 * \brief Say all submeshes that theChangedHyp has been modified
179 void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
181 const std::list < SMESH_subMesh * >&
182 GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
184 * \brief Return True if anHyp is used to mesh aSubShape
186 bool IsUsedHypothesis(SMESHDS_Hypothesis * anHyp,
187 const SMESH_subMesh * aSubMesh);
189 * \brief check if a hypothesis alowing notconform mesh is present
191 bool IsNotConformAllowed() const;
193 bool IsMainShape(const TopoDS_Shape& theShape) const;
195 * \brief Return list of ancestors of theSubShape in the order
196 * that lower dimention shapes come first
198 const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
200 void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
202 bool GetAutoColor() throw(SALOME_Exception);
205 * \brief Set the flag meaning that the mesh has been edited "manually".
206 * It is to set to false after Clear() and to set to true by MeshEditor
208 void SetIsModified(bool isModified);
210 bool GetIsModified() const { return _isModified; }
213 * \brief Return true if the mesh has been edited since a total re-compute
214 * and those modifications may prevent successful partial re-compute.
215 * As a side effect reset _isModified flag if mesh is empty
217 bool HasModificationsToDiscard() const;
220 * \brief Return data map of descendant to ancestor shapes
222 typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
223 const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
225 * \brief Check group names for duplications.
226 * Consider maximum group name length stored in MED file
228 bool HasDuplicatedGroupNamesMED();
230 void ExportMED(const char *file,
231 const char* theMeshName = NULL,
232 bool theAutoGroups = true,
234 const SMESHDS_Mesh* meshPart = 0)
235 throw(SALOME_Exception);
237 void ExportDAT(const char * file,
238 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
239 void ExportUNV(const char * file,
240 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
241 void ExportSTL(const char * file,
243 const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
244 void ExportCGNS(const char * file,
245 const SMESHDS_Mesh* mesh);
246 void ExportGMF(const char * file,
247 const SMESHDS_Mesh* mesh);
248 void ExportSAUV(const char *file,
249 const char* theMeshName = NULL,
250 bool theAutoGroups = true) throw(SALOME_Exception);
252 int NbNodes() const throw(SALOME_Exception);
254 int Nb0DElements() const throw(SALOME_Exception);
256 int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
258 int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
260 int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
262 int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
264 int NbBiQuadQuadrangles() const throw(SALOME_Exception);
266 int NbPolygons() const throw(SALOME_Exception);
268 int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
270 int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
272 int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
274 int NbTriQuadraticHexas() const throw(SALOME_Exception);
276 int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
278 int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
280 int NbHexagonalPrisms() const throw(SALOME_Exception);
282 int NbPolyhedrons() const throw(SALOME_Exception);
284 int NbBalls() const throw(SALOME_Exception);
286 int NbSubMesh() const throw(SALOME_Exception);
288 int NbGroup() const { return _mapGroup.size(); }
290 SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
293 const TopoDS_Shape& theShape=TopoDS_Shape(),
294 const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
296 SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
298 typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
299 GroupIteratorPtr GetGroups() const;
301 std::list<int> GetGroupIds() const;
303 SMESH_Group* GetGroup (const int theGroupID);
305 bool RemoveGroup (const int theGroupID);
307 SMESH_Group* ConvertToStandalone ( int theGroupID );
309 struct TCallUp // callback from SMESH to SMESH_I level
311 virtual void RemoveGroup (const int theGroupID)=0;
312 virtual void HypothesisModified ()=0;
313 virtual void Load ()=0;
314 virtual ~TCallUp() {}
316 void SetCallUp( TCallUp * upCaller );
318 bool SynchronizeGroups();
321 SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
323 void ClearMeshOrder();
324 void SetMeshOrder(const TListOfListOfInt& theOrder );
325 const TListOfListOfInt& GetMeshOrder() const;
327 // sort submeshes according to stored mesh order
328 bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
330 // return true if given order of sub-meshes is OK
331 bool IsOrderOK( const SMESH_subMesh* smBefore,
332 const SMESH_subMesh* smAfter ) const;
334 ostream& Dump(ostream & save);
338 void fillAncestorsMap(const TopoDS_Shape& theShape);
339 std::list<SMESH_subMesh*> getAncestorsSubMeshes
340 (const TopoDS_Shape& theSubShape) const;
343 int _id; // id given by creator (unique within the creator instance)
345 int _idDoc; // id given by SMESHDS_Document
346 int _groupId; // id generator for group objects
347 int _nbSubShapes; // initial nb of subshapes in the shape to mesh
348 bool _isShapeToMesh;// set to true when a shape is given (only once)
349 std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
350 SMESHDS_Document * _myDocument;
351 SMESHDS_Mesh * _myMeshDS;
353 std::map <int, SMESH_subMesh*> _mapSubMesh;
354 std::map <int, SMESH_Group*> _mapGroup;
357 bool _isModified; //!< modified since last total re-compute, issue 0020693
359 double _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
361 TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
363 TListOfListOfInt _mySubMeshOrder;
365 // Struct calling methods at CORBA API implementation level, used to
366 // 1) make an upper level be consistent with a lower one when group removal
367 // is invoked by hyp modification (issue 0020918)
368 // 2) to forget not loaded mesh data at hyp modification
373 SMESH_Mesh(const SMESH_Mesh&) {};