src/SMESH/SMESH_Mesh.hxx

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