src/SMESH/SMESH_Mesh.hxx

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