ODESolver.h

Go to the documentation of this file.

 
#pragma once
 
#include <array>
 
#include "ODESolverTypes.h"
 
namespace MathLib
{
namespace ODE
{
 
template <unsigned NumEquations>
class ODESolver
{
public:
    virtual void setFunction(Function<NumEquations> f,
                             JacobianFunction<NumEquations> df) = 0;
 
    virtual void setTolerance(const double abstol, const double reltol) = 0;
 
    virtual void setTolerance(const std::array<double, NumEquations>& abstol,
                              const double reltol) = 0;
 
    virtual void setIC(const double t0,
                       std::initializer_list<double> const& y0) = 0;
 
    virtual void setIC(
        const double t0,
        Eigen::Matrix<double, NumEquations, 1, Eigen::ColMajor> const& y0) = 0;
 
    virtual void preSolve() = 0;
 
    virtual bool solve(const double t) = 0;
 
    virtual unsigned getNumberOfEquations() const { return NumEquations; }
    virtual MappedConstVector<NumEquations> getSolution() const = 0;
 
    virtual double getTime() const = 0;
 
    virtual Eigen::Matrix<double, NumEquations, 1, Eigen::ColMajor> getYDot(
        const double t, const MappedConstVector<NumEquations>& y) const = 0;
 
    virtual ~ODESolver() = default;
};
 
 
}  // namespace ODE
}  // namespace MathLib