src/StdMeshers/StdMeshers_NumberOfSegments.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : StdMeshers_NumberOfSegments.hxx
  25 //           Moved here from SMESH_NumberOfSegments.hxx
  26 //  Author : Paul RASCLE, EDF
  27 //  Module : SMESH
  28 //  $Header$
  29
  30 #ifndef _SMESH_NUMBEROFSEGMENTS_HXX_
  31 #define _SMESH_NUMBEROFSEGMENTS_HXX_
  32
  33 #include "SMESH_Hypothesis.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35 #include <vector>
  36
  37 /*!
  38  * \brief This class represents hypothesis for 1d algorithm
  39  *
  40  * It provides parameters for subdivision an edge by various
  41  * distribution types, considering the given number of resulting segments
  42  */
  43 class StdMeshers_NumberOfSegments:
  44   public SMESH_Hypothesis
  45 {
  46 public:
  47   StdMeshers_NumberOfSegments(int hypId, int studyId, SMESH_Gen* gen);
  48   virtual ~StdMeshers_NumberOfSegments();
  49
  50   // Builds point distribution according to passed function
  51   const std::vector<double>& BuildDistributionExpr( const char*, int, int ) throw ( SALOME_Exception );
  52   const std::vector<double>& BuildDistributionTab( const std::vector<double>&, int, int ) throw ( SALOME_Exception );
  53
  54   /*!
  55    * \brief Set the number of segments
  56     * \param segmentsNumber - must be greater than zero
  57    */
  58   void SetNumberOfSegments(int segmentsNumber)
  59     throw (SALOME_Exception);
  60
  61   /*!
  62    * \brief Get the number of segments
  63    */
  64   int GetNumberOfSegments() const;
  65
  66   /*!
  67    * \brief This enumeration presents available types of distribution
  68    */
  69   enum DistrType
  70   {
  71     DT_Regular, //!< equidistant distribution
  72     DT_Scale,   //!< scale distribution
  73     DT_TabFunc, //!< distribution with density function presented by table
  74     DT_ExprFunc //!< distribution with density function presented by expression
  75   };
  76
  77   /*!
  78    * \brief Set distribution type
  79    */
  80   void SetDistrType(DistrType typ)
  81     throw (SALOME_Exception);
  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     throw (SALOME_Exception);
  97
  98   /*!
  99    * \brief Get scale factor for scale distribution
 100    *
 101    * Throws SALOME_Exception if distribution type is not DT_Scale
 102    */
 103   double GetScaleFactor() const
 104     throw (SALOME_Exception);
 105
 106   /*!
 107    * \brief Set table function for distribution DT_TabFunc
 108     * \param table - this vector contains the pairs (parameter, value)
 109    * following each by other, so the number of elements in the vector
 110    * must be even. The parameters must be in range [0,1] and sorted in
 111    * increase order. The values of function must be positive.
 112    *
 113    * Throws SALOME_Exception if distribution type is not DT_TabFunc
 114    */
 115   void SetTableFunction(const std::vector<double>& table)
 116     throw (SALOME_Exception);
 117
 118   /*!
 119    * \brief Get table function for distribution DT_TabFunc
 120    *
 121    * Throws SALOME_Exception if distribution type is not DT_TabFunc
 122    */
 123   const std::vector<double>& GetTableFunction() const
 124     throw (SALOME_Exception);
 125
 126   /*!
 127    * \brief Set expression function for distribution DT_ExprFunc
 128     * \param expr - string containing the expression of the function
 129     *               f(t), e.g. "sin(t)"
 130    *
 131    * Throws SALOME_Exception if distribution type is not DT_ExprFunc
 132    */
 133   void SetExpressionFunction( const char* expr)
 134     throw (SALOME_Exception);
 135
 136   /*!
 137    * \brief Get expression function for distribution DT_ExprFunc
 138    *
 139    * Throws SALOME_Exception if distribution type is not DT_ExprFunc
 140    */
 141   const char* GetExpressionFunction() const
 142     throw (SALOME_Exception);
 143
 144   /*!
 145    * \brief Set conversion mode. When it is 0, it means "exponent mode":
 146    * the function of distribution of density is used as an exponent of 10, i,e, 10^f(t).
 147    * When it is 1, it means "cut negative mode". The function of distribution is used as
 148    * F(t), where F(t0)=f(t0), if f(t0)>=0, otherwise F(t0) = 0.
 149    * This mode is sensible only when function distribution is used (DT_TabFunc or DT_ExprFunc)
 150    *
 151    * Throws SALOME_Exception if distribution type is not functional
 152    */
 153   void SetConversionMode( int conv )
 154     throw (SALOME_Exception);
 155
 156   /*!
 157    * \brief Returns conversion mode
 158    *
 159    * Throws SALOME_Exception if distribution type is not functional
 160    */
 161   int ConversionMode() const
 162     throw (SALOME_Exception);
 163
 164   virtual ostream & SaveTo(ostream & save);
 165   virtual istream & LoadFrom(istream & load);
 166   friend ostream& operator << (ostream & save, StdMeshers_NumberOfSegments & hyp);
 167   friend istream& operator >> (istream & load, StdMeshers_NumberOfSegments & hyp);
 168
 169 protected:
 170   int                 _numberOfSegments; //!< an edge will be split on to this number of segments
 171   DistrType           _distrType;        //!< the type of distribution of density function
 172   double              _scaleFactor;      //!< the scale parameter for DT_Scale
 173   std::vector<double> _table, _distr;    //!< the table for DT_TabFunc, a sequence of pairs of numbers
 174   std::string         _func;             //!< the expression of the function for DT_ExprFunc
 175   int                 _convMode;         //!< flag of conversion mode: 0=exponent, 1=cut negative
 176 };
 177
 178 #endif