src/SMESH/SMESH_Mesh.hxx

   1 // Copyright (C) 2007-2013  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.
  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 WNT
  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)
 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   SMESH_Hypothesis * GetHypothesis(const int aHypID) const;
 152
 153   const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
 154
 155   void ClearLog() throw(SALOME_Exception);
 156
 157   int GetId() const          { return _id; }
 158
 159   bool MeshExists( int meshId ) const;
 160
 161   SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
 162
 163   const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
 164
 165   SMESH_Gen *GetGen()        { return _gen; }
 166
 167   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
 168     throw(SALOME_Exception);
 169
 170   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
 171     throw(SALOME_Exception);
 172
 173   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
 174     throw(SALOME_Exception);
 175   /*!
 176    * \brief Return submeshes of groups containing the given subshape
 177    */
 178   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
 179     throw(SALOME_Exception);
 180   /*!
 181    * \brief Say all submeshes that theChangedHyp has been modified
 182    */
 183   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
 184
 185   const std::list < SMESH_subMesh * >&
 186   GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
 187   /*!
 188    * \brief Return True if anHyp is used to mesh aSubShape
 189    */
 190   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
 191                         const SMESH_subMesh * aSubMesh);
 192   /*!
 193    * \brief check if a hypothesis alowing notconform mesh is present
 194    */
 195   bool IsNotConformAllowed() const;
 196
 197   bool IsMainShape(const TopoDS_Shape& theShape) const;
 198   /*!
 199    * \brief Return list of ancestors of theSubShape in the order
 200    *        that lower dimention shapes come first
 201    */
 202   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
 203
 204   void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
 205
 206   bool GetAutoColor() throw(SALOME_Exception);
 207
 208   /*!
 209    * \brief Set the flag meaning that the mesh has been edited "manually".
 210    * It is to set to false after Clear() and to set to true by MeshEditor
 211    */
 212   void SetIsModified(bool isModified);
 213
 214   bool GetIsModified() const { return _isModified; }
 215
 216   /*!
 217    * \brief Return true if the mesh has been edited since a total re-compute
 218    *        and those modifications may prevent successful partial re-compute.
 219    *        As a side effect reset _isModified flag if mesh is empty
 220    */
 221   bool HasModificationsToDiscard() const;
 222
 223   /*!
 224    * \brief Return data map of descendant to ancestor shapes
 225    */
 226   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
 227   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
 228   /*!
 229    * \brief Check group names for duplications.
 230    *  Consider maximum group name length stored in MED file
 231    */
 232   bool HasDuplicatedGroupNamesMED();
 233
 234   void ExportMED(const char *        theFile,
 235                  const char*         theMeshName = NULL,
 236                  bool                theAutoGroups = true,
 237                  int                 theVersion = 0,
 238                  const SMESHDS_Mesh* theMeshPart = 0,
 239                  bool                theAutoDimension = false)
 240     throw(SALOME_Exception);
 241
 242   void ExportDAT(const char *        file,
 243                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 244   void ExportUNV(const char *        file,
 245                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 246   void ExportSTL(const char *        file,
 247                  const bool          isascii,
 248                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 249   void ExportCGNS(const char *        file,
 250                   const SMESHDS_Mesh* mesh);
 251   void ExportGMF(const char *        file,
 252                  const SMESHDS_Mesh* mesh,
 253                  bool                withRequiredGroups = true );
 254   void ExportSAUV(const char *file,
 255                   const char* theMeshName = NULL,
 256                   bool theAutoGroups = true) throw(SALOME_Exception);
 257
 258   double GetComputeProgress() const;
 259
 260   int NbNodes() const throw(SALOME_Exception);
 261   int Nb0DElements() const throw(SALOME_Exception);
 262   int NbBalls() const throw(SALOME_Exception);
 263
 264   int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 265
 266   int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 267   int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 268   int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 269   int NbBiQuadQuadrangles() const throw(SALOME_Exception);
 270   int NbBiQuadTriangles() const throw(SALOME_Exception);
 271   int NbPolygons() const throw(SALOME_Exception);
 272
 273   int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 274   int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 275   int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 276   int NbTriQuadraticHexas() const throw(SALOME_Exception);
 277   int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 278   int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 279   int NbHexagonalPrisms() const throw(SALOME_Exception);
 280   int NbPolyhedrons() const throw(SALOME_Exception);
 281
 282   int NbSubMesh() const throw(SALOME_Exception);
 283
 284   int NbGroup() const { return _mapGroup.size(); }
 285
 286   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
 287                          const char*               theName,
 288                          int&                      theId,
 289                          const TopoDS_Shape&       theShape=TopoDS_Shape(),
 290                          const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
 291
 292   SMESH_Group* AddGroup (SMESHDS_GroupBase* groupDS) throw(SALOME_Exception);
 293
 294   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
 295   GroupIteratorPtr GetGroups() const;
 296
 297   std::list<int> GetGroupIds() const;
 298
 299   SMESH_Group* GetGroup (const int theGroupID);
 300
 301   bool RemoveGroup (const int theGroupID);
 302
 303   SMESH_Group* ConvertToStandalone ( int theGroupID );
 304
 305   struct TCallUp // callback from SMESH to SMESH_I level
 306   {
 307     virtual void RemoveGroup (const int theGroupID)=0;
 308     virtual void HypothesisModified ()=0;
 309     virtual void Load ()=0;
 310     virtual ~TCallUp() {}
 311   };
 312   void SetCallUp( TCallUp * upCaller );
 313
 314   bool SynchronizeGroups();
 315
 316
 317   SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
 318
 319   void ClearMeshOrder();
 320   void SetMeshOrder(const TListOfListOfInt& theOrder );
 321   const TListOfListOfInt& GetMeshOrder() const;
 322
 323   // sort submeshes according to stored mesh order
 324   bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
 325
 326   // return true if given order of sub-meshes is OK
 327   bool IsOrderOK( const SMESH_subMesh* smBefore,
 328                   const SMESH_subMesh* smAfter ) const;
 329
 330   ostream& Dump(ostream & save);
 331
 332 private:
 333
 334   void fillAncestorsMap(const TopoDS_Shape& theShape);
 335   std::list<SMESH_subMesh*> getAncestorsSubMeshes
 336     (const TopoDS_Shape& theSubShape) const;
 337
 338 protected:
 339   int                        _id;           // id given by creator (unique within the creator instance)
 340   int                        _studyId;
 341   int                        _groupId;      // id generator for group objects
 342   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 343   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 344   std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
 345   SMESHDS_Document *         _myDocument;
 346   SMESHDS_Mesh *             _myMeshDS;
 347   SMESH_Gen *                _gen;
 348   std::map <int, SMESH_subMesh*> _mapSubMesh;
 349   std::map <int, SMESH_Group*>   _mapGroup;
 350
 351   bool                       _isAutoColor;
 352   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 353
 354   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 355
 356   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 357
 358   TListOfListOfInt           _mySubMeshOrder;
 359
 360   // Struct calling methods at CORBA API implementation level, used to
 361   // 1) make an upper level be consistent with a lower one when group removal
 362   // is invoked by hyp modification (issue 0020918)
 363   // 2) to forget not loaded mesh data at hyp modification
 364   TCallUp*                    _callUp;
 365
 366 protected:
 367   SMESH_Mesh();
 368   SMESH_Mesh(const SMESH_Mesh&) {};
 369 };
 370
 371 #endif