Mercurial > repos > public > sbplib

annotate +time/Timestepper.m @ 816:b5e5b195da1e feature/timesteppers

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add getState to timesteppers, returning the relevant state of the timestepper - Add getState which returns the 'state' of the specialized timestepper.
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Mon, 10 Sep 2018 16:19:16 +0200
parents 54055b32d516
children 8894e9c49e40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 classdef Timestepper < handle
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 properties (Abstract)
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 t
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 k
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 n
816
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
6 % TBD: Decide on accessibility of properties.
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
7 % Properties that are not intended to be modified from the outside
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
8 % should ideally be made private and the specialized classes should be extended with
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
9 % getter functions for their relevant members, e.g v, t, k, etc.
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 methods (Abstract)
816
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
13 % Returns the solution vector v at timestep t.
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
14 % TBD: Replace with getters for the separate members if the above suggestion is implemented?
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
15 [v,t] = getV(obj)
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
16 % Returns struct holding relevant state properties for the specialized timestepper.
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
17 % E.g [v, t, k].
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
18 state = getState(obj)
b5e5b195da1e Add getState to timesteppers, returning the relevant state of the timestepper
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 126
diff changeset
19 obj = step(obj)
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 methods
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24 function [v,t] = stepN(obj,n,progress_bar)
13
b18d3d201a71 Fixed initialization of step counter in timesteppers.
Jonatan Werpers <jonatan@werpers.com>
parents: 3
diff changeset
25 default_arg('progress_bar',false);
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
27 if ~progress_bar
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
28 obj.stepN_without_progress(n);
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
29 else
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
30 obj.stepN_with_progress(n);
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
31 end
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
32
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
33 v = obj.getV;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
34 t = obj.t;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
35 end
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
37 function stepN_without_progress(obj, n)
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
38 for i=1:n
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
39 obj.step();
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
40 end
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
41 end
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
42
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
43 function stepN_with_progress(obj, n)
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
44 FRAME_RATE = 20;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
45
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
46 steps_to_update = 1;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
47 steps_since_update = 0;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
48 last_update = tic();
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
49 s = util.replace_string('',' %d %%',0);
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
50 for i=1:n
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
51 obj.step();
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
52
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
53 steps_since_update = steps_since_update + 1;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
54
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
55 if steps_since_update >= steps_to_update
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
56 s = util.replace_string(s,' %.2f %%',i/n*100);
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
57
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
58 time_since_update = toc(last_update);
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
59 time_error = time_since_update - 1/FRAME_RATE;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
60 time_per_step = time_since_update/steps_since_update;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
61
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
62 steps_to_update = max(steps_to_update - 0.9*time_error/time_per_step ,1);
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
63
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
64 steps_since_update = 0;
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
65 last_update = tic();
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66 end
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
67 end
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
68
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
69 s = util.replace_string(s,'');
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
70 end
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
71
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
72 function [v,t] = evolve(obj, tend, progress_bar)
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
73 default_arg('progress_bar',false)
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
74 if ~progress_bar
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
75 obj.evolve_without_progress(tend);
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
76 else
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
77 obj.evolve_with_progress(tend);
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
78 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
79 v = obj.getV;
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
80 t = obj.t;
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
81 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
82
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
83 function evolve_without_progress(obj, tend)
126
54055b32d516 Changed evolve so that it always stops as close to tend as possible.
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
84 while obj.t < tend - obj.k/2
16
f7975c054bc3 Improved progress indication for stepN
Jonatan Werpers <jonatan@werpers.com>
parents: 13
diff changeset
85 obj.step();
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
86 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
87 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
88
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
89 function evolve_with_progress(obj, tend)
3
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
90 FRAME_RATE = 20;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
91
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
92 steps_to_update = 1;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
93 steps_since_update = 0;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
94 last_update = tic();
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
95 s = util.replace_string('',' %d %%',0);
126
54055b32d516 Changed evolve so that it always stops as close to tend as possible.
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
96 while obj.t < tend - obj.k/2
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
97 obj.step();
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
98
3
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
99 steps_since_update = steps_since_update + 1;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
100
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
101 if steps_since_update >= steps_to_update
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
102 s = util.replace_string(s,' %.2f %%',obj.t/tend*100);
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
103
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
104 time_since_update = toc(last_update);
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
105 time_error = time_since_update - 1/FRAME_RATE;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
106 time_per_step = time_since_update/steps_since_update;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
107
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
108 steps_to_update = max(steps_to_update - 0.9*time_error/time_per_step ,1);
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
109
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
110 steps_since_update = 0;
5205251db8c3 Added some smartness to evolve with progress.`
Jonatan Werpers <jonatan@werpers.com>
parents: 0
diff changeset
111 last_update = tic();
0
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
112 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
113 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
114
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
115 s = util.replace_string(s,'');
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
116 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
117
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
118
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
119 end
48b6fb693025 Initial commit.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
120 end