src/StdMeshers/StdMeshers_NumberOfSegments.hxx

   1 // Copyright (C) 2007-2022  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_NumberOfSegments.hxx
  25 //           Moved here from SMESH_NumberOfSegments.hxx
  26 //  Author : Paul RASCLE, EDF
  27 //  Module : SMESH
  28 //
  29 #ifndef _SMESH_NUMBEROFSEGMENTS_HXX_
  30 #define _SMESH_NUMBEROFSEGMENTS_HXX_
  31
  32 #include "StdMeshers_Reversible1D.hxx"
  33 #include "SMESH_Hypothesis.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 #include <smIdType.hxx>
  37
  38 #include <vector>
  39
  40 /*!
  41  * \brief This class represents hypothesis for 1d algorithm
  42  *
  43  * It provides parameters for subdivision an edge by various
  44  * distribution types, considering the given number of resulting segments
  45  */
  46 class STDMESHERS_EXPORT StdMeshers_NumberOfSegments: public StdMeshers_Reversible1D
  47 {
  48 public:
  49   StdMeshers_NumberOfSegments(int hypId, SMESH_Gen* gen);
  50   virtual ~StdMeshers_NumberOfSegments();
  51
  52   // Builds point distribution according to passed function
  53   const std::vector<double>& BuildDistributionExpr( const char*, int, int );
  54   const std::vector<double>& BuildDistributionTab( const std::vector<double>&, int, int );
  55
  56   /*!
  57    * \brief Set the number of segments
  58     * \param segmentsNumber - must be greater than zero
  59    */
  60   void SetNumberOfSegments(smIdType segmentsNumber);
  61
  62   /*!
  63    * \brief Get the number of segments
  64    */
  65   smIdType GetNumberOfSegments() const;
  66
  67   /*!
  68    * \brief This enumeration presents available types of distribution
  69    */
  70   enum DistrType
  71   {
  72     DT_Regular, //!< equidistant distribution
  73     DT_Scale,   //!< scale distribution
  74     DT_TabFunc, //!< distribution with density function presented by table
  75     DT_ExprFunc //!< distribution with density function presented by expression
  76   };
  77
  78   /*!
  79    * \brief Set distribution type
  80    */
  81   void SetDistrType(DistrType typ);
  82
  83   /*!
  84    * \brief Get distribution type
  85    */
  86   DistrType GetDistrType() const;
  87
  88   /*!
  89    * \brief Set scale factor for scale distribution
  90    * \param scaleFactor - positive value different from 1
  91    *
  92    * Throws SALOME_Exception if distribution type is not DT_Scale,
  93    * or scaleFactor is not a positive value different from 1
  94    */
  95   virtual void SetScaleFactor(double scaleFactor);
  96
  97   /*!
  98    * \brief Get scale factor for scale distribution
  99    *
 100    * Throws SALOME_Exception if distribution type is not DT_Scale
 101    */
 102   double GetScaleFactor() const;
 103
 104   /*!
 105    * \brief Set table function for distribution DT_TabFunc
 106     * \param table - this vector contains the pairs (parameter, value)
 107    * following each by other, so the number of elements in the vector
 108    * must be even. The parameters must be in range [0,1] and sorted in
 109    * increase order. The values of function must be positive.
 110    *
 111    * Throws SALOME_Exception if distribution type is not DT_TabFunc
 112    */
 113   void SetTableFunction(const std::vector<double>& table);
 114
 115   /*!
 116    * \brief Get table function for distribution DT_TabFunc
 117    *
 118    * Throws SALOME_Exception if distribution type is not DT_TabFunc
 119    */
 120   const std::vector<double>& GetTableFunction() const;
 121
 122   /*!
 123    * \brief Set expression function for distribution DT_ExprFunc
 124     * \param expr - string containing the expression of the function
 125     *               f(t), e.g. "sin(t)"
 126    *
 127    * Throws SALOME_Exception if distribution type is not DT_ExprFunc
 128    */
 129   void SetExpressionFunction( const char* expr);
 130
 131   /*!
 132    * \brief Get expression function for distribution DT_ExprFunc
 133    *
 134    * Throws SALOME_Exception if distribution type is not DT_ExprFunc
 135    */
 136   const char* GetExpressionFunction() const;
 137
 138   /*!
 139    * \brief Checks validity of  the expression of the function f(t), e.g. "sin(t)".
 140    *        In case of validity returns a cleaned expression
 141    *  \param convMode - 0 for "Exponent mode", 1 for "Cut negative mode"
 142    */
 143   static std::string CheckExpressionFunction( const std::string& expr,
 144                                               const int          convMode);
 145
 146   /*!
 147    * \brief Set conversion mode. When it is 0, it means "exponent mode":
 148    * the function of distribution of density is used as an exponent of 10, i,e, 10^f(t).
 149    * When it is 1, it means "cut negative mode". The function of distribution is used as
 150    * F(t), where F(t0)=f(t0), if f(t0)>=0, otherwise F(t0) = 0.
 151    * This mode is sensible only when function distribution is used (DT_TabFunc or DT_ExprFunc)
 152    *
 153    * Throws SALOME_Exception if distribution type is not functional
 154    */
 155   void SetConversionMode( int conv );
 156
 157   /*!
 158    * \brief Returns conversion mode
 159    *
 160    * Throws SALOME_Exception if distribution type is not functional
 161    */
 162   int ConversionMode() const;
 163
 164   /*!
 165    * \brief Initialize number of segments by the mesh built on the geometry
 166    * \param theMesh - the built mesh
 167    * \param theShape - the geometry of interest
 168    * \retval bool - true if parameter values have been successfully defined
 169    */
 170   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 171
 172   /*!
 173    * \brief Initialize my parameter values by default parameters.
 174    *  \retval bool - true if parameter values have been successfully defined
 175    */
 176   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 177
 178   virtual std::ostream & SaveTo(std::ostream & save);
 179   virtual std::istream & LoadFrom(std::istream & load);
 180   friend std::ostream& operator << (std::ostream & save, StdMeshers_NumberOfSegments & hyp);
 181   friend std::istream& operator >> (std::istream & load, StdMeshers_NumberOfSegments & hyp);
 182
 183 protected:
 184   smIdType            _numberOfSegments; //!< an edge will be split on to this number of segments
 185   DistrType           _distrType;        //!< the type of distribution of density function
 186   double              _scaleFactor;      //!< the scale parameter for DT_Scale
 187   std::vector<double> _table, _distr;    //!< the table for DT_TabFunc, a sequence of pairs of numbers
 188   std::string         _func;             //!< the expression of the function for DT_ExprFunc
 189   int                 _convMode;         //!< flag of conversion mode: 0=exponent, 1=cut negative
 190 };
 191
 192 #endif