integrator.h

/* Copyright (C) 2004-2014 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 _INTEGRATOR_H_
#define _INTEGRATOR_H_
 
#include <fmatvec/fmatvec.h>
#include <fmatvec/atom.h>
#include <mbsim/namespace.h>
#include <mbsim/mbsim_event.h>
#include <mbsim/solver.h>
#include <string>
 
namespace MBSim {
 
  class Integrator : public MBSim::Solver {
    public:
      Integrator() : name("Integrator") { }
      
      ~Integrator() override = default;
      
      /* GETTER / SETTER */
      void setStartTime(double tStart_) { tStart=tStart_; }
      void setEndTime(double tEnd_) { tEnd = tEnd_; }
      void setPlotStepSize(double dtPlot_) { dtPlot = dtPlot_; }
      void setInitialState(const fmatvec::Vec &z0_) { z0 <<= z0_; }
      double getStartTime() const { return tStart; }
      double getEndTime() const { return tEnd; }
      double getPlotStepSize() const { return dtPlot; }
      const fmatvec::Vec& getInitialState() const override { return z0; }
      /***************************************************/
      
      void execute() override { integrate(); }
 
      /* INTERFACE FOR DERIVED CLASSES */
      virtual void integrate() = 0;
 
      void integrate(MBSim::DynamicSystemSolver& sys) { setSystem(&sys); integrate(); }
 
      void debugInit();
 
      virtual void preIntegrate() { throwError("preIntegrate is not defined"); }
      virtual void subIntegrate(double tStop) { throwError("subIntegrate is not defined"); }
      virtual void postIntegrate() { throwError("postIntegrate is not defined"); }
 
      void initializeUsingXML(xercesc::DOMElement *element) override;
 
    protected:
      double tStart{0.}, tEnd{1.}, dtPlot{1e-4};
 
      fmatvec::Vec z0;
 
      std::string name;
  };
 
}
 
#endif /* _INTEGRATOR_H_ */