src/SMESH/SMESH_Mesh.hxx

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