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