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