SineRamp.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>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// 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_SineRamp_hpp_
#define _GranOO_Math_Function_SineRamp_hpp_
 
#include "GranOO3/Math/FunctionT.hpp"
 
namespace GranOO3
{
  namespace Math
  {
    //------------------------------------------------------------------------------------------------//
    // SineRamp: f(x) = sin((x*M_PI)/duration-M_PI_2/2)*(final-initial)/2.0+(initial+final)/2.0       //
    //------------------------------------------------------------------------------------------------//
 
    /*
  max| - - - - - - - . . . . . . . . . . . . .
     |           .     |
     |         .
     |      .          |
  min|. . ____________________________________
                    duration        x (-> Inf)
     */
 
    class SineRamp : public FunctionT<SineRamp>
    {
    public:
      static std::string class_ID() {return "SineRamp";}
 
      SineRamp();
      SineRamp(const std::string &symbol, const std::string desc = "");
      SineRamp(const double &x, double initial, double final, double duration, double constant);
      ~SineRamp();
 
      double operator()();
      double operator()(const double &x, const double &initial, const double &final, const double &duration, const double &constant);
 
    private:
      SineRamp(const SineRamp &)             = delete;
      SineRamp & operator=(const SineRamp &) = delete;
 
    private:
      const double *_x;
      double _initial;
      double _final;
      double _duration;
      double _constant;
    };
  }
}
#endif