src/SMESH/SMESH_Mesh.hxx

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