src/SMESH/SMESH_Mesh.hxx

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