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