src/StdMeshers/StdMeshers_Propagation.hxx

   1 // Copyright (C) 2007-2019  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 //  SMESH SMESH : implementation of SMESH idl descriptions
  24 //  File   : StdMeshers_Propagation.hxx
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_PROPAGATION_HXX_
  28 #define _SMESH_PROPAGATION_HXX_
  29
  30 #include "SMESH_StdMeshers.hxx"
  31
  32 #include "SMESH_Hypothesis.hxx"
  33 #include "SMESH_subMeshEventListener.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 #include <TopoDS_Edge.hxx>
  37
  38 class SMESH_HypoFilter;
  39
  40 // =======================================================================
  41 /*!
  42  * \brief Propagation hypothesis
  43  */
  44 // =======================================================================
  45
  46 class STDMESHERS_EXPORT StdMeshers_Propagation : public SMESH_Hypothesis
  47 {
  48  public:
  49   StdMeshers_Propagation(int hypId, SMESH_Gen * gen);
  50   virtual ~ StdMeshers_Propagation();
  51
  52   virtual std::ostream & SaveTo(std::ostream & save);
  53   virtual std::istream & LoadFrom(std::istream & load);
  54
  55   static std::string GetName();
  56
  57   /*!
  58    * \brief Returns a filter selecting both StdMeshers_Propagation and
  59    *        StdMeshers_PropagOfDistribution hypotheses
  60    */
  61   static const SMESH_HypoFilter& GetFilter();
  62
  63   /*!
  64    * \brief Set EventListener managing propagation of hypotheses
  65     * \param subMesh - edge submesh to set event listener on
  66    *
  67    * 1D algo is expected to call this method from it's SetEventListener()
  68    */
  69   static void SetPropagationMgr(SMESH_subMesh* subMesh);
  70
  71   /*!
  72    * \brief Return an edge from which hypotheses are propagated
  73     * \param theMesh - mesh
  74     * \param theEdge - edge to which hypotheses are propagated
  75     * \retval TopoDS_Edge - source edge, also passing orientation
  76    */
  77   static TopoDS_Edge GetPropagationSource(SMESH_Mesh&         theMesh,
  78                                           const TopoDS_Shape& theEdge,
  79                                           bool&               isPropagOfDistribution );
  80
  81   /*!
  82    * \brief Initialize my parameter values by the mesh built on the geometry
  83     * \param theMesh - the built mesh
  84     * \param theShape - the geometry of interest
  85     * \retval bool - true if parameter values have been successfully defined
  86     *
  87     * Just return false as this hypothesis does not have parameters values
  88    */
  89   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  90
  91   /*!
  92    * \brief Initialize my parameter values by default parameters.
  93    *  \retval bool - true if parameter values have been successfully defined
  94    */
  95   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  96
  97 };
  98
  99 // =======================================================================
 100 /*!
 101  * \brief Propagation Of Distribution hypothesis
 102  */
 103 // =======================================================================
 104
 105 class STDMESHERS_EXPORT StdMeshers_PropagOfDistribution: public StdMeshers_Propagation
 106 {
 107  public:
 108   StdMeshers_PropagOfDistribution(int hypId, SMESH_Gen * gen);
 109
 110   static std::string GetName();
 111 };
 112
 113 #endif