]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESH/SMESH_Mesh.hxx
Salome HOME
Correction du cas-test faceGauche2
[modules/smesh.git] / src / SMESH / SMESH_Mesh.hxx
1 // Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  File   : SMESH_Mesh.hxx
24 //  Author : Paul RASCLE, EDF
25 //  Module : SMESH
26 //
27 #ifndef _SMESH_MESH_HXX_
28 #define _SMESH_MESH_HXX_
29
30 #include "SMESH_SMESH.hxx"
31
32 #include "SMDSAbs_ElementType.hxx"
33 #include "SMESH_ComputeError.hxx"
34 #include "SMESH_Controls.hxx"
35 #include "SMESH_Hypothesis.hxx"
36 #include "SMDS_Iterator.hxx"
37
38 #include "Utils_SALOME_Exception.hxx"
39
40 #include <TopoDS_Shape.hxx>
41 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
42 #include <TopTools_ListOfShape.hxx>
43
44 #include <map>
45 #include <list>
46 #include <vector>
47 #include <ostream>
48
49 #ifdef WIN32
50 #pragma warning(disable:4251) // Warning DLL Interface ...
51 #pragma warning(disable:4290) // Warning Exception ...
52 #endif
53
54 class SMESHDS_Command;
55 class SMESHDS_Document;
56 class SMESHDS_GroupBase;
57 class SMESHDS_Hypothesis;
58 class SMESHDS_Mesh;
59 class SMESH_Gen;
60 class SMESH_Group;
61 class SMESH_HypoFilter;
62 class SMESH_subMesh;
63 class TopoDS_Solid;
64
65 typedef std::list<int> TListOfInt;
66 typedef std::list<TListOfInt> TListOfListOfInt;
67
68 class SMESH_EXPORT SMESH_Mesh
69 {
70  public:
71   SMESH_Mesh(int               theLocalId,
72              SMESH_Gen*        theGen,
73              bool              theIsEmbeddedMode,
74              SMESHDS_Document* theDocument);
75
76   virtual ~SMESH_Mesh();
77
78   /*!
79    * \brief Set geometry to be meshed
80    */
81   void ShapeToMesh(const TopoDS_Shape & aShape);
82   /*!
83    * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
84    */
85   TopoDS_Shape GetShapeToMesh() const;
86   /*!
87    * \brief Return true if there is a geometry to be meshed, not PseudoShape()
88    */
89   bool HasShapeToMesh() const { return _isShapeToMesh; }
90
91   void UndefShapeToMesh() { _isShapeToMesh = false; }
92
93   /*!
94    * \brief Return diagonal size of bounding box of shape to mesh.
95    */
96   double GetShapeDiagonalSize() const;
97   /*!
98    * \brief Return diagonal size of bounding box of a shape.
99    */
100   static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
101   /*!
102    * \brief Return a solid which is returned by GetShapeToMesh() if
103    *        a real geometry to be meshed was not set
104    */
105   static const TopoDS_Solid& PseudoShape();
106
107   /*!
108    * \brief Load mesh from study file
109    */
110   void Load();
111   /*!
112    * \brief Remove all nodes and elements
113    */
114   void Clear();
115   /*!
116    * \brief Remove all nodes and elements of indicated shape
117    */
118   void ClearSubMesh(const int theShapeId);
119
120   /*!
121    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
122    */
123   int UNVToMesh(const char* theFileName);
124
125   int MEDToMesh(const char* theFileName, const char* theMeshName);
126   
127   std::string STLToMesh(const char* theFileName);
128
129   int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
130   
131   SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
132                                   bool        theMakeRequiredGroups = true );
133
134   SMESH_Hypothesis::Hypothesis_Status
135   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
136   
137   SMESH_Hypothesis::Hypothesis_Status
138   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
139   
140   const std::list <const SMESHDS_Hypothesis * >&
141   GetHypothesisList(const TopoDS_Shape & aSubShape) const;
142
143   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
144                                          const SMESH_HypoFilter& aFilter,
145                                          const bool              andAncestors,
146                                          TopoDS_Shape*           assignedTo=0) const;
147   
148   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
149                     const SMESH_HypoFilter&                  aFilter,
150                     std::list< const SMESHDS_Hypothesis * >& aHypList,
151                     const bool                               andAncestors,
152                     std::list< TopoDS_Shape > *              assignedTo=0) const;
153
154   const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh *   aSubMesh,
155                                          const SMESH_HypoFilter& aFilter,
156                                          const bool              andAncestors,
157                                          TopoDS_Shape*           assignedTo=0) const;
158   
159   int GetHypotheses(const SMESH_subMesh *                    aSubMesh,
160                     const SMESH_HypoFilter&                  aFilter,
161                     std::list< const SMESHDS_Hypothesis * >& aHypList,
162                     const bool                               andAncestors,
163                     std::list< TopoDS_Shape > *              assignedTo=0) const;
164
165   SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
166
167   const std::list<SMESHDS_Command*> & GetLog();
168   
169   void ClearLog();
170   
171   int GetId() const          { return _id; }
172   
173   bool MeshExists( int meshId ) const;
174   
175   SMESH_Mesh* FindMesh( int meshId ) const;
176
177   SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
178
179   const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
180   
181   SMESH_Gen *GetGen()        { return _gen; }
182
183   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
184   
185   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
186   
187   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
188   /*!
189    * \brief Return submeshes of groups containing the given subshape
190    */
191   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
192   /*!
193    * \brief Say all submeshes that theChangedHyp has been modified
194    */
195   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
196
197   // const std::list < SMESH_subMesh * >&
198   // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
199   /*!
200    * \brief Return True if anHyp is used to mesh aSubShape
201    */
202   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
203                         const SMESH_subMesh * aSubMesh);
204   /*!
205    * \brief check if a hypothesis allowing notconform mesh is present
206    */
207   bool IsNotConformAllowed() const;
208   
209   bool IsMainShape(const TopoDS_Shape& theShape) const;
210
211   TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
212
213   /*!
214    * \brief Return list of ancestors of theSubShape in the order
215    *        that lower dimension shapes come first
216    */
217   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
218
219   void SetAutoColor(bool theAutoColor);
220
221   bool GetAutoColor();
222
223   /*!
224    * \brief Set the flag meaning that the mesh has been edited "manually".
225    * It is to set to false after Clear() and to set to true by MeshEditor
226    */
227   void SetIsModified(bool isModified);
228
229   bool GetIsModified() const { return _isModified; }
230
231   /*!
232    * \brief Return true if the mesh has been edited since a total re-compute
233    *        and those modifications may prevent successful partial re-compute.
234    *        As a side effect reset _isModified flag if mesh is empty
235    */
236   bool HasModificationsToDiscard() const;
237
238   /*!
239    * \brief Return true if all sub-meshes are computed OK - to update an icon
240    */
241   bool IsComputedOK();
242
243   /*!
244    * \brief Return data map of descendant to ancestor shapes
245    */
246   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
247   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
248   /*!
249    * \brief Check group names for duplications.
250    *  Consider maximum group name length stored in MED file
251    */
252   bool HasDuplicatedGroupNamesMED();
253
254   void ExportMED(const char *        theFile,
255                  const char*         theMeshName = NULL,
256                  bool                theAutoGroups = true,
257                  int                 theVersion = -1,
258                  const SMESHDS_Mesh* theMeshPart = 0,
259                  bool                theAutoDimension = false,
260                  bool                theAddODOnVertices = false,
261                  double              theZTolerance = -1.,
262                  bool                theAllElemsToGroup = false);
263
264   void ExportDAT(const char *        file,
265                  const SMESHDS_Mesh* meshPart = 0);
266   void ExportUNV(const char *        file,
267                  const SMESHDS_Mesh* meshPart = 0);
268   void ExportSTL(const char *        file,
269                  const bool          isascii,
270                  const char *        name = 0,
271                  const SMESHDS_Mesh* meshPart = 0);
272   void ExportCGNS(const char *        file,
273                   const SMESHDS_Mesh* mesh,
274                   const char *        meshName = 0,
275                   const bool          groupElemsByType = false);
276   void ExportGMF(const char *        file,
277                  const SMESHDS_Mesh* mesh,
278                  bool                withRequiredGroups = true );
279   void ExportSAUV(const char *file, 
280                   const char* theMeshName = NULL, 
281                   bool theAutoGroups = true);
282
283   double GetComputeProgress() const;
284   
285   int NbNodes() const;
286   int Nb0DElements() const;
287   int NbBalls() const;
288   
289   int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
290   
291   int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
292   int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
293   int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
294   int NbBiQuadQuadrangles() const;
295   int NbBiQuadTriangles() const;
296   int NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
297   
298   int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
299   int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
300   int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
301   int NbTriQuadraticHexas() const;
302   int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
303   int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
304   int NbQuadPrisms() const;
305   int NbBiQuadPrisms() const;
306   int NbHexagonalPrisms() const;
307   int NbPolyhedrons() const;
308   
309   int NbSubMesh() const;
310   
311   int NbGroup() const { return _mapGroup.size(); }
312
313   int NbMeshes() const; // nb meshes in the Study
314
315   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
316                          const char*               theName,
317                          const int                 theId = -1,
318                          const TopoDS_Shape&       theShape = TopoDS_Shape(),
319                          const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
320
321   SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
322
323   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
324   GroupIteratorPtr GetGroups() const;
325   
326   std::list<int> GetGroupIds() const;
327   
328   SMESH_Group* GetGroup (const int theGroupID) const;
329
330   bool RemoveGroup (const int theGroupID);
331
332   SMESH_Group* ConvertToStandalone ( int theGroupID );
333
334   struct TCallUp // callback from SMESH to SMESH_I level
335   {
336     virtual void RemoveGroup( const int theGroupID )=0;
337     virtual void HypothesisModified( int hypID, bool updateIcons )=0;
338     virtual void Load()=0;
339     virtual bool IsLoaded()=0;
340     virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
341     virtual ~TCallUp() {}
342   };
343   void SetCallUp( TCallUp * upCaller );
344
345   bool SynchronizeGroups();
346
347
348   SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
349
350   void ClearMeshOrder();
351   void SetMeshOrder(const TListOfListOfInt& theOrder );
352   const TListOfListOfInt& GetMeshOrder() const;
353
354   // sort submeshes according to stored mesh order
355   bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
356
357   // return true if given order of sub-meshes is OK
358   bool IsOrderOK( const SMESH_subMesh* smBefore,
359                   const SMESH_subMesh* smAfter ) const;
360
361   std::ostream& Dump(std::ostream & save);
362   
363 private:
364
365   void fillAncestorsMap(const TopoDS_Shape& theShape);
366   void getAncestorsSubMeshes(const TopoDS_Shape&            theSubShape,
367                              std::vector< SMESH_subMesh* >& theSubMeshes) const;
368   
369 protected:
370   int                        _id;           // id given by creator (unique within the creator instance)
371   int                        _groupId;      // id generator for group objects
372   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
373   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
374   SMESHDS_Document *         _myDocument;
375   SMESHDS_Mesh *             _myMeshDS;
376   SMESH_Gen *                _gen;
377   std::map <int, SMESH_Group*> _mapGroup;
378
379   class SubMeshHolder;
380   SubMeshHolder*             _subMeshHolder;
381   
382   bool                       _isAutoColor;
383   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
384
385   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
386   
387   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
388
389   mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
390
391   TListOfListOfInt           _mySubMeshOrder;
392
393   // Struct calling methods at CORBA API implementation level, used to
394   // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
395   // when group removal is invoked by hyp modification (issue 0020918)
396   // 2) to forget not loaded mesh data at hyp modification
397   TCallUp*                    _callUp;
398
399 protected:
400   SMESH_Mesh();
401   SMESH_Mesh(const SMESH_Mesh&) {};
402 };
403
404 #endif