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   /*!
 250    * \brief Check group names for duplications.
 251    *  Consider maximum group name length stored in MED file
 252    */
 253   bool HasDuplicatedGroupNamesMED();
 254
 255   /*!
 256    * \brief Exception thrown by Export*() in case if a mesh is too large for export
 257    *        due to limitation of a format
 258    */
 259   struct TooLargeForExport : public std::runtime_error
 260   {
 261     TooLargeForExport(const char* format):runtime_error(format) {}
 262   };
 263
 264   void ExportMED(const char *        theFile,
 265                  const char*         theMeshName = NULL,
 266                  bool                theAutoGroups = true,
 267                  int                 theVersion = -1,
 268                  const SMESHDS_Mesh* theMeshPart = 0,
 269                  bool                theAutoDimension = false,
 270                  bool                theAddODOnVertices = false,
 271                  double              theZTolerance = -1.,
 272                  bool                theAllElemsToGroup = false);
 273
 274   void ExportDAT(const char *        file,
 275                  const SMESHDS_Mesh* meshPart = 0);
 276   void ExportUNV(const char *        file,
 277                  const SMESHDS_Mesh* meshPart = 0);
 278   void ExportSTL(const char *        file,
 279                  const bool          isascii,
 280                  const char *        name = 0,
 281                  const SMESHDS_Mesh* meshPart = 0);
 282   void ExportCGNS(const char *        file,
 283                   const SMESHDS_Mesh* mesh,
 284                   const char *        meshName = 0,
 285                   const bool          groupElemsByType = false);
 286   void ExportGMF(const char *        file,
 287                  const SMESHDS_Mesh* mesh,
 288                  bool                withRequiredGroups = true );
 289   void ExportSAUV(const char *file,
 290                   const char* theMeshName = NULL,
 291                   bool theAutoGroups = true);
 292
 293   double GetComputeProgress() const;
 294
 295   smIdType NbNodes() const;
 296   smIdType Nb0DElements() const;
 297   smIdType NbBalls() const;
 298
 299   smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 300
 301   smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 302   smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 303   smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 304   smIdType NbBiQuadQuadrangles() const;
 305   smIdType NbBiQuadTriangles() const;
 306   smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 307
 308   smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 309   smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 310   smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 311   smIdType NbTriQuadraticHexas() const;
 312   smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 313   smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 314   smIdType NbQuadPrisms() const;
 315   smIdType NbBiQuadPrisms() const;
 316   smIdType NbHexagonalPrisms() const;
 317   smIdType NbPolyhedrons() const;
 318
 319   smIdType NbSubMesh() const;
 320
 321   size_t NbGroup() const { return _mapGroup.size(); }
 322
 323   int NbMeshes() const; // nb meshes in the Study
 324
 325   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
 326                          const char*               theName,
 327                          const int                 theId = -1,
 328                          const TopoDS_Shape&       theShape = TopoDS_Shape(),
 329                          const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
 330
 331   SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
 332
 333   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
 334   GroupIteratorPtr GetGroups() const;
 335
 336   std::list<int> GetGroupIds() const;
 337
 338   SMESH_Group* GetGroup (const int theGroupID) const;
 339
 340   bool RemoveGroup (const int theGroupID);
 341
 342   SMESH_Group* ConvertToStandalone ( int theGroupID );
 343
 344   struct TCallUp // callback from SMESH to SMESH_I level
 345   {
 346     virtual void RemoveGroup( const int theGroupID )=0;
 347     virtual void HypothesisModified( int hypID, bool updateIcons )=0;
 348     virtual void Load()=0;
 349     virtual bool IsLoaded()=0;
 350     virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
 351     virtual ~TCallUp() {}
 352   };
 353   void SetCallUp( TCallUp * upCaller );
 354
 355   bool SynchronizeGroups();
 356
 357
 358   SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
 359
 360   void ClearMeshOrder();
 361   void SetMeshOrder(const TListOfListOfInt& theOrder );
 362   const TListOfListOfInt& GetMeshOrder() const;
 363
 364   // sort submeshes according to stored mesh order
 365   bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
 366
 367   // return true if given order of sub-meshes is OK
 368   bool IsOrderOK( const SMESH_subMesh* smBefore,
 369                   const SMESH_subMesh* smAfter ) const;
 370
 371   std::ostream& Dump(std::ostream & save);
 372
 373 private:
 374
 375   void fillAncestorsMap(const TopoDS_Shape& theShape);
 376   void getAncestorsSubMeshes(const TopoDS_Shape&            theSubShape,
 377                              std::vector< SMESH_subMesh* >& theSubMeshes) const;
 378
 379 protected:
 380   int                        _id;           // id given by creator (unique within the creator instance)
 381   int                        _groupId;      // id generator for group objects
 382   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 383   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 384   SMESHDS_Document *         _myDocument;
 385   SMESHDS_Mesh *             _myMeshDS;
 386   SMESH_Gen *                _gen;
 387   std::map <int, SMESH_Group*> _mapGroup;
 388
 389   class SubMeshHolder;
 390   SubMeshHolder*             _subMeshHolder;
 391
 392   bool                       _isAutoColor;
 393   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 394
 395   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 396
 397   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 398
 399   mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
 400
 401   TListOfListOfInt           _mySubMeshOrder;
 402
 403   // Struct calling methods at CORBA API implementation level, used to
 404   // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
 405   // when group removal is invoked by hyp modification (issue 0020918)
 406   // 2) to forget not loaded mesh data at hyp modification
 407   TCallUp*                    _callUp;
 408
 409 protected:
 410   SMESH_Mesh();
 411   SMESH_Mesh(const SMESH_Mesh&) {};
 412 };
 413
 414 #endif