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   /*!
 112    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 113    */
 114   int UNVToMesh(const char* theFileName);
 115
 116   int MEDToMesh(const char* theFileName, const char* theMeshName);
 117
 118   int STLToMesh(const char* theFileName);
 119
 120   int CGNSToMesh(const char* theFileName, const int theMeshIndex, std::string& theMeshName);
 121
 122   SMESH_Hypothesis::Hypothesis_Status
 123   AddHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
 124     throw(SALOME_Exception);
 125
 126   SMESH_Hypothesis::Hypothesis_Status
 127   RemoveHypothesis(const TopoDS_Shape & aSubShape, int anHypId)
 128     throw(SALOME_Exception);
 129
 130   const std::list <const SMESHDS_Hypothesis * >&
 131   GetHypothesisList(const TopoDS_Shape & aSubShape) const
 132     throw(SALOME_Exception);
 133
 134   const SMESH_Hypothesis * GetHypothesis(const TopoDS_Shape &    aSubShape,
 135                                          const SMESH_HypoFilter& aFilter,
 136                                          const bool              andAncestors,
 137                                          TopoDS_Shape*           assignedTo=0) const;
 138
 139   int GetHypotheses(const TopoDS_Shape &                     aSubShape,
 140                     const SMESH_HypoFilter&                  aFilter,
 141                     std::list <const SMESHDS_Hypothesis * >& aHypList,
 142                     const bool                               andAncestors) const;
 143
 144   const std::list<SMESHDS_Command*> & GetLog() throw(SALOME_Exception);
 145
 146   void ClearLog() throw(SALOME_Exception);
 147
 148   int GetId() const          { return _id; }
 149
 150   bool MeshExists( int meshId ) const;
 151
 152   SMESHDS_Mesh * GetMeshDS() { return _myMeshDS; }
 153
 154   const SMESHDS_Mesh * GetMeshDS() const { return _myMeshDS; }
 155
 156   SMESH_Gen *GetGen()        { return _gen; }
 157
 158   SMESH_subMesh *GetSubMesh(const TopoDS_Shape & aSubShape)
 159     throw(SALOME_Exception);
 160
 161   SMESH_subMesh *GetSubMeshContaining(const TopoDS_Shape & aSubShape) const
 162     throw(SALOME_Exception);
 163
 164   SMESH_subMesh *GetSubMeshContaining(const int aShapeID) const
 165     throw(SALOME_Exception);
 166   /*!
 167    * \brief Return submeshes of groups containing the given subshape
 168    */
 169   std::list<SMESH_subMesh*> GetGroupSubMeshesContaining(const TopoDS_Shape & shape) const
 170     throw(SALOME_Exception);
 171   /*!
 172    * \brief Say all submeshes that theChangedHyp has been modified
 173    */
 174   void NotifySubMeshesHypothesisModification(const SMESH_Hypothesis* theChangedHyp);
 175
 176   const std::list < SMESH_subMesh * >&
 177   GetSubMeshUsingHypothesis(SMESHDS_Hypothesis * anHyp) throw(SALOME_Exception);
 178   /*!
 179    * \brief Return True if anHyp is used to mesh aSubShape
 180    */
 181   bool IsUsedHypothesis(SMESHDS_Hypothesis *  anHyp,
 182                         const SMESH_subMesh * aSubMesh);
 183   /*!
 184    * \brief check if a hypothesis alowing notconform mesh is present
 185    */
 186   bool IsNotConformAllowed() const;
 187
 188   bool IsMainShape(const TopoDS_Shape& theShape) const;
 189   /*!
 190    * \brief Return list of ancestors of theSubShape in the order
 191    *        that lower dimention shapes come first
 192    */
 193   const TopTools_ListOfShape& GetAncestors(const TopoDS_Shape& theSubShape) const;
 194
 195   void SetAutoColor(bool theAutoColor) throw(SALOME_Exception);
 196
 197   bool GetAutoColor() throw(SALOME_Exception);
 198
 199   /*!
 200    * \brief Set the flag meaning that the mesh has been edited "manually".
 201    * It is to set to false after Clear() and to set to true by MeshEditor
 202    */
 203   void SetIsModified(bool isModified);
 204
 205   bool GetIsModified() const { return _isModified; }
 206
 207   /*!
 208    * \brief Return true if the mesh has been edited since a total re-compute
 209    *        and those modifications may prevent successful partial re-compute.
 210    *        As a side effect reset _isModified flag if mesh is empty
 211    */
 212   bool HasModificationsToDiscard() const;
 213
 214   /*!
 215    * \brief Return data map of descendant to ancestor shapes
 216    */
 217   typedef TopTools_IndexedDataMapOfShapeListOfShape TAncestorMap;
 218   const TAncestorMap& GetAncestorMap() const { return _mapAncestors; }
 219   /*!
 220    * \brief Check group names for duplications.
 221    *  Consider maximum group name length stored in MED file
 222    */
 223   bool HasDuplicatedGroupNamesMED();
 224
 225   void ExportMED(const char *file,
 226                  const char* theMeshName = NULL,
 227                  bool theAutoGroups = true,
 228                  int theVersion = 0,
 229                  const SMESHDS_Mesh* meshPart = 0)
 230     throw(SALOME_Exception);
 231
 232   void ExportDAT(const char *        file,
 233                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 234   void ExportUNV(const char *        file,
 235                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 236   void ExportSTL(const char *        file,
 237                  const bool          isascii,
 238                  const SMESHDS_Mesh* meshPart = 0) throw(SALOME_Exception);
 239   void ExportCGNS(const char *        file,
 240                   const SMESHDS_Mesh* mesh);
 241   void ExportSAUV(const char *file,
 242                   const char* theMeshName = NULL,
 243                   bool theAutoGroups = true) throw(SALOME_Exception);
 244
 245   int NbNodes() const throw(SALOME_Exception);
 246
 247   int Nb0DElements() const throw(SALOME_Exception);
 248
 249   int NbEdges(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 250
 251   int NbFaces(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 252
 253   int NbTriangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 254
 255   int NbQuadrangles(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 256
 257   int NbBiQuadQuadrangles() const throw(SALOME_Exception);
 258
 259   int NbPolygons() const throw(SALOME_Exception);
 260
 261   int NbVolumes(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 262
 263   int NbTetras(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 264
 265   int NbHexas(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 266
 267   int NbTriQuadraticHexas() const throw(SALOME_Exception);
 268
 269   int NbPyramids(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 270
 271   int NbPrisms(SMDSAbs_ElementOrder order = ORDER_ANY) const throw(SALOME_Exception);
 272
 273   int NbHexagonalPrisms() const throw(SALOME_Exception);
 274
 275   int NbPolyhedrons() const throw(SALOME_Exception);
 276
 277   int NbSubMesh() const throw(SALOME_Exception);
 278
 279   int NbGroup() const { return _mapGroup.size(); }
 280
 281   SMESH_Group* AddGroup (const SMDSAbs_ElementType theType,
 282                          const char*               theName,
 283                          int&                      theId,
 284                          const TopoDS_Shape&       theShape=TopoDS_Shape(),
 285                          const SMESH_PredicatePtr& thePredicate=SMESH_PredicatePtr());
 286
 287   typedef boost::shared_ptr< SMDS_Iterator<SMESH_Group*> > GroupIteratorPtr;
 288   GroupIteratorPtr GetGroups() const;
 289
 290   std::list<int> GetGroupIds() const;
 291
 292   SMESH_Group* GetGroup (const int theGroupID);
 293
 294   bool RemoveGroup (const int theGroupID);
 295
 296   SMESH_Group* ConvertToStandalone ( int theGroupID );
 297
 298   struct TRmGroupCallUp
 299   {
 300     virtual void RemoveGroup (const int theGroupID)=0;
 301     virtual ~TRmGroupCallUp() {}
 302   };
 303   void SetRemoveGroupCallUp( TRmGroupCallUp * upCaller );
 304
 305   bool SynchronizeGroups();
 306
 307
 308   SMDSAbs_ElementType GetElementType( const int id, const bool iselem );
 309
 310   void ClearMeshOrder();
 311   void SetMeshOrder(const TListOfListOfInt& theOrder );
 312   const TListOfListOfInt& GetMeshOrder() const;
 313
 314   /*!
 315    * \brief sort submeshes according to stored mesh order
 316    * \param theListToSort in out list to be sorted
 317    * \return FALSE if nothing sorted
 318    */
 319   bool SortByMeshOrder(std::list<SMESH_subMesh*>& theListToSort) const;
 320
 321   //
 322
 323   ostream& Dump(ostream & save);
 324
 325 private:
 326
 327   void fillAncestorsMap(const TopoDS_Shape& theShape);
 328   std::list<SMESH_subMesh*> getAncestorsSubMeshes
 329     (const TopoDS_Shape& theSubShape) const;
 330
 331 protected:
 332   int                        _id;           // id given by creator (unique within the creator instance)
 333   int                        _studyId;
 334   int                        _idDoc;        // id given by SMESHDS_Document
 335   int                        _groupId;      // id generator for group objects
 336   int                        _nbSubShapes;  // initial nb of subshapes in the shape to mesh
 337   bool                       _isShapeToMesh;// set to true when a shape is given (only once)
 338   std::list <SMESH_subMesh*> _subMeshesUsingHypothesisList;
 339   SMESHDS_Document *         _myDocument;
 340   SMESHDS_Mesh *             _myMeshDS;
 341   SMESH_Gen *                _gen;
 342   std::map <int, SMESH_subMesh*> _mapSubMesh;
 343   std::map <int, SMESH_Group*>   _mapGroup;
 344
 345   bool                       _isAutoColor;
 346   bool                       _isModified; //!< modified since last total re-compute, issue 0020693
 347
 348   double                     _shapeDiagonal; //!< diagonal size of bounding box of shape to mesh
 349
 350   TopTools_IndexedDataMapOfShapeListOfShape _mapAncestors;
 351
 352   TListOfListOfInt           _mySubMeshOrder;
 353
 354   // Struct calling RemoveGroup at CORBA API implementation level, used
 355   // to make an upper level be consistent with a lower one when group removal
 356   // is invoked by hyp modification
 357   TRmGroupCallUp*            _rmGroupCallUp;
 358
 359 protected:
 360   SMESH_Mesh();
 361   SMESH_Mesh(const SMESH_Mesh&) {};
 362 };
 363
 364 #endif