src/SMESH/SMESH_Mesh.hxx

   1 // Copyright (C) 2007-2011  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 //  SMESH SMESH : implementaion of SMESH idl descriptions
  24 //  File   : SMESH_Mesh.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_MESH_HXX_
  29 #define _SMESH_MESH_HXX_
  30
  31 #include "SMESH_SMESH.hxx"
  32
  33 #include "SMESH_Hypothesis.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 Remove all nodes and elements
 102    */
 103   void Clear();
 104
 105   /*!
 106    * \brief Remove all nodes and elements of indicated shape
 107    */
 108   void ClearSubMesh(const int theShapeId);
 109
 110   int UNVToMesh(const char* theFileName);
 111   /*!
 112    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 113    */
 114   int MEDToMesh(const char* theFileName, const char* theMeshName);
 115
 116   int STLToMesh(const char* theFileName);
 117
 118   SMESH_Hypothesis::Hypothesis_Status
 119   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
 120     throw(SALOME_Exception);
 121
 122   SMESH_Hypothesis::Hypothesis_Status
 123   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
 124     throw(SALOME_Exception);
 125
 126   const std::list <const SMESHDS_Hypothesis * >&
 127   GetHypothesisList(const TopoDS_Shape & aSubShape) const
 128     throw(SALOME_Exception);
 129
 130   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
 131                                          const SMESH_HypoFilter& aFilter,
 132                                          const bool              andAncestors,
 133                                          TopoDS_Shape*           assignedTo=0) const;
 134
 135   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
 136                     const SMESH_HypoFilter&                  aFilter,
 137                     std::list <const SMESHDS_Hypothesis * >& aHypList,
 138                     const bool                               andAncestors) const;
 139
 140   const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
 141
 142   void ClearLog() throw(SALOME_Exception);
 143
 144   int GetId() const          { return _id; }
 145
 146   SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
 147
 148   const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
 149
 150   SMESH_Gen *GetGen()        { return _gen; }
 151
 152   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
 153     throw(SALOME_Exception);
 154
 155   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
 156     throw(SALOME_Exception);
 157
 158   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
 159     throw(SALOME_Exception);
 160   /*!
 161    * \brief Return submeshes of groups containing the given subshape
 162    */
 163   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
 164     throw(SALOME_Exception);
 165   /*!
 166    * \brief Say all submeshes that theChangedHyp has been modified
 167    */
 168   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
 169
 170   const std::list < SMESH_subMesh * >&
 171   GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
 172   /*!
 173    * \brief Return True if anHyp is used to mesh aSubShape
 174    */
 175   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
 176                         const SMESH_subMesh * aSubMesh);
 177   /*!
 178    * \brief check if a hypothesis alowing notconform mesh is present
 179    */
 180   bool IsNotConformAllowed() const;
 181
 182   bool IsMainShape(const TopoDS_Shape& theShape) const;
 183   /*!
 184    * \brief Return list of ancestors of theSubShape in the order
 185    *        that lower dimention shapes come first
 186    */
 187   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
 188
 189   void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
 190
 191   bool GetAutoColor() throw(SALOME_Exception);
 192
 193   /*!
 194    * \brief Set the flag meaning that the mesh has been edited "manually".
 195    * It is to set to false after Clear() and to set to true by MeshEditor
 196    */
 197   void SetIsModified(bool isModified);
 198
 199   bool GetIsModified() const { return _isModified; }
 200
 201   /*!
 202    * \brief Return true if the mesh has been edited since a total re-compute
 203    *        and those modifications may prevent successful partial re-compute.
 204    *        As a side effect reset _isModified flag if mesh is empty
 205    */
 206   bool HasModificationsToDiscard() const;
 207
 208   /*!
 209    * \brief Return data map of descendant to ancestor shapes
 210    */
 211   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
 212   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
 213   /*!
 214    * \brief Check group names for duplications.
 215    *  Consider maximum group name length stored in MED file
 216    */
 217   bool HasDuplicatedGroupNamesMED();
 218
 219   void ExportMED(const char *file,
 220                  const char* theMeshName = NULL,
 221                  bool theAutoGroups = true,
 222                  int theVersion = 0)
 223     throw(SALOME_Exception);
 224
 225   void ExportDAT(const char *file) throw(SALOME_Exception);
 226   void ExportUNV(const char *file) throw(SALOME_Exception);
 227   void ExportSTL(const char *file, const bool isascii) throw(SALOME_Exception);
 228
 229   int NbNodes() const throw(SALOME_Exception);
 230
 231   int Nb0DElements() const throw(SALOME_Exception);
 232
 233   int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 234
 235   int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 236
 237   int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 238
 239   int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 240
 241   int NbPolygons() const throw(SALOME_Exception);
 242
 243   int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 244
 245   int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 246
 247   int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 248
 249   int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 250
 251   int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 252
 253   int NbPolyhedrons() const throw(SALOME_Exception);
 254
 255   int NbSubMesh() const throw(SALOME_Exception);
 256
 257   int NbGroup() const { return _mapGroup.size(); }
 258
 259   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
 260                          const char*               theName,
 261                          int&                      theId,
 262                          const TopoDS_Shape&       theShape=TopoDS_Shape());
 263
 264   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
 265   GroupIteratorPtr GetGroups() const;
 266
 267   std::list<int> GetGroupIds() const;
 268
 269   SMESH_Group* GetGroup (const int theGroupID);
 270
 271   bool RemoveGroup (const int theGroupID);
 272
 273   SMESH_Group* ConvertToStandalone ( int theGroupID );
 274
 275   struct TRmGroupCallUp
 276   {
 277     virtual void RemoveGroup (const int theGroupID)=0;
 278     virtual ~TRmGroupCallUp() {}
 279   };
 280   void SetRemoveGroupCallUp( TRmGroupCallUp * upCaller );
 281
 282
 283   SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
 284
 285   void ClearMeshOrder();
 286   void SetMeshOrder(const TListOfListOfInt& theOrder );
 287   const TListOfListOfInt& GetMeshOrder() const;
 288
 289   /*!
 290    * \brief sort submeshes according to stored mesh order
 291    * \param theListToSort in out list to be sorted
 292    * \return FALSE if nothing sorted
 293    */
 294   bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
 295
 296   //
 297
 298   ostream& Dump(ostream & save);
 299
 300 private:
 301
 302   void fillAncestorsMap(const TopoDS_Shape& theShape);
 303   std::list<SMESH_subMesh*> getAncestorsSubMeshes
 304     (const TopoDS_Shape& theSubShape) const;
 305
 306 protected:
 307   int                        _id;           // id given by creator (unique within the creator instance)
 308   int                        _studyId;
 309   int                        _idDoc;        // id given by SMESHDS_Document
 310   int                        _groupId;      // id generator for group objects
 311   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 312   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 313   std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
 314   SMESHDS_Document *         _myDocument;
 315   SMESHDS_Mesh *             _myMeshDS;
 316   SMESH_Gen *                _gen;
 317   std::map <int, SMESH_subMesh*> _mapSubMesh;
 318   std::map <int, SMESH_Group*>   _mapGroup;
 319
 320   bool                       _isAutoColor;
 321   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 322
 323   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 324
 325   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 326
 327   TListOfListOfInt           _mySubMeshOrder;
 328
 329   // Struct calling RemoveGroup at CORBA API implementation level, used
 330   // to make an upper level be consistent with a lower one when group removal
 331   // is invoked by hyp modification
 332   TRmGroupCallUp*            _rmGroupCallUp;
 333
 334 protected:
 335   SMESH_Mesh();
 336   SMESH_Mesh(const SMESH_Mesh&) {};
 337 };
 338
 339 #endif