annotate +rv/+time/RungekuttaExteriorRvMg.m @ 1162:0ec06ca3fc36 feature/rv

Add missing semicolons
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 27 Jun 2019 11:03:40 +0200
parents 76e3bb7836cf
children 745ae0d134c9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1160
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
1 classdef RungekuttaExteriorRvMg < time.Timestepper
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
2 properties
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
3 F % RHS of the ODE
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
4 k % Time step
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
5 t % Time point
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
6 v % Solution vector
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
7 n % Time level
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
8 rkScheme % The particular RK scheme used for time integration
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
9 RV % Residual Viscosity operator
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
10 DvDt % Function for computing the time deriative used for the RV evaluation
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
11 v_unstable
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
12 viscosity
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
13 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
14 methods
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
15
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
16 function obj = RungekuttaExteriorRvMg(F, k, t0, v0, RV, DvDt, order)
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
17 obj.F = F;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
18 obj.k = k;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
19 obj.t = t0;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
20 obj.v = v0;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
21 obj.n = 0;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
22
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
23 if (order == 4) % Use specialized RK4 scheme
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
24 obj.rkScheme = @time.rk.rungekutta_4;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
25 else
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
26 % Extract the coefficients for the specified order
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
27 % used for the RK updates from the Butcher tableua.
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
28 [s,a,b,c] = time.rk.butcherTableau(order);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
29 coeffs = struct('s',s,'a',a,'b',b,'c',c);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
30 obj.rkScheme = @(v,t,dt,F) time.rk.rungekutta(v, t , dt, F, coeffs);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
31 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
32
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
33 obj.RV = RV;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
34 obj.DvDt = DvDt;
1162
0ec06ca3fc36 Add missing semicolons
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1160
diff changeset
35 obj.v_unstable = 0*v0;
0ec06ca3fc36 Add missing semicolons
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1160
diff changeset
36 obj.viscosity = 0*v0;
1160
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
37 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
38
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
39 function [v, t] = getV(obj)
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
40 v = obj.v;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
41 t = obj.t;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
42 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
43
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
44 function state = getState(obj)
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
45 dvdt = obj.DvDt(obj.v_unstable);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
46 [viscosity, Df, firstOrderViscosity, residualViscosity] = obj.RV.evaluate(obj.v, dvdt);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
47 state = struct('v', obj.v, 'dvdt', dvdt, 'Df', Df, 'viscosity', viscosity, 'residualViscosity', residualViscosity, 'firstOrderViscosity', firstOrderViscosity, 't', obj.t);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
48 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
49
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
50 % Advances the solution vector one time step using the Runge-Kutta method given by
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
51 % obj.coeffs, using a fixed residual viscosity for the Runge-Kutta substeps
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
52 function obj = step(obj)
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
53 % Fix the viscosity of the RHS function F
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
54 m = length(obj.viscosity);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
55 F_stable = @(v,t) obj.F(v,t,spdiags(obj.viscosity,0,m,m));
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
56 F_unstable = @(v,t) obj.F(v,t,spdiags(0*obj.viscosity,0,m,m));
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
57 obj.v = obj.rkScheme(obj.v, obj.t, obj.k, F_stable);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
58 obj.v_unstable = obj.rkScheme(obj.v, obj.t, obj.k, F_unstable);
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
59 obj.viscosity = obj.RV.evaluateViscosity(obj.v, obj.DvDt(obj.v_unstable));
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
60 obj.t = obj.t + obj.k;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
61 obj.n = obj.n + 1;
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
62 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
63 end
76e3bb7836cf First attempt at multi-grid calculation of the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
64 end