src/SMESH/SMESH_Mesh.hxx

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