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