ode.h

Go to the documentation of this file.

 
#ifndef THEORETICA_ODE_H
#define THEORETICA_ODE_H
 
#include "../algebra/algebra_types.h"
#include <functional>
 
 
namespace theoretica {

    namespace ode {
 

        template<typename Vector = vec<real>>
        struct ode_solution_t {

            vec<real> t;

            vec<Vector> x;
 

            ode_solution_t() {}
 

            ode_solution_t(size_t steps, const Vector& x0, real t0) {
                    
                t.resize(steps);
                x.resize(steps);
 
                t[0] = t0;
                x[0] = x0;
            }
 
 
#ifndef THEORETICA_NO_PRINT         

            inline std::string to_string(const std::string& separator = " ") const {
 
                if (t.size() != x.size()) {
                    TH_MATH_ERROR("ode_solution_t::to_string", t.size(), MathError::InvalidArgument);
                    return "";
                }
 
                std::stringstream res;
 
                for (unsigned int i = 0; i < t.size(); ++i) {
                    
                    res << t[i] << separator;
 
                    for (unsigned int j = 0; j < x[i].size(); ++j) {
 
                        res << x[i][j];
 
                        if(j != x[i].size() - 1)
                            res << separator;
                        else
                            res << "\n";
                    }
                }
 
                return res.str();
            }
 

            inline operator std::string() {
                return to_string();
            }
 

            inline friend std::ostream& operator<<(
                std::ostream& out, const ode_solution_t<Vector>& obj) {
                return out << obj.to_string();
            }
#endif
 
        };
 

        using ode_solution = ode_solution_t<vec<real>>;
 

        using ode_solution1d = ode_solution_t<real>;
 

        using ode_solution2d = ode_solution_t<vec2>;
 

        using ode_solution3d = ode_solution_t<vec3>;
 

        using ode_solution4d = ode_solution_t<vec4>;
 

        template<typename Vector>
        using ode_function = std::function<Vector(real, const Vector&)>;
 
 
        // Steppers
        // (functions which compute one iteration of a method)
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_euler(OdeFunction f, const Vector& x, real t, real h = 0.0001) {
 
            return x + h * f(t, x);
        }
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_midpoint(OdeFunction f, const Vector& x, real t, real h = 0.0001) {
            
            return x + h * f(t + h / 2.0, x + f(t, x) * h / 2.0);
        }
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_heun(OdeFunction f, const Vector& x, real t, real h = 0.001) {
            
            const Vector k1 = f(t, x);
 
            return x + (k1 + f(t + h, x + k1 * h)) * (h / 2.0);
        }
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_rk2(OdeFunction f, const Vector& x, real t, real h = 0.001) {
            
            const Vector k1 = f(t, x);
            const Vector k2 = f(t + (h / 2.0), x + k1 * (h / 2.0));
 
            return x + k2 * h;
        }
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_rk4(OdeFunction f, const Vector& x, real t, real h = 0.01) {
 
            const real half = h / 2.0;
            
            const Vector k1 = f(t, x);
            const Vector k2 = f(t + half, x + k1 * half);
            const Vector k3 = f(t + half, x + k2 * half);
            const Vector k4 = f(t + h, x + k3 * h);
 
            return x + (k1 + k2 * 2.0 + k3 * 2.0 + k4) * (h / 6.0);
        }
 

        template<typename Vector, typename OdeFunction = ode_function<Vector>>
        inline Vector step_k38(OdeFunction f, const Vector& x, real t, real h = 0.001) {
            
            const Vector k1 = f(t, x);
            const Vector k2 = f(t + (h / 3.0), x + k1 * (h / 3.0));
            const Vector k3 = f(t + (h * 2.0 / 3.0), x + h * (-k1 / 3.0 + k2));
            const Vector k4 = f(t + h, x + h * (k1 - k2 + k3));
 
            return x + (k1 + 3.0 * k2 + 3.0 * k3 + k4) * (h / 8.0);
        }
 
 
        // Solvers
        // (functions which solve numerically an ODE over an interval)
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>,
            typename StepFunction
        >
        inline ode_solution_t<Vector>
        solve_fixstep(
            OdeFunction f, const Vector& x0, real t0, real tf,
            StepFunction step, real stepsize = 0.001) {
 
            if (tf < t0) {
                TH_MATH_ERROR("ode::solve_fixstep", tf, MathError::InvalidArgument);
                ode_solution_t<Vector> err; err.t = Vector(nan());
                return err;
            }
 
            const unsigned int steps = floor((tf - t0) / stepsize);
            unsigned int total_steps = steps;
            unsigned int i;
 
            if (abs(t0 + steps * stepsize - tf) > MACH_EPSILON)
                total_steps++;
 
            // Initialize solution structure
            auto solution = ode_solution_t<Vector>(total_steps + 1, x0, t0);
 
 
            // Iterate over each step of the numerical method
            for (i = 1; i <= steps; ++i) {
                solution.x[i] = step(f, solution.x[i - 1], solution.t[i - 1], stepsize);
                solution.t[i] = solution.t[i - 1] + stepsize;
            }
 
 
            // Additional shorter step if the stepsize
            // does not cover exactly the time interval
            if (steps != total_steps) {
                solution.x[i] = step(
                    f, solution.x[i - 1], solution.t[i - 1], tf - solution.t[i - 1]);
                solution.t[i] = tf;
            }
 
            return solution;
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_euler(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.0001) {
 
            return solve_fixstep(f, x0, t0, tf, step_euler<Vector, OdeFunction>, stepsize);
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_midpoint(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.0001) {
 
            return solve_fixstep(f, x0, t0, tf, step_midpoint<Vector, OdeFunction>, stepsize);
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_heun(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.0001) {
 
            return solve_fixstep(f, x0, t0, tf, step_heun<Vector, OdeFunction>, stepsize);
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_rk2(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.0001) {
 
            return solve_fixstep(f, x0, t0, tf, step_rk2<Vector, OdeFunction>, stepsize);
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_rk4(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.01) {
 
            return solve_fixstep(f, x0, t0, tf, step_rk4<Vector, OdeFunction>, stepsize);
        }
 

        template <
            typename Vector, typename OdeFunction = ode_function<Vector>
        >
        inline ode_solution_t<Vector> solve_k38(
            OdeFunction f, const Vector& x0,
            real t0, real tf, real stepsize = 0.0001) {
 
            return solve_fixstep(f, x0, t0, tf, step_k38<Vector, OdeFunction>, stepsize);
        }
    }
}
 
#endif