damping_functions.h

/* Copyright (C) 2004-2012 MBSim Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Contact: martin.o.foerg@googlemail.com
 */
 
#ifndef NUMERICS_DAMPINGFUNCITONS_H_
#define NUMERICS_DAMPINGFUNCITONS_H_
 
#include <mbsim/numerics/functions/criteria_functions.h>
 
namespace MBSim {
 
  class DampingFunction : public Function<double(fmatvec::Vec,fmatvec::Vec)> {
    public:
    DampingFunction();
 
    /*
     * \brief destructor
     */
    ~DampingFunction() override = default;
 
    /* GETTER / SETTER*/
    void setFunction(Function<fmatvec::Vec(fmatvec::Vec)> * function_) {
      function = function_;
    }
    void setCriteriaFunction(CriteriaFunction * criteria_) {
      criteria = criteria_;
    }
    /******************/
 
    double operator ()(const fmatvec::Vec & x, const fmatvec::Vec & dx) override = 0;
 
    protected:
    Function<fmatvec::Vec(fmatvec::Vec)> *function{nullptr};
 
    CriteriaFunction * criteria{nullptr};
 
  };
 
  class StandardDampingFunction : public DampingFunction {
 
    public:
      StandardDampingFunction(unsigned int kmax_ = 10, double d_ = 0.5);
 
      /*
       * \brief destructor
       */
      ~StandardDampingFunction() override = default;
 
      double operator ()(const fmatvec::Vec &x, const fmatvec::Vec &dx) override;
 
      void setMaximalDampingSteps(unsigned int k_) {
        kmax = k_;
      }
 
      void setDampingNumber(double d_) {
        d = d_;
      }
 
    protected:
      unsigned int kmax;
 
      double d;
  };
}
#endif //NUMERICS_DAMPINGFUNCITONS_H_