TanhAndConstant.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//        - Harikeshava RANGANATHAN     IRCER, Limoges France/IMERYS, Lyon France
//                  <harikeshava.ranganathan@unilim.fr>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
// Copyright (C) 2023 H. RANGANATHAN
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
 
 
#ifndef _GranOO_Math_Function_TanhAnd_Constanthpp_
#define _GranOO_Math_Function_TanhAnd_Constanthpp_
 
#include "GranOO3/Math/FunctionT.hpp"
 
namespace GranOO3
{
  namespace Math
  {
    //---------------------------------------------------//
    // TanhAndConstant: f(x) = (e^x - e^-x)/(e^x + e^-x)//
    //---------------------------------------------------//
 
    class TanhAndConstant : public FunctionT<TanhAndConstant>
    {
    public:
      static std::string class_ID() {return "TanhAndConstant";}
 
      TanhAndConstant();
      TanhAndConstant(const std::string& symbol, const std::string desc = "");
      TanhAndConstant(const double& x, double lim, double cst, double cst1);
      ~TanhAndConstant();
 
      double operator()();
      double operator()(const double& x, const double& lim, const double& cst, const double& cst1);
 
    private:
      TanhAndConstant(const TanhAndConstant&)            = delete;
      TanhAndConstant& operator=(const TanhAndConstant&) = delete;
 
    private:
      const double* _x;
      double _lim;
      double _cst;
      double _cst1;
 
    };
  }
}
#endif