src/SMESH/SMESH_subMesh.hxx

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