src/SMESH/SMESH_Mesh.hxx

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