src/SMESH/SMESH_Mesh.hxx

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