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