Cycle.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_Cycle_hpp_
#define _GranOO_Math_Function_Cycle_hpp_
 
#include "GranOO3/Math/FunctionT.hpp"
 
namespace GranOO3
{
  namespace Math
  {
 
 
    /*
     |               .
     |              / \
peak |----.        /   \
     |   /.\      /     \
     |  / . \    /       \   
     | /  .  \  /         \ 
     |/_______\/___________\___________
         lim
     */
 
    class Cycle : public FunctionT<Cycle>
    {
    public:
      enum Mode { UP = 1, DOWN=-1};
      static std::string class_ID() {return "Cycle";}
 
      // Cycle();
      Cycle(unsigned int varNumber, const std::string& symbol, const std::string desc = "");
      Cycle(const double& x, double lim, double peak, double rate);
      ~Cycle();
 
      double operator()();
      double operator()(const double& x, const double& lim, const double& peak, const double& rate);
      double operator()(const double& x, const double& lim, const double& peak, const double& rate, const double& monitor);
      
    private:
      void swap_from_up2down(double x, double val);
      void swap_from_down2up(double x, double val);
      
    private:
      Cycle(const Cycle&)            = delete;
      Cycle& operator=(const Cycle&) = delete;
 
      
    private:
      const double* _x;
      double        _lim;
      double        _peak;
      double        _rate;
      double        _slope;
      double        _intercept;
      double        _xshift;
      Mode          _mode;
      unsigned int  _ncycle;
    };
  }
}
#endif