src/SMESH/SMESH_subMesh.hxx

   1 // Copyright (C) 2007-2021  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, or (at your option) any later version.
  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 //  File   : SMESH_subMesh.hxx
  24 //  Author : Paul RASCLE, EDF
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_SUBMESH_HXX_
  28 #define _SMESH_SUBMESH_HXX_
  29
  30 #include "SMESH_SMESH.hxx"
  31
  32 #include "SMDS_Iterator.hxx"
  33 #include "SMESH_ComputeError.hxx"
  34 #include "SMESH_Algo.hxx"
  35
  36 #include "Utils_SALOME_Exception.hxx"
  37
  38 #include <TopoDS_Shape.hxx>
  39 #include <TopTools_IndexedMapOfShape.hxx>
  40
  41 #include <list>
  42 #include <map>
  43
  44 class SMESHDS_Mesh;
  45 class SMESHDS_SubMesh;
  46 class SMESH_Algo;
  47 class SMESH_Gen;
  48 class SMESH_Hypothesis;
  49 class SMESH_Mesh;
  50 class SMESH_subMesh;
  51 class SMESH_subMeshEventListener;
  52 struct SMESH_subMeshEventListenerData;
  53
  54 typedef SMESH_subMeshEventListener     EventListener;
  55 typedef SMESH_subMeshEventListenerData EventListenerData;
  56
  57 typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
  58
  59
  60 class SMESH_EXPORT SMESH_subMesh
  61 {
  62  public:
  63   SMESH_subMesh(int                  Id,
  64                 SMESH_Mesh *         father,
  65                 SMESHDS_Mesh *       meshDS,
  66                 const TopoDS_Shape & aSubShape);
  67   virtual ~ SMESH_subMesh();
  68
  69   int GetId() const; // == meshDS->ShapeToIndex( aSubShape )
  70
  71   SMESH_Mesh* GetFather() { return _father; }
  72
  73   SMESHDS_SubMesh *       GetSubMeshDS();
  74   const SMESHDS_SubMesh * GetSubMeshDS() const;
  75
  76   SMESHDS_SubMesh* CreateSubMeshDS();
  77   // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
  78
  79   SMESH_subMesh *GetFirstToCompute();
  80
  81   SMESH_Algo* GetAlgo() const;
  82
  83   const std::map < int, SMESH_subMesh * >& DependsOn();
  84   bool DependsOn( const SMESH_subMesh* other ) const;
  85   bool DependsOn( const int shapeID ) const;
  86   /*!
  87    * \brief Return iterator on the sub-meshes this one depends on. By default
  88    *        most simple sub-meshes go first.
  89    */
  90   SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
  91                                                 const bool complexShapeFirst=false) const;
  92
  93   const std::vector< SMESH_subMesh * > & GetAncestors() const;
  94   void ClearAncestors();
  95
  96   const TopoDS_Shape & GetSubShape() const;
  97
  98   enum compute_state
  99   {
 100     NOT_READY, READY_TO_COMPUTE, COMPUTE_OK, FAILED_TO_COMPUTE
 101   };
 102   enum algo_state
 103   {
 104     NO_ALGO, MISSING_HYP, HYP_OK
 105   };
 106   enum algo_event
 107   {
 108     ADD_HYP          , ADD_ALGO,
 109     REMOVE_HYP       , REMOVE_ALGO,
 110     ADD_FATHER_HYP   , ADD_FATHER_ALGO,
 111     REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
 112     MODIF_HYP
 113   };
 114   enum compute_event
 115   {
 116     MODIF_ALGO_STATE, COMPUTE, COMPUTE_SUBMESH, COMPUTE_NOGEOM, COMPUTE_CANCELED,
 117     CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED, SUBMESH_LOADED,
 118     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
 119   };
 120   enum event_type
 121   {
 122     ALGO_EVENT, COMPUTE_EVENT
 123   };
 124
 125   // ==================================================================
 126   // Members to track non hierarchical dependencies between sub-meshes
 127   // ==================================================================
 128
 129   /*!
 130    * \brief Set an event listener and its data to a submesh
 131     * \param listener - the listener to store
 132     * \param data - the listener data to store
 133     * \param where - the submesh to store the listener and it's data
 134    *
 135    * The method remembers the submesh \awhere it puts the listener in order to delete
 136    * it when HYP_OK algo_state is lost
 137    * After being set, event listener is notified on each event of \awhere submesh.
 138    */
 139   void SetEventListener(EventListener*     listener,
 140                         EventListenerData* data,
 141                         SMESH_subMesh*     where);
 142
 143   /*!
 144    * \brief Return an event listener data
 145     * \param listener - the listener whose data is
 146     * \param myOwn - if \c true, returns a listener set by this sub-mesh,
 147     *        else returns a listener listening to events of this sub-mesh
 148     * \retval EventListenerData* - found data, maybe NULL
 149    */
 150   EventListenerData* GetEventListenerData(EventListener* listener,
 151                                           const bool     myOwn=false) const;
 152
 153   /*!
 154    * \brief Return an event listener data
 155     * \param listenerName - the listener name
 156     * \param myOwn - if \c true, returns a listener set by this sub-mesh,
 157     *        else returns a listener listening to events of this sub-mesh
 158     * \retval EventListenerData* - found data, maybe NULL
 159    */
 160   EventListenerData* GetEventListenerData(const std::string& listenerName,
 161                                           const bool         myOwn=false) const;
 162
 163   /*!
 164    * \brief Unregister the listener and delete it and it's data
 165     * \param listener - the event listener to delete
 166    */
 167   void DeleteEventListener(EventListener* listener);
 168
 169 protected:
 170
 171   //!< event listeners to notify
 172   std::map< EventListener*, EventListenerData* > _eventListeners;
 173
 174   //!< event listeners to delete when HYP_OK algo_state is lost
 175   struct OwnListenerData {
 176     SMESH_subMesh* mySubMesh;
 177     int            myMeshID; // id of mySubMesh->GetFather()
 178     int            mySubMeshID;
 179     EventListener* myListener;
 180     OwnListenerData( SMESH_subMesh* sm=0, EventListener* el=0);
 181   };
 182   std::list< OwnListenerData >                    _ownListeners;
 183
 184   /*!
 185    * \brief Sets an event listener and its data to a submesh
 186     * \param listener - the listener to store
 187     * \param data - the listener data to store
 188    *
 189    * After being set, event listener is notified on each event of a submesh.
 190    */
 191   void setEventListener(EventListener* listener, EventListenerData* data);
 192
 193   /*!
 194    * \brief Notify stored event listeners on the occurred event
 195    * \param event - algo_event or compute_event itself
 196    * \param eventType - algo_event or compute_event
 197    * \param hyp - hypothesis, if eventType is algo_event
 198    */
 199   void notifyListenersOnEvent( const int         event,
 200                                const event_type  eventType,
 201                                SMESH_Hypothesis* hyp = 0);
 202
 203   /*!
 204    * \brief Delete event listeners depending on algo of this submesh
 205    */
 206   void deleteOwnListeners();
 207
 208   /*!
 209    * \brief loads dependent meshes on SUBMESH_LOADED event
 210    */
 211   void loadDependentMeshes();
 212
 213   // END: Members to track non hierarchical dependencies between submeshes
 214   // =====================================================================
 215
 216 public:
 217
 218   SMESH_Hypothesis::Hypothesis_Status
 219     AlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp);
 220
 221   SMESH_Hypothesis::Hypothesis_Status
 222     SubMeshesAlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp, bool exitOnFatal=false);
 223
 224   algo_state             GetAlgoState() const    { return _algoState; }
 225   compute_state          GetComputeState() const { return _computeState; }
 226   SMESH_ComputeErrorPtr& GetComputeError()       { return _computeError; }
 227
 228   void DumpAlgoState(bool isMain);
 229
 230   bool ComputeStateEngine(compute_event event);
 231   void ComputeSubMeshStateEngine(compute_event event, const bool includeSelf=false);
 232
 233   bool Evaluate(MapShapeNbElems& aResMap);
 234
 235   bool IsConform(const SMESH_Algo* theAlgo);
 236   // check if a conform mesh will be produced by the Algo
 237
 238   bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
 239   // return true if theHypothesis can be attached to me:
 240   // its dimension is checked
 241
 242   static bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis,
 243                                     const TopAbs_ShapeEnum  theShapeType);
 244
 245   bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis) const;
 246   // return true if theHypothesis can be used to mesh me:
 247   // its shape type is checked
 248
 249   SMESH_Hypothesis::Hypothesis_Status CheckConcurrentHypothesis (const int theHypType);
 250   // check if there are several applicable hypothesis on fathers
 251
 252   /*!
 253    * \brief Return true if no mesh entities is bound to the submesh
 254    */
 255   bool IsEmpty() const;
 256
 257   bool IsMeshComputed() const;
 258   // check if _subMeshDS contains mesh elements unless _alwaysComputed==true
 259
 260   bool IsComputedPartially() const;
 261   // check if any upper level sub-shape is not computed
 262
 263   /*!
 264    * \brief Set sub-shapes that are allowed to compute at once by a multidimensional algo
 265    */
 266   void SetAllowedSubShapes( const TopTools_IndexedMapOfShape* subShapes )
 267   { _allowedSubShapes = subShapes; }
 268
 269   /*!
 270    * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
 271    *        none mesh entity is bound to it
 272    */
 273   void SetIsAlwaysComputed(bool isAlCo);
 274   bool IsAlwaysComputed() const { return _alwaysComputed; }
 275
 276   bool SubMeshesComputed(bool * isFailedToCompute=0) const;
 277
 278   int GetComputeCost() const;
 279   // how costly is to compute this sub-mesh
 280
 281   /*!
 282    * \brief  Find common submeshes (based on shared subshapes with other
 283    * \param theOther submesh to check
 284    * \param theCommonIds set of common submesh IDs
 285    * NOTE: this method does not cleat set before collect common IDs
 286    */
 287   bool FindIntersection( const SMESH_subMesh *           theOther,
 288                          std::set<const SMESH_subMesh*>& theSetOfCommon ) const;
 289
 290 protected:
 291   // ==================================================================
 292   void insertDependence(const TopoDS_Shape aShape,
 293                         TopAbs_ShapeEnum   aSubType,
 294                         TopAbs_ShapeEnum   avoidType=TopAbs_SHAPE);
 295
 296   void removeSubMeshElementsAndNodes();
 297   void updateDependantsState(const compute_event theEvent);
 298   void updateSubMeshState(const compute_state theState);
 299   void cleanDependants();
 300   void cleanDependsOn( SMESH_Algo* algoRequiringCleaning=0 );
 301   void setAlgoState(algo_state state);
 302
 303   /*!
 304    * \brief Return a shape containing all sub-shapes of the MainShape that can be
 305    * meshed at once along with _subShape
 306    */
 307   TopoDS_Shape getCollection(SMESH_Gen * theGen,
 308                              SMESH_Algo* theAlgo,
 309                              bool &      theSubComputed,
 310                              bool &      theSubFailed,
 311                              std::vector<SMESH_subMesh*>& theSubs);
 312   /*!
 313    * \brief Update compute_state by _computeError
 314     * \retval bool - false if there are errors
 315    */
 316   bool checkComputeError(SMESH_Algo*         theAlgo,
 317                          const bool          theComputeOK,
 318                          const TopoDS_Shape& theShape=TopoDS_Shape());
 319
 320   /*!
 321    * \brief Return a hypothesis attached to theShape.
 322    *
 323    * If theHyp is provided, similar but not same hypotheses
 324    * is returned; else an applicable ones having theHypType
 325    * is returned
 326    */
 327   const SMESH_Hypothesis* getSimilarAttached(const TopoDS_Shape&      theShape,
 328                                              const SMESH_Hypothesis * theHyp,
 329                                              const int                theHypType = 0);
 330   //
 331   int computeCost() const;
 332
 333 protected:
 334
 335   TopoDS_Shape          _subShape;
 336   SMESHDS_SubMesh *     _subMeshDS;
 337   SMESH_Mesh *          _father;
 338   int                   _Id;
 339
 340   std::map < int, SMESH_subMesh * >_mapDepend;
 341   bool                             _dependenceAnalysed;
 342   std::vector< SMESH_subMesh * >   _ancestors;
 343
 344   SMESH_Algo *          _algo; // the algorithm found by last *StateEngine() call
 345   TopoDS_Shape          _algoShape; // shape the algorithm is assigned to
 346   algo_state            _algoState;
 347   compute_state         _computeState;
 348   SMESH_ComputeErrorPtr _computeError;
 349   int                   _computeCost;     // how costly is to compute this sub-mesh
 350   int                   _realComputeCost; // _computeCost depending on presence of needed hypotheses
 351
 352   // allow algo->Compute() if a sub-shape of lower dim is meshed but
 353   // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
 354   // mesh several edges as a whole and leave some of them  without mesh entities
 355   bool                  _alwaysComputed;
 356
 357   const TopTools_IndexedMapOfShape* _allowedSubShapes; // allowed to be returned by getCollection()
 358
 359 };
 360
 361 #endif