/
timesteppers.jl
760 lines (583 loc) · 20.7 KB
/
timesteppers.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
"""
stepforward!(prob::Problem)
Step forward `prob` one time step.
"""
stepforward!(prob::Problem) =
stepforward!(prob.sol, prob.clock, prob.timestepper, prob.eqn, prob.vars, prob.params, prob.grid)
"""
stepforward!(prob::Problem, nsteps::Int)
Step forward `prob` for `nsteps`.
"""
function stepforward!(prob::Problem, nsteps::Int)
for _ in 1:nsteps
stepforward!(prob)
end
return nothing
end
"""
stepforward!(prob::Problem, diags, nsteps::Int)
Step forward `prob` for `nsteps`, incrementing `diags` along the way. `diags` may be a
single `Diagnostic` or a `Vector` of `Diagnostic`s.
"""
function stepforward!(prob::Problem, diags, nsteps::Int)
for _ in 1:nsteps
stepforward!(prob)
increment!(diags)
end
return nothing
end
const fullyexplicitsteppers = [
:ForwardEuler,
:RK4,
:AB3,
:LSRK54,
:FilteredForwardEuler,
:FilteredRK4,
:FilteredAB3,
:FilteredLSRK54
]
isexplicit(stepper) = any(Symbol(stepper) .== fullyexplicitsteppers)
"""
TimeStepper(stepper, equation, dt=nothing, dev=CPU(); kw...)
Instantiate the Time`stepper` for `equation` with timestep `dt` and
on the `dev`ice. The keyword arguments, `kw`, are passed to the
timestepper constructor.
"""
function TimeStepper(stepper, equation, dt=nothing, dev::Device=CPU(); kw...)
fullsteppername = Symbol(stepper, :TimeStepper)
# Create expression that instantiates the time-stepper, depending on whether
# timestepper is explicit or not.
expr = isexplicit(stepper) ? Expr(:call, fullsteppername, equation, dev) :
Expr(:call, fullsteppername, equation, dt, dev)
# Add keyword arguments
length(kw) > 0 && push!(expr.args, Tuple(Expr(:kw, p.first, p.second) for p in kw)...)
return eval(expr)
end
# The following time-steppers are implemented below
#
# * Forward Euler
# * Filtered Forward Euler
# * RK4
# * Filtered RK4
# * LSRK54
# * Filtered LSRK54
# * ETDRK4
# * Filtered ETDRK4
# * AB3
# * Filtered AB3
# --
# Forward Euler
# --
"""
struct ForwardEulerTimeStepper{T} <: AbstractTimeStepper{T}
A forward Euler timestepper for time-stepping `∂u/∂t = RHS(u, t)` via:
```julia
uⁿ⁺¹ = uⁿ + dt * RHS(uⁿ, tⁿ)
```
"""
struct ForwardEulerTimeStepper{T} <: AbstractTimeStepper{T}
N :: T # Explicit linear and nonlinear terms
ForwardEulerTimeStepper(N::T) where T = new{T}(0N)
end
"""
ForwardEulerTimeStepper(equation::Equation, dev::Device=CPU())
Construct a forward Euler timestepper for `equation` on device `dev`.
"""
ForwardEulerTimeStepper(equation::Equation, dev::Device=CPU()) =
ForwardEulerTimeStepper(zeros(dev, equation.T, equation.dims))
function stepforward!(sol, clock, ts::ForwardEulerTimeStepper, equation, vars, params, grid)
equation.calcN!(ts.N, sol, clock.t, clock, vars, params, grid)
@. sol += clock.dt * (equation.L * sol + ts.N)
clock.t += clock.dt
clock.step += 1
return nothing
end
"""
struct FilteredForwardEulerTimeStepper{T,Tf} <: AbstractTimeStepper{T}
A forward Euler timestepper with spectral filtering. See [`ForwardEulerTimeStepper`](@ref).
"""
struct FilteredForwardEulerTimeStepper{T,Tf} <: AbstractTimeStepper{T}
N :: T
filter :: Tf
end
"""
FilteredForwardEulerTimeStepper(equation, dev; filterkwargs...)
Construct a Forward Euler timestepper with spectral filtering for `equation` on device `dev`.
"""
function FilteredForwardEulerTimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
filter = makefilter(equation; filterkwargs...)
return FilteredForwardEulerTimeStepper(zeros(dev, equation.T, equation.dims), filter)
end
function stepforward!(sol, clock, ts::FilteredForwardEulerTimeStepper, equation, vars, params, grid)
equation.calcN!(ts.N, sol, clock.t, clock, vars, params, grid)
@. sol = ts.filter * (sol + clock.dt * (ts.N + equation.L * sol))
clock.t += clock.dt
clock.step += 1
return nothing
end
# --
# RK4
# --
"""
struct RK4TimeStepper{T} <: AbstractTimeStepper{T}
A 4th-order Runge-Kutta timestepper for time-stepping `∂u/∂t = RHS(u, t)` via:
```julia
uⁿ⁺¹ = uⁿ + dt/6 * (k₁ + 2 * k₂ + 2 * k₃ + k₄)
```
where
```julia
k₁ = RHS(uⁿ, tⁿ)
k₂ = RHS(uⁿ + k₁ * dt/2, tⁿ + dt/2)
k₃ = RHS(uⁿ + k₂ * dt/2, tⁿ + dt/2)
k₄ = RHS(uⁿ + k₃ * dt, tⁿ + dt)
```
!!! info "Usage"
If your simulation is limited by memory then consider switching to [`LSRK54TimeStepper`](@ref).
The [`LSRK54TimeStepper`](@ref) timestepper has about half the memory footprint compared
to the `RK4TimeStepper` with a about 25%-30% performance trade off.
"""
struct RK4TimeStepper{T} <: AbstractTimeStepper{T}
sol₁ :: T
RHS₁ :: T
RHS₂ :: T
RHS₃ :: T
RHS₄ :: T
end
"""
RK4TimeStepper(equation::Equation, dev::Device=CPU())
Construct a 4th-order Runge-Kutta timestepper for `equation` on device `dev`.
"""
function RK4TimeStepper(equation::Equation, dev::Device=CPU())
@devzeros typeof(dev) equation.T equation.dims sol₁ RHS₁ RHS₂ RHS₃ RHS₄
return RK4TimeStepper(sol₁, RHS₁, RHS₂, RHS₃, RHS₄)
end
"""
struct FilteredRK4TimeStepper{T,Tf} <: AbstractTimeStepper{T}
A 4th-order Runge-Kutta timestepper with spectral filtering. See [`RK4TimeStepper`](@ref).
"""
struct FilteredRK4TimeStepper{T,Tf} <: AbstractTimeStepper{T}
sol₁ :: T
RHS₁ :: T
RHS₂ :: T
RHS₃ :: T
RHS₄ :: T
filter :: Tf
end
"""
FilteredRK4TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
Construct a 4th-order Runge-Kutta timestepper with spectral filtering for `equation` on device `dev`.
"""
function FilteredRK4TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
ts = RK4TimeStepper(equation, dev)
filter = makefilter(equation; filterkwargs...)
return FilteredRK4TimeStepper(getfield.(Ref(ts), fieldnames(typeof(ts)))..., filter)
end
function addlinearterm!(RHS, L, sol)
@. RHS += L*sol
return nothing
end
function substepsol!(newsol, sol, RHS, dt)
@. newsol = sol + dt*RHS
return nothing
end
function RK4substeps!(sol, clock, ts, equation, vars, params, grid, t, dt)
# Substep 1
equation.calcN!(ts.RHS₁, sol, t, clock, vars, params, grid)
addlinearterm!(ts.RHS₁, equation.L, sol)
# Substep 2
substepsol!(ts.sol₁, sol, ts.RHS₁, dt/2)
equation.calcN!(ts.RHS₂, ts.sol₁, t+dt/2, clock, vars, params, grid)
addlinearterm!(ts.RHS₂, equation.L, ts.sol₁)
# Substep 3
substepsol!(ts.sol₁, sol, ts.RHS₂, dt/2)
equation.calcN!(ts.RHS₃, ts.sol₁, t+dt/2, clock, vars, params, grid)
addlinearterm!(ts.RHS₃, equation.L, ts.sol₁)
# Substep 4
substepsol!(ts.sol₁, sol, ts.RHS₃, dt)
equation.calcN!(ts.RHS₄, ts.sol₁, t+dt, clock, vars, params, grid)
addlinearterm!(ts.RHS₄, equation.L, ts.sol₁)
return nothing
end
function RK4update!(sol, RHS₁, RHS₂, RHS₃, RHS₄, dt)
@. sol += dt/6 * (RHS₁ + 2 * RHS₂ + 2 * RHS₃ + RHS₄)
return nothing
end
function stepforward!(sol, clock, ts::RK4TimeStepper, equation, vars, params, grid)
RK4substeps!(sol, clock, ts, equation, vars, params, grid, clock.t, clock.dt)
RK4update!(sol, ts.RHS₁, ts.RHS₂, ts.RHS₃, ts.RHS₄, clock.dt)
clock.t += clock.dt
clock.step += 1
return nothing
end
function stepforward!(sol, clock, ts::FilteredRK4TimeStepper, equation, vars, params, grid)
RK4substeps!(sol, clock, ts, equation, vars, params, grid, clock.t, clock.dt)
RK4update!(sol, ts.RHS₁, ts.RHS₂, ts.RHS₃, ts.RHS₄, clock.dt)
@. sol *= ts.filter
clock.t += clock.dt
clock.step += 1
return nothing
end
# --
# LSRK(5)4
# --
"""
struct LSRK54TimeStepper{T} <: AbstractTimeStepper{T}
A 4th-order 5-stages 2-storage Runge-Kutta timestepper for time-stepping
`∂u/∂t = RHS(u, t)` via:
```julia
S² = 0
for i = 1:5
S² = Aᵢ * S² + dt * RHS(uⁿ, t₀ + Cᵢ * dt)
uⁿ += Bᵢ * S²
end
uⁿ⁺¹ = uⁿ
```
where `Aᵢ`, `Bᵢ`, and `Cᵢ` are the ``A``, ``B``, and ``C`` coefficients from
the LSRK table at the ``i``-th stage. For details, refer to [Carpenter-Kennedy-1994](@cite).
!!! info "Usage"
The `LSRK54TimeStepper` is *slower* than the [`RK4TimeStepper`](@ref) but
has *less* memory footprint; half compared to [`RK4TimeStepper`](@ref).
If your simulation is bound by performance then use [`RK4TimeStepper`](@ref);
if your simulation is bound by memory then consider using `LSRK54TimeStepper`.
"""
struct LSRK54TimeStepper{T,V} <: AbstractTimeStepper{T}
S² :: T
RHS :: T
A :: V
B :: V
C :: V
end
"""
LSRK54TimeStepper(equation::Equation, dev::Device=CPU())
Construct a 4th-order 5-stages low-storage Runge-Kutta timestepper for `equation` on device `dev`.
"""
function LSRK54TimeStepper(equation::Equation, dev::Device=CPU())
@devzeros typeof(dev) equation.T equation.dims S² RHS
T = equation.T
A = T[0,
-567301805773//1357537059087,
-2404267990393//2016746695238,
-3550918686646//2091501179385,
-1275806237668//842570457699]
B = T[1432997174477//9575080441755,
5161836677717//13612068292357,
1720146321549//2090206949498,
3134564353537//4481467310338,
2277821191437//14882151754819]
C = T[0,
1432997174477//9575080441755,
2526269341429//6820363962896,
2006345519317//3224310063776,
2802321613138//2924317926251]
return LSRK54TimeStepper(S², RHS, Tuple(A), Tuple(B), Tuple(C))
end
"""
struct FilteredLSRK54TimeStepper{T,V,Tf} <: AbstractTimeStepper{T}
A 4th-order 5-stages low-storage Runge-Kutta timestepper with spectral filtering.
See [`LSRK54TimeStepper`](@ref).
"""
struct FilteredLSRK54TimeStepper{T,V,Tf} <: AbstractTimeStepper{T}
S² :: T
RHS :: T
A :: V
B :: V
C :: V
filter :: Tf
end
"""
FilteredRK4TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
Construct a 4th-order 5-stages 2-storage Runge-Kutta timestepper with spectral filtering
for `equation` on device `dev`.
"""
function FilteredLSRK54TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
ts = LSRK54TimeStepper(equation, dev)
filter = makefilter(equation; filterkwargs...)
return FilteredLSRK54TimeStepper(getfield.(Ref(ts), fieldnames(typeof(ts)))..., filter)
end
function LSRK54update!(sol, clock, ts, equation, vars, params, grid, t, dt)
@. ts.S² = 0
for i = 1:5
@inbounds equation.calcN!(ts.RHS, sol, t + ts.C[i] * dt , clock, vars, params, grid)
addlinearterm!(ts.RHS, equation.L, sol)
@. ts.S² = @inbounds ts.A[i] * ts.S² + dt * ts.RHS
@. sol += @inbounds ts.B[i] * ts.S²
end
return nothing
end
function stepforward!(sol, clock, ts::LSRK54TimeStepper, equation, vars, params, grid)
LSRK54update!(sol, clock, ts, equation, vars, params, grid, clock.t, clock.dt)
clock.t += clock.dt
clock.step += 1
return nothing
end
function stepforward!(sol, clock, ts::FilteredLSRK54TimeStepper, equation, vars, params, grid)
LSRK54update!(sol, clock, ts, equation, vars, params, grid, clock.t, clock.dt)
@. sol *= ts.filter
clock.t += clock.dt
clock.step += 1
return nothing
end
# --
# ETDRK4
# --
"""
struct ETDRK4TimeStepper{T,TL} <: AbstractTimeStepper{T}
A 4th-order exponential-time-differencing Runge-Kutta timestepper for time-stepping
`∂u/∂t = L * u + N(u)`. The scheme treats the linear term `L` exactly while for the
nonlinear terms `N(u)` it uses a 4th-order Runge-Kutta scheme ([`RK4TimeStepper`](@ref)).
That is,
```julia
uⁿ⁺¹ = exp(L * dt) * uⁿ + RK4(N(uⁿ))
```
For more info refer to [Kassam-Trefethen-2005](@cite).
"""
struct ETDRK4TimeStepper{T,TL} <: AbstractTimeStepper{T}
# ETDRK4 coefficents
ζ :: TL
α :: TL
β :: TL
Γ :: TL
expLdt :: TL
exp½Ldt :: TL
sol₁ :: T
sol₂ :: T
N₁ :: T
N₂ :: T
N₃ :: T
N₄ :: T
end
"""
ETDRK4TimeStepper(equation::Equation, dt, dev::Device=CPU())
Construct a 4th-order exponential-time-differencing Runge-Kutta timestepper with timestep `dt`
for `equation` on device `dev`.
"""
function ETDRK4TimeStepper(equation::Equation, dt, dev::Device=CPU())
dt = fltype(equation.T)(dt) # ensure dt is correct type.
expLdt, exp½Ldt = getexpLs(dt, equation)
ζ, α, β, Γ = getetdcoeffs(dt, equation.L)
@devzeros typeof(dev) equation.T equation.dims sol₁ sol₂ N₁ N₂ N₃ N₄
return ETDRK4TimeStepper(ζ, α, β, Γ, expLdt, exp½Ldt, sol₁, sol₂, N₁, N₂, N₃, N₄)
end
"""
FilteredETDRK4TimeStepper{T,TL,Tf} <: AbstractTimeStepper{T}
A 4th-order exponential-time-differencing Runge-Kutta timestepper with spectral filtering.
See [`ETDRK4TimeStepper`](@ref).
"""
struct FilteredETDRK4TimeStepper{T,TL,Tf} <: AbstractTimeStepper{T}
# ETDRK4 coefficents:
ζ :: TL
α :: TL
β :: TL
Γ :: TL
expLdt :: TL
exp½Ldt :: TL
sol₁ :: T
sol₂ :: T
N₁ :: T
N₂ :: T
N₃ :: T
N₄ :: T
filter :: Tf
end
"""
FilteredETDRK4TimeStepper(equation, dt; filterkwargs...)
Construct a 4th-order exponential-time-differencing Runge-Kutta timestepper with timestep `dt` and
spectral filtering for `equation` on device `dev`.
"""
function FilteredETDRK4TimeStepper(equation::Equation, dt, dev::Device=CPU(); filterkwargs...)
timestepper = ETDRK4TimeStepper(equation, dt, dev)
filter = makefilter(equation; filterkwargs...)
return FilteredETDRK4TimeStepper(getfield.(Ref(timestepper), fieldnames(typeof(timestepper)))..., filter)
end
function ETDRK4update!(sol, expLdt, α, β, Γ, N₁, N₂, N₃, N₄)
@. sol = expLdt * sol + α * N₁ + 2β * (N₂ + N₃) + Γ * N₄
return nothing
end
function ETDRK4substep12!(sol₁, exp½Ldt, sol, ζ, N)
@. sol₁ = exp½Ldt * sol + ζ * N
return nothing
end
function ETDRK4substep3!(sol₂, exp½Ldt, sol₁, ζ, N₁, N₃)
@. sol₂ = exp½Ldt * sol₁ + ζ * (2N₃ - N₁)
return nothing
end
function ETDRK4substeps!(sol, clock, ts, equation, vars, params, grid)
# Substep 1
equation.calcN!(ts.N₁, sol, clock.t, clock, vars, params, grid)
ETDRK4substep12!(ts.sol₁, ts.exp½Ldt, sol, ts.ζ, ts.N₁)
# Substep 2
t2 = clock.t + clock.dt/2
equation.calcN!(ts.N₂, ts.sol₁, t2, clock, vars, params, grid)
ETDRK4substep12!(ts.sol₂, ts.exp½Ldt, sol, ts.ζ, ts.N₂)
# Substep 3
equation.calcN!(ts.N₃, ts.sol₂, t2, clock, vars, params, grid)
ETDRK4substep3!(ts.sol₂, ts.exp½Ldt, ts.sol₁, ts.ζ, ts.N₁, ts.N₃)
# Substep 4
t3 = clock.t + clock.dt
equation.calcN!(ts.N₄, ts.sol₂, t3, clock, vars, params, grid)
return nothing
end
function stepforward!(sol, clock, ts::ETDRK4TimeStepper, equation, vars, params, grid)
ETDRK4substeps!(sol, clock, ts, equation, vars, params, grid)
ETDRK4update!(sol, ts.expLdt, ts.α, ts.β, ts.Γ, ts.N₁, ts.N₂, ts.N₃, ts.N₄)
clock.t += clock.dt
clock.step += 1
return nothing
end
function stepforward!(sol, clock, ts::FilteredETDRK4TimeStepper, equation, vars, params, grid)
ETDRK4substeps!(sol, clock, ts, equation, vars, params, grid)
ETDRK4update!(sol, ts.expLdt, ts.α, ts.β, ts.Γ, ts.N₁, ts.N₂, ts.N₃, ts.N₄)
@. sol *= ts.filter
clock.t += clock.dt
clock.step += 1
return nothing
end
# --
# AB3
# --
const ab3h1 = 23/12
const ab3h2 = 16/12
const ab3h3 = 5/12
"""
struct AB3TimeStepper{T} <: AbstractTimeStepper{T}
A 3rd-order Adams-Bashforth timestepper for time-stepping `∂u/∂t = RHS(u, t)` via:
```julia
uⁿ⁺¹ = uⁿ + dt/12 * (23 * RHS(uⁿ, tⁿ) - 16 * RHS(uⁿ⁻¹, tⁿ⁻¹) + 5 * RHS(uⁿ⁻², tⁿ⁻²))
```
Adams-Bashforth is a multistep method, i.e., it not only requires information from the
`n`-th time-step (`uⁿ`) but also from the previous two timesteps (`uⁿ⁻¹` and `uⁿ⁻²`).
For the first two timesteps, it falls back to a forward Euler timestepping scheme:
```julia
uⁿ⁺¹ = uⁿ + dt * RHS(uⁿ, tⁿ)
```
"""
struct AB3TimeStepper{T} <: AbstractTimeStepper{T}
RHS::T
RHS₋₁::T
RHS₋₂::T
end
"""
AB3TimeStepper(equation::Equation, dev::Device=CPU())
Construct a 3rd order Adams-Bashforth timestepper for `equation` on device `dev`.
"""
function AB3TimeStepper(equation::Equation, dev::Device=CPU())
@devzeros typeof(dev) equation.T equation.dims RHS RHS₋₁ RHS₋₂
return AB3TimeStepper(RHS, RHS₋₁, RHS₋₂)
end
"""
struct FilteredAB3TimeStepper{T} <: AbstractTimeStepper{T}
A 3rd order Adams-Bashforth timestepper with spectral filtering. See [`AB3TimeStepper`](@ref).
"""
struct FilteredAB3TimeStepper{T, Tf} <: AbstractTimeStepper{T}
RHS :: T
RHS₋₁ :: T
RHS₋₂ :: T
filter :: Tf
end
"""
FilteredAB3TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
Construct a 3rd order Adams-Bashforth timestepper with spectral filtering for `equation` on device `dev`.
"""
function FilteredAB3TimeStepper(equation::Equation, dev::Device=CPU(); filterkwargs...)
timestepper = AB3TimeStepper(equation, dev)
filter = makefilter(equation; filterkwargs...)
return FilteredAB3TimeStepper(getfield.(Ref(timestepper), fieldnames(typeof(timestepper)))..., filter)
end
function AB3update!(sol, ts, clock)
if clock.step < 3 # forward Euler steps to initialize AB3
@. sol += clock.dt * ts.RHS # Update
else # Otherwise, stepforward with 3rd order Adams Bashforth:
@. sol += clock.dt * (ab3h1 * ts.RHS - ab3h2 * ts.RHS₋₁ + ab3h3 * ts.RHS₋₂)
end
return nothing
end
function stepforward!(sol, clock, ts::AB3TimeStepper, equation, vars, params, grid)
equation.calcN!(ts.RHS, sol, clock.t, clock, vars, params, grid)
addlinearterm!(ts.RHS, equation.L, sol)
AB3update!(sol, ts, clock)
clock.t += clock.dt
clock.step += 1
@. ts.RHS₋₂ = ts.RHS₋₁ # Store
@. ts.RHS₋₁ = ts.RHS # ... previous values of RHS
return nothing
end
function stepforward!(sol, clock, ts::FilteredAB3TimeStepper, equation, vars, params, grid)
equation.calcN!(ts.RHS, sol, clock.t, clock, vars, params, grid)
addlinearterm!(ts.RHS, equation.L, sol)
AB3update!(sol, ts, clock)
@. sol *= ts.filter
clock.t += clock.dt
clock.step += 1
@. ts.RHS₋₂ = ts.RHS₋₁ # Store
@. ts.RHS₋₁ = ts.RHS # ... previous values of RHS
return nothing
end
# --
# Timestepper utils
# --
function getexpLs(dt, equation)
expLdt = @. exp(dt * equation.L)
exp½Ldt = @. exp(dt * equation.L/2)
return expLdt, exp½Ldt
end
"""
getetdcoeffs(dt, L; ncirc=32, rcirc=1)
Calculate the coefficients associated with the (diagonal) linear coefficient
`L` for an ETDRK4 timestepper with timestep `dt`.
The calculation is done by integrating over a unit circle in the complex space.
For more info refer to [Kassam-Trefethen-2005](@cite).
"""
function getetdcoeffs(dt, L; ncirc=32, rcirc=1)
shape = Tuple(cat(ncirc, ones(Int, ndims(L)), dims=1))
circ = zeros(Complex{Float64}, shape) # use double precision for this calculation
circ .= rcirc * exp.(2π * im/ncirc * (0.5:1:(ncirc-0.5)))
circ = permutedims(circ, ndims(circ):-1:1)
zc = dt * L .+ circ
M = ndims(L) + 1
# Four coefficients: ζ, α, β, Γ
ζc = @. ( exp(zc/2)-1 ) / zc
αc = @. ( -4 - zc + exp(zc) * (4 - 3zc + zc^2) ) / zc^3
βc = @. ( 2 + zc + exp(zc) * (-2 + zc) ) / zc^3
Γc = @. ( -4 - 3zc - zc^2 + exp(zc) * (4 - zc) ) / zc^3
ζ = dt * dropdims(mean(ζc, dims=M), dims=M)
α = dt * dropdims(mean(αc, dims=M), dims=M)
β = dt * dropdims(mean(βc, dims=M), dims=M)
Γ = dt * dropdims(mean(Γc, dims=M), dims=M)
if eltype(L) <: Real # this is conservative, but unclear if necessary
ζ = real.(ζ)
α = real.(α)
β = real.(β)
Γ = real.(Γ)
end
return ζ, α, β, Γ
end
getetdcoeffs(dt, L::CuArray; kwargs...) =
(CuArray(ζ) for ζ in getetdcoeffs(dt, Array(L); kwargs...))
"""
step_until!(prob, stop_time)
Step forward `prob` until `stop_time`.
!!! warn "Fully-explicit timestepping schemes are required"
We cannot use `step_until!` with [`ETDRK4TimeStepper`](@ref) nor
[`FilteredETDRK4TimeStepper`](@ref).
See also: [`stepforward!`](@ref)
"""
step_until!(prob, stop_time) = step_until!(prob, prob.timestepper, stop_time)
step_until!(prob, ::Union{ETDRK4TimeStepper, FilteredETDRK4TimeStepper}, stop_time) =
error("step_until! requires fully explicit time stepper; does not work with ETDRK4")
function step_until!(prob, timestepper, stop_time)
# Throw an error if stop_time is not greater than the current problem time
stop_time > prob.clock.t || error("stop_time must be greater than prob.clock.t")
# Extract current time step
dt = prob.clock.dt
# Step forward until just before stop_time
time_interval = stop_time - prob.clock.t
nsteps = floor(Int, time_interval / dt)
stepforward!(prob, nsteps)
# Take one final small step so that prob.clock.t = stop_time
t_remaining = time_interval - prob.clock.t
prob.clock.dt = t_remaining
stepforward!(prob)
# Restore previous time-step
prob.clock.dt = dt
return nothing
end