annotate +time/Rungekutta.m @ 888:8732d6bd9890 feature/timesteppers

Add general Runge-Kutta class - Add a general Runge-Kutta class which time integrates the solution based on coefficients obtained from a Butcher tableau - Add butcher tableau which returns coefficents for the specified Runge-Kutta method - Remove RungKutta4proper, since obsolete
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 15 Nov 2018 17:10:01 -0800
parents
children 679f4ddd982f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
888
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
1 classdef Rungekutta < time.Timestepper
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
2 properties
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
3 F % RHS of the ODE
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
4 k % Time step
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
5 t % Time point
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
6 v % Solution vector
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
7 n % Time level
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
8 scheme % The scheme used for the time stepping, e.g rk4, rk6 etc.
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
9 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
10
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
11
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
12 methods
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
13 % Timesteps v_t = F(v,t), using the specified RK method from t = t0 with
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
14 % timestep k and initial conditions v = v0
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
15 function obj = Rungekutta(F, k, t0, v0, method)
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
16 default_arg('method',"rk4");
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
17 obj.F = F;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
18 obj.k = k;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
19 obj.t = t0;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
20 obj.v = v0;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
21 obj.n = 0;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
22 % TODO: method "rk4" is also implemented in the butcher tableau, but the rungekutta_4.m implementation
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
23 % might be slightly more efficient. Need to do some profiling before deciding whether or not to keep it.
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
24 if (method == "rk4")
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
25 obj.scheme = @time.rk.rungekutta_4;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
26 else
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
27 % Extract the coefficients for the specified method
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
28 % used for the RK updates from the Butcher tableua.
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
29 [s,a,b,c] = time.rk.butcherTableau(method);
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
30 coeffs = struct('s',s,'a',a,'b',b,'c',c);
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
31 obj.scheme = @(v,t,dt,F) time.rk.rungekutta(v, t , dt, F, coeffs);
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
32 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
33 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
34
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
35 function [v,t] = getV(obj)
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
36 v = obj.v;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
37 t = obj.t;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
38 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
39
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
40 function obj = step(obj)
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
41 obj.v = obj.scheme(obj.v, obj.t, obj.k, obj.F);
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
42 obj.t = obj.t + obj.k;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
43 obj.n = obj.n + 1;
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
44 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
45 end
8732d6bd9890 Add general Runge-Kutta class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
46 end