src/SMESH/SMESH_Mesh.hxx

   1 // Copyright (C) 2007-2022  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 "MEDCouplingMemArray.hxx"
  45
  46 #include <map>
  47 #include <list>
  48 #include <vector>
  49 #include <ostream>
  50
  51 #include <boost/filesystem.hpp>
  52 #include <boost/asio/thread_pool.hpp>
  53 #include <boost/thread.hpp>
  54
  55 #ifdef WIN32
  56 #pragma warning(disable:4251) // Warning DLL Interface ...
  57 #pragma warning(disable:4290) // Warning Exception ...
  58 #endif
  59
  60 class SMESHDS_Command;
  61 class SMESHDS_Document;
  62 class SMESHDS_GroupBase;
  63 class SMESHDS_Hypothesis;
  64 class SMESHDS_Mesh;
  65 class SMESH_Gen;
  66 class SMESH_Group;
  67 class SMESH_HypoFilter;
  68 class SMESH_subMesh;
  69 class TopoDS_Solid;
  70
  71 class DriverMED_W_SMESHDS_Mesh;
  72
  73 typedef std::list<int> TListOfInt;
  74 typedef std::list<TListOfInt> TListOfListOfInt;
  75
  76 class SMESH_EXPORT SMESH_Mesh
  77 {
  78  public:
  79   SMESH_Mesh(int               theLocalId,
  80              SMESH_Gen*        theGen,
  81              bool              theIsEmbeddedMode,
  82              SMESHDS_Document* theDocument);
  83
  84   virtual ~SMESH_Mesh();
  85
  86   /*!
  87    * \brief Set geometry to be meshed
  88    */
  89   void ShapeToMesh(const TopoDS_Shape & aShape);
  90   /*!
  91    * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
  92    */
  93   TopoDS_Shape GetShapeToMesh() const;
  94   /*!
  95    * \brief Return true if there is a geometry to be meshed, not PseudoShape()
  96    */
  97   bool HasShapeToMesh() const { return _isShapeToMesh; }
  98
  99   void UndefShapeToMesh() { _isShapeToMesh = false; }
 100
 101   /*!
 102    * \brief Return diagonal size of bounding box of shape to mesh.
 103    */
 104   double GetShapeDiagonalSize() const;
 105   /*!
 106    * \brief Return diagonal size of bounding box of a shape.
 107    */
 108   static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
 109   /*!
 110    * \brief Return a solid which is returned by GetShapeToMesh() if
 111    *        a real geometry to be meshed was not set
 112    */
 113   static const TopoDS_Solid& PseudoShape();
 114
 115   /*!
 116    * \brief Load mesh from study file
 117    */
 118   void Load();
 119   /*!
 120    * \brief Remove all nodes and elements
 121    */
 122   void Clear();
 123   /*!
 124    * \brief Remove all nodes and elements of indicated shape
 125    */
 126   void ClearSubMesh(const int theShapeId);
 127
 128   /*!
 129    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 130    */
 131   int UNVToMesh(const char* theFileName);
 132
 133   int MEDToMesh(const char* theFileName, const char* theMeshName);
 134
 135   std::string STLToMesh(const char* theFileName);
 136
 137   int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
 138
 139   SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
 140                                   bool        theMakeRequiredGroups = true );
 141
 142   SMESH_Hypothesis::Hypothesis_Status
 143   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
 144
 145   SMESH_Hypothesis::Hypothesis_Status
 146   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
 147
 148   const std::list <const SMESHDS_Hypothesis * >&
 149   GetHypothesisList(const TopoDS_Shape & aSubShape) const;
 150
 151   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
 152                                          const SMESH_HypoFilter& aFilter,
 153                                          const bool              andAncestors,
 154                                          TopoDS_Shape*           assignedTo=0) const;
 155
 156   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
 157                     const SMESH_HypoFilter&                  aFilter,
 158                     std::list< const SMESHDS_Hypothesis * >& aHypList,
 159                     const bool                               andAncestors,
 160                     std::list< TopoDS_Shape > *              assignedTo=0) const;
 161
 162   const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh *   aSubMesh,
 163                                          const SMESH_HypoFilter& aFilter,
 164                                          const bool              andAncestors,
 165                                          TopoDS_Shape*           assignedTo=0) const;
 166
 167   int GetHypotheses(const SMESH_subMesh *                    aSubMesh,
 168                     const SMESH_HypoFilter&                  aFilter,
 169                     std::list< const SMESHDS_Hypothesis * >& aHypList,
 170                     const bool                               andAncestors,
 171                     std::list< TopoDS_Shape > *              assignedTo=0) const;
 172
 173   SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
 174
 175   const std::list<SMESHDS_Command*> & GetLog();
 176
 177   void ClearLog();
 178
 179   int GetId() const          { return _id; }
 180
 181   bool MeshExists( int meshId ) const;
 182
 183   SMESH_Mesh* FindMesh( int meshId ) const;
 184
 185   SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
 186
 187   const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
 188
 189   SMESH_Gen *GetGen()        { return _gen; }
 190
 191   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
 192
 193   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
 194
 195   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
 196   /*!
 197    * \brief Return submeshes of groups containing the given subshape
 198    */
 199   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
 200   /*!
 201    * \brief Say all submeshes that theChangedHyp has been modified
 202    */
 203   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
 204
 205   // const std::list < SMESH_subMesh * >&
 206   // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
 207   /*!
 208    * \brief Return True if anHyp is used to mesh aSubShape
 209    */
 210   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
 211                         const SMESH_subMesh * aSubMesh);
 212   /*!
 213    * \brief check if a hypothesis allowing notconform mesh is present
 214    */
 215   bool IsNotConformAllowed() const;
 216
 217   bool IsMainShape(const TopoDS_Shape& theShape) const;
 218
 219   TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
 220
 221   /*!
 222    * \brief Return list of ancestors of theSubShape in the order
 223    *        that lower dimension shapes come first
 224    */
 225   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
 226
 227   void SetAutoColor(bool theAutoColor);
 228
 229   bool GetAutoColor();
 230
 231   /*!
 232    * \brief Set the flag meaning that the mesh has been edited "manually".
 233    * It is to set to false after Clear() and to set to true by MeshEditor
 234    */
 235   void SetIsModified(bool isModified);
 236
 237   bool GetIsModified() const { return _isModified; }
 238
 239   /*!
 240    * \brief Return true if the mesh has been edited since a total re-compute
 241    *        and those modifications may prevent successful partial re-compute.
 242    *        As a side effect reset _isModified flag if mesh is empty
 243    */
 244   bool HasModificationsToDiscard() const;
 245
 246   /*!
 247    * \brief Return true if all sub-meshes are computed OK - to update an icon
 248    */
 249   bool IsComputedOK();
 250
 251   /*!
 252    * \brief Return data map of descendant to ancestor shapes
 253    */
 254   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
 255   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
 256
 257   /*!
 258    * \brief Check group names for duplications.
 259    *  Consider maximum group name length stored in MED file
 260    */
 261   bool HasDuplicatedGroupNamesMED();
 262
 263   /*!
 264    * \brief Exception thrown by Export*() in case if a mesh is too large for export
 265    *        due to limitation of a format
 266    */
 267   struct TooLargeForExport : public std::runtime_error
 268   {
 269     TooLargeForExport(const char* format):runtime_error(format) {}
 270   };
 271
 272   MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
 273     ExportMEDCoupling(const char*         theMeshName = NULL,
 274                       bool                theAutoGroups = true,
 275                       const SMESHDS_Mesh* theMeshPart = 0,
 276                       bool                theAutoDimension = false,
 277                       bool                theAddODOnVertices = false,
 278                       double              theZTolerance = -1.,
 279                       bool                theSaveNumbers = true);
 280
 281   void ExportMED(const char *        theFile,
 282                  const char*         theMeshName = NULL,
 283                  bool                theAutoGroups = true,
 284                  int                 theVersion = -1,
 285                  const SMESHDS_Mesh* theMeshPart = 0,
 286                  bool                theAutoDimension = false,
 287                  bool                theAddODOnVertices = false,
 288                  double              theZTolerance = -1.,
 289                  bool                theSaveNumbers = true);
 290
 291   void ExportDAT(const char *        file,
 292                  const SMESHDS_Mesh* meshPart = 0,
 293                  const bool          renumber = true);
 294   void ExportUNV(const char *        file,
 295                  const SMESHDS_Mesh* meshPart = 0,
 296                  const bool          renumber = true);
 297   void ExportSTL(const char *        file,
 298                  const bool          isascii,
 299                  const char *        name = 0,
 300                  const SMESHDS_Mesh* meshPart = 0);
 301   void ExportCGNS(const char *        file,
 302                   const SMESHDS_Mesh* mesh,
 303                   const char *        meshName = 0,
 304                   const bool          groupElemsByType = false);
 305   void ExportGMF(const char *        file,
 306                  const SMESHDS_Mesh* mesh,
 307                  bool                withRequiredGroups = true );
 308
 309   double GetComputeProgress() const;
 310
 311   smIdType NbNodes() const;
 312   smIdType Nb0DElements() const;
 313   smIdType NbBalls() const;
 314
 315   smIdType NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 316
 317   smIdType NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 318   smIdType NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 319   smIdType NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 320   smIdType NbBiQuadQuadrangles() const;
 321   smIdType NbBiQuadTriangles() const;
 322   smIdType NbPolygons(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 323
 324   smIdType NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 325   smIdType NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 326   smIdType NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 327   smIdType NbTriQuadraticHexas() const;
 328   smIdType NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 329   smIdType NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const;
 330   smIdType NbQuadPrisms() const;
 331   smIdType NbBiQuadPrisms() const;
 332   smIdType NbHexagonalPrisms() const;
 333   smIdType NbPolyhedrons() const;
 334
 335   smIdType NbSubMesh() const;
 336
 337   size_t NbGroup() const { return _mapGroup.size(); }
 338
 339   int NbMeshes() const; // nb meshes in the Study
 340
 341   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
 342                          const char*               theName,
 343                          const int                 theId = -1,
 344                          const TopoDS_Shape&       theShape = TopoDS_Shape(),
 345                          const SMESH_PredicatePtr& thePredicate = SMESH_PredicatePtr());
 346
 347   SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS);
 348
 349   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
 350   GroupIteratorPtr GetGroups() const;
 351
 352   std::list<int> GetGroupIds() const;
 353
 354   SMESH_Group* GetGroup (const int theGroupID) const;
 355
 356   bool RemoveGroup (const int theGroupID);
 357
 358   SMESH_Group* ConvertToStandalone ( int theGroupID );
 359
 360   struct TCallUp // callback from SMESH to SMESH_I level
 361   {
 362     virtual void RemoveGroup( const int theGroupID )=0;
 363     virtual void HypothesisModified( int hypID, bool updateIcons )=0;
 364     virtual void Load()=0;
 365     virtual bool IsLoaded()=0;
 366     virtual TopoDS_Shape GetShapeByEntry(const std::string& entry)=0;
 367     virtual ~TCallUp() {}
 368   };
 369   void SetCallUp( TCallUp * upCaller );
 370
 371   bool SynchronizeGroups();
 372
 373
 374   SMDSAbs_ElementType GetElementType( const smIdType id, const bool iselem );
 375
 376   void ClearMeshOrder();
 377   void SetMeshOrder(const TListOfListOfInt& theOrder );
 378   const TListOfListOfInt& GetMeshOrder() const;
 379
 380   // sort submeshes according to stored mesh order
 381   bool SortByMeshOrder(std::vector<SMESH_subMesh*>& theListToSort) const;
 382
 383   // return true if given order of sub-meshes is OK
 384   bool IsOrderOK( const SMESH_subMesh* smBefore,
 385                   const SMESH_subMesh* smAfter ) const;
 386
 387   std::ostream& Dump(std::ostream & save);
 388
 389   // Parallel computation functions
 390
 391   void Lock() {_my_lock.lock();};
 392   void Unlock() {_my_lock.unlock();};
 393
 394   int GetNbThreads(){return _NbThreads;};
 395   void SetNbThreads(int nbThreads){_NbThreads=nbThreads;};
 396
 397   void InitPoolThreads(){_pool = new boost::asio::thread_pool(_NbThreads);};
 398   void DeletePoolThreads(){delete _pool;};
 399
 400   void wait(){_pool->join(); DeletePoolThreads(); InitPoolThreads(); }
 401
 402   bool IsParallel(){return _NbThreads > 0;}
 403
 404   // Temporary folder used during parallel Computation
 405   boost::filesystem::path tmp_folder;
 406   boost::asio::thread_pool *     _pool = nullptr; //thread pool for computation
 407
 408
 409 private:
 410
 411   void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
 412                         const char*               theMeshName,
 413                         bool                      theAutoGroups,
 414                         const SMESHDS_Mesh*       meshPart,
 415                         bool                      theAutoDimension,
 416                         bool                      theAddODOnVertices,
 417                         double                    theZTolerance,
 418                         bool                      theSaveNumbers);
 419
 420  private:
 421   void fillAncestorsMap(const TopoDS_Shape& theShape);
 422   void getAncestorsSubMeshes(const TopoDS_Shape&            theSubShape,
 423                              std::vector< SMESH_subMesh* >& theSubMeshes) const;
 424
 425 protected:
 426   int                        _id;           // id given by creator (unique within the creator instance)
 427   int                        _groupId;      // id generator for group objects
 428   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 429   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 430   SMESHDS_Document *         _document;
 431   SMESHDS_Mesh *             _meshDS;
 432   SMESH_Gen *                _gen;
 433   std::map <int, SMESH_Group*> _mapGroup;
 434
 435   class SubMeshHolder;
 436   SubMeshHolder*             _subMeshHolder;
 437
 438   bool                       _isAutoColor;
 439   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 440
 441   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 442
 443   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 444
 445   mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
 446
 447   TListOfListOfInt           _subMeshOrder;
 448
 449   // Struct calling methods at CORBA API implementation level, used to
 450   // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
 451   // when group removal is invoked by hyp modification (issue 0020918)
 452   // 2) to forget not loaded mesh data at hyp modification
 453   TCallUp*                    _callUp;
 454
 455   // Mutex for multhitreading write in SMESH_Mesh
 456   boost::mutex _my_lock;
 457   int _NbThreads=0;
 458
 459 protected:
 460   SMESH_Mesh();
 461   SMESH_Mesh(const SMESH_Mesh&) {};
 462 };
 463 #endif