runge_kutta.hpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  *
9  * CasADi is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 3 of the License, or (at your option) any later version.
13  *
14  * CasADi is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with CasADi; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 
26 #ifndef CASADI_RUNGE_KUTTA_HPP
27 #define CASADI_RUNGE_KUTTA_HPP
28 
29 #include "casadi/core/integrator_impl.hpp"
30 #include <casadi/solvers/casadi_integrator_rk_export.h>
31 
44 namespace casadi {
45 
55  class RungeKutta : public FixedStepIntegrator {
56  public:
57 
59  RungeKutta(const std::string& name, const Function& dae, double t0,
60  const std::vector<double>& tout);
61 
63  static Integrator* creator(const std::string& name, const Function& dae,
64  double t0, const std::vector<double>& tout) {
65  return new RungeKutta(name, dae, t0, tout);
66  }
67 
69  ~RungeKutta() override;
70 
71  // Get name of the plugin
72  const char* plugin_name() const override { return "rk";}
73 
74  // Get name of the class
75  std::string class_name() const override { return "RungeKutta";}
76 
78  void init(const Dict& opts) override;
79 
81  void setup_step() override;
82 
84  static const std::string meta_doc;
85 
87  void serialize_body(SerializingStream &s) const override;
88 
90  static ProtoFunction* deserialize(DeserializingStream& s) { return new RungeKutta(s); }
91 
92  protected:
93 
95  explicit RungeKutta(DeserializingStream& s);
96  };
97 
98 } // namespace casadi
99 
101 #endif // CASADI_RUNGE_KUTTA_HPP
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.