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