constant_influence_function.h

/* Copyright (C) 2004-2009 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: markus.ms.schneider@gmail.com
 */
 
#ifndef _CONSTANT_INFLUENCE_FUNCTION_H_
#define _CONSTANT_INFLUENCE_FUNCTION_H_
 
#include "mbsim/functions/kinetics/influence_function.h"
 
namespace MBSim {
 
  /*
   * \brief a class for Influence-Functions with constant coupling
   */
  class ConstantInfluenceFunction : public InfluenceFunction {
    public:
      ConstantInfluenceFunction()  {
      }
      ConstantInfluenceFunction(const double & couplingValue_) :
          couplingValue(couplingValue_) {
      }
      ~ConstantInfluenceFunction() override = default;
      /* INHERITED INTERFACE OF FUNCTION2 */
      double operator()(const std::pair<Contour*, ContourFrame*>& firstContourInfo, const std::pair<Contour*, ContourFrame*>& secondContourInfo) override {
        return couplingValue;
      }
      void initializeUsingXML(xercesc::DOMElement *element) override;
      /***************************************************/
 
    protected:
      double couplingValue{0};
  };
 
}
 
#endif