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 "MEDCouplingMemArray.hxx"
  45
  46 #include <map>
  47 #include <list>
  48 #include <vector>
  49 #include <ostream>
  50
  51 #ifdef WIN32
  52 #pragma warning(disable:4251) // Warning DLL Interface ...
  53 #pragma warning(disable:4290) // Warning Exception ...
  54 #endif
  55
  56 class SMESHDS_Command;
  57 class SMESHDS_Document;
  58 class SMESHDS_GroupBase;
  59 class SMESHDS_Hypothesis;
  60 class SMESHDS_Mesh;
  61 class SMESH_Gen;
  62 class SMESH_Group;
  63 class SMESH_HypoFilter;
  64 class SMESH_subMesh;
  65 class TopoDS_Solid;
  66
  67 class DriverMED_W_SMESHDS_Mesh;
  68
  69 typedef std::list<int> TListOfInt;
  70 typedef std::list<TListOfInt> TListOfListOfInt;
  71
  72 class SMESH_EXPORT SMESH_Mesh
  73 {
  74  public:
  75   SMESH_Mesh(int               theLocalId,
  76              SMESH_Gen*        theGen,
  77              bool              theIsEmbeddedMode,
  78              SMESHDS_Document* theDocument);
  79
  80   virtual ~SMESH_Mesh();
  81
  82   /*!
  83    * \brief Set geometry to be meshed
  84    */
  85   void ShapeToMesh(const TopoDS_Shape & aShape);
  86   /*!
  87    * \brief Return geometry to be meshed. (It may be a PseudoShape()!)
  88    */
  89   TopoDS_Shape GetShapeToMesh() const;
  90   /*!
  91    * \brief Return true if there is a geometry to be meshed, not PseudoShape()
  92    */
  93   bool HasShapeToMesh() const { return _isShapeToMesh; }
  94
  95   void UndefShapeToMesh() { _isShapeToMesh = false; }
  96
  97   /*!
  98    * \brief Return diagonal size of bounding box of shape to mesh.
  99    */
 100   double GetShapeDiagonalSize() const;
 101   /*!
 102    * \brief Return diagonal size of bounding box of a shape.
 103    */
 104   static double GetShapeDiagonalSize(const TopoDS_Shape & aShape);
 105   /*!
 106    * \brief Return a solid which is returned by GetShapeToMesh() if
 107    *        a real geometry to be meshed was not set
 108    */
 109   static const TopoDS_Solid& PseudoShape();
 110
 111   /*!
 112    * \brief Load mesh from study file
 113    */
 114   void Load();
 115   /*!
 116    * \brief Remove all nodes and elements
 117    */
 118   void Clear();
 119   /*!
 120    * \brief Remove all nodes and elements of indicated shape
 121    */
 122   void ClearSubMesh(const int theShapeId);
 123
 124   /*!
 125    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 126    */
 127   int UNVToMesh(const char* theFileName);
 128
 129   int MEDToMesh(const char* theFileName, const char* theMeshName);
 130
 131   std::string STLToMesh(const char* theFileName);
 132
 133   int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
 134
 135   SMESH_ComputeErrorPtr GMFToMesh(const char* theFileName,
 136                                   bool        theMakeRequiredGroups = true );
 137
 138   SMESH_Hypothesis::Hypothesis_Status
 139   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId, std::string* error=0);
 140
 141   SMESH_Hypothesis::Hypothesis_Status
 142   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId);
 143
 144   const std::list <const SMESHDS_Hypothesis * >&
 145   GetHypothesisList(const TopoDS_Shape & aSubShape) const;
 146
 147   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
 148                                          const SMESH_HypoFilter& aFilter,
 149                                          const bool              andAncestors,
 150                                          TopoDS_Shape*           assignedTo=0) const;
 151
 152   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
 153                     const SMESH_HypoFilter&                  aFilter,
 154                     std::list< const SMESHDS_Hypothesis * >& aHypList,
 155                     const bool                               andAncestors,
 156                     std::list< TopoDS_Shape > *              assignedTo=0) const;
 157
 158   const SMESH_Hypothesis * GetHypothesis(const SMESH_subMesh *   aSubMesh,
 159                                          const SMESH_HypoFilter& aFilter,
 160                                          const bool              andAncestors,
 161                                          TopoDS_Shape*           assignedTo=0) const;
 162
 163   int GetHypotheses(const SMESH_subMesh *                    aSubMesh,
 164                     const SMESH_HypoFilter&                  aFilter,
 165                     std::list< const SMESHDS_Hypothesis * >& aHypList,
 166                     const bool                               andAncestors,
 167                     std::list< TopoDS_Shape > *              assignedTo=0) const;
 168
 169   SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
 170
 171   const std::list<SMESHDS_Command*> & GetLog();
 172
 173   void ClearLog();
 174
 175   int GetId() const          { return _id; }
 176
 177   bool MeshExists( int meshId ) const;
 178
 179   SMESH_Mesh* FindMesh( int meshId ) const;
 180
 181   SMESHDS_Mesh * GetMeshDS() { return _meshDS; }
 182
 183   const SMESHDS_Mesh * GetMeshDS() const { return _meshDS; }
 184
 185   SMESH_Gen *GetGen()        { return _gen; }
 186
 187   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape);
 188
 189   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const;
 190
 191   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const;
 192   /*!
 193    * \brief Return submeshes of groups containing the given subshape
 194    */
 195   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const;
 196   /*!
 197    * \brief Say all submeshes that theChangedHyp has been modified
 198    */
 199   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
 200
 201   // const std::list < SMESH_subMesh * >&
 202   // GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
 203   /*!
 204    * \brief Return True if anHyp is used to mesh aSubShape
 205    */
 206   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
 207                         const SMESH_subMesh * aSubMesh);
 208   /*!
 209    * \brief check if a hypothesis allowing notconform mesh is present
 210    */
 211   bool IsNotConformAllowed() const;
 212
 213   bool IsMainShape(const TopoDS_Shape& theShape) const;
 214
 215   TopoDS_Shape GetShapeByEntry(const std::string& entry) const;
 216
 217   /*!
 218    * \brief Return list of ancestors of theSubShape in the order
 219    *        that lower dimension shapes come first
 220    */
 221   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
 222
 223   void SetAutoColor(bool theAutoColor);
 224
 225   bool GetAutoColor();
 226
 227   /*!
 228    * \brief Set the flag meaning that the mesh has been edited "manually".
 229    * It is to set to false after Clear() and to set to true by MeshEditor
 230    */
 231   void SetIsModified(bool isModified);
 232
 233   bool GetIsModified() const { return _isModified; }
 234
 235   /*!
 236    * \brief Return true if the mesh has been edited since a total re-compute
 237    *        and those modifications may prevent successful partial re-compute.
 238    *        As a side effect reset _isModified flag if mesh is empty
 239    */
 240   bool HasModificationsToDiscard() const;
 241
 242   /*!
 243    * \brief Return true if all sub-meshes are computed OK - to update an icon
 244    */
 245   bool IsComputedOK();
 246
 247   /*!
 248    * \brief Return data map of descendant to ancestor shapes
 249    */
 250   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
 251   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
 252
 253   /*!
 254    * \brief Check group names for duplications.
 255    *  Consider maximum group name length stored in MED file
 256    */
 257   bool HasDuplicatedGroupNamesMED();
 258
 259   /*!
 260    * \brief Exception thrown by Export*() in case if a mesh is too large for export
 261    *        due to limitation of a format
 262    */
 263   struct TooLargeForExport : public std::runtime_error
 264   {
 265     TooLargeForExport(const char* format):runtime_error(format) {}
 266   };
 267
 268   MEDCoupling::MCAuto<MEDCoupling::DataArrayByte>
 269     ExportMEDCoupling(const char*         theMeshName = NULL,
 270                       bool                theAutoGroups = true,
 271                       const SMESHDS_Mesh* theMeshPart = 0,
 272                       bool                theAutoDimension = false,
 273                       bool                theAddODOnVertices = false,
 274                       double              theZTolerance = -1.,
 275                       bool                theSaveNumbers = true);
 276
 277   void ExportMED(const char *        theFile,
 278                  const char*         theMeshName = NULL,
 279                  bool                theAutoGroups = true,
 280                  int                 theVersion = -1,
 281                  const SMESHDS_Mesh* theMeshPart = 0,
 282                  bool                theAutoDimension = false,
 283                  bool                theAddODOnVertices = false,
 284                  double              theZTolerance = -1.,
 285                  bool                theSaveNumbers = true,
 286                  bool                theAllElemsToGroup = false);
 287
 288   void ExportDAT(const char *        file,
 289                  const SMESHDS_Mesh* meshPart = 0,
 290                  const bool          renumber = true);
 291   void ExportUNV(const char *        file,
 292                  const SMESHDS_Mesh* meshPart = 0,
 293                  const bool          renumber = true);
 294   void ExportSTL(const char *        file,
 295                  const bool          isascii,
 296                  const char *        name = 0,
 297                  const SMESHDS_Mesh* meshPart = 0);
 298   void ExportCGNS(const char *        file,
 299                   const SMESHDS_Mesh* mesh,
 300                   const char *        meshName = 0,
 301                   const bool          groupElemsByType = false);
 302   void ExportGMF(const char *        file,
 303                  const SMESHDS_Mesh* mesh,
 304                  bool                withRequiredGroups = true );
 305   void ExportSAUV(const char *file,
 306                   const char* theMeshName = NULL,
 307                   bool theAutoGroups = 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 private:
 390
 391   void exportMEDCommmon(DriverMED_W_SMESHDS_Mesh& myWriter,
 392                         const char*               theMeshName,
 393                         bool                      theAutoGroups,
 394                         const SMESHDS_Mesh*       meshPart,
 395                         bool                      theAutoDimension,
 396                         bool                      theAddODOnVertices,
 397                         double                    theZTolerance,
 398                         bool                      theSaveNumbers,
 399                         bool                      theAllElemsToGroup);
 400
 401  private:
 402   void fillAncestorsMap(const TopoDS_Shape& theShape);
 403   void getAncestorsSubMeshes(const TopoDS_Shape&            theSubShape,
 404                              std::vector< SMESH_subMesh* >& theSubMeshes) const;
 405
 406 protected:
 407   int                        _id;           // id given by creator (unique within the creator instance)
 408   int                        _groupId;      // id generator for group objects
 409   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 410   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 411   SMESHDS_Document *         _document;
 412   SMESHDS_Mesh *             _meshDS;
 413   SMESH_Gen *                _gen;
 414   std::map <int, SMESH_Group*> _mapGroup;
 415
 416   class SubMeshHolder;
 417   SubMeshHolder*             _subMeshHolder;
 418
 419   bool                       _isAutoColor;
 420   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 421
 422   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 423
 424   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 425
 426   mutable std::vector<SMESH_subMesh*> _ancestorSubMeshes; // to speed up GetHypothes[ei]s()
 427
 428   TListOfListOfInt           _subMeshOrder;
 429
 430   // Struct calling methods at CORBA API implementation level, used to
 431   // 1) make an upper level (SMESH_I) be consistent with a lower one (SMESH)
 432   // when group removal is invoked by hyp modification (issue 0020918)
 433   // 2) to forget not loaded mesh data at hyp modification
 434   TCallUp*                    _callUp;
 435
 436 protected:
 437   SMESH_Mesh();
 438   SMESH_Mesh(const SMESH_Mesh&) {};
 439 };
 440
 441 #endif