annotate +rv/ResidualViscosity.m @ 1158:2ba63553ccfc feature/rv

Add option to compute maximum neighbordhood residual
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Tue, 25 Jun 2019 14:14:25 +0200
parents 010bb2677230
children 1ad7da049b50
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
1 classdef ResidualViscosity < handle
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
2 properties
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
3 grid % grid
1017
2d7c1333bd6c Add support for using the ODE to approximate the time derivative in the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1016
diff changeset
4 Df % Diff op approximating the gradient of the flux f(u)
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
5 waveSpeed % Wave speed at each grid point, e.g f'(u). %TBD: Better naming?
1016
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
6 Cmax % Constant controlling relative amount of upwind dissipation
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
7 Cres % Constant controling relative amount of upwind dissipation
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
8 h % Length scale used for scaling the viscosity. Typically grid spacing.
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
9 normalization % Function used to normalize the residual such that it is amplified in the
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
10 % shocks and suppressed elsewhere.
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
11 Mres % Coefficients for the residual viscosity
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
12 Mfirst % Coefficients for the first order viscosity
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
13 fRes % Function handle for computing the residual.
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
14 end
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
15
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
16 methods
1016
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
17 % TBD: Decide on how to treat waveSpeed. It would be nice to just pass a constant value without
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
18 % wrapping it in a function.
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
19 function obj = ResidualViscosity(grid, Df, waveSpeed, Cmax, Cres, h, normalization, postProcess)
1150
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
20 default_arg('normalization',@(v)abs(obj.minmaxDiffNeighborhood1d(v)-norm(v-mean(v),inf)));
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
21 default_arg('postProcess','maximum neighbors');
1017
2d7c1333bd6c Add support for using the ODE to approximate the time derivative in the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1016
diff changeset
22 obj.Df = Df;
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
23 obj.waveSpeed = waveSpeed;
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
24 obj.h = h;
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
25 obj.Cmax = Cmax;
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
26
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
27 obj.Cres = Cres;
1016
4b42999874c0 Add lower level for boot-strapping to RungeKuttaExteriorRV
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1015
diff changeset
28 obj.normalization = normalization;
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
29 obj.grid = grid;
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
30 obj.Mres = obj.Cres*obj.h^2;
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
31 obj.Mfirst = obj.Cmax*obj.h;
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
32 switch postProcess
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
33 case 'none'
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
34 obj.fRes = @(v,dvdt) obj.Mres*abs(dvdt + obj.Df(v))./obj.normalization(v);
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
35 case 'maximum neighbors'
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
36 obj.fRes = @obj.maxResidualNeighbors
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
37 end
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
38 end
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
39
1152
010bb2677230 Clean up in +rv/+time. Make the time stepping more efficient by not storing unnessecary properties in the RK-RV time steppers
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1151
diff changeset
40 function viscosity = evaluateViscosity(obj, v, dvdt)
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
41 viscosity = min(obj.Mfirst*abs(obj.waveSpeed(v)), obj.fRes(v,dvdt));
1152
010bb2677230 Clean up in +rv/+time. Make the time stepping more efficient by not storing unnessecary properties in the RK-RV time steppers
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1151
diff changeset
42 end
010bb2677230 Clean up in +rv/+time. Make the time stepping more efficient by not storing unnessecary properties in the RK-RV time steppers
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1151
diff changeset
43
1031
2ef20d00b386 For easier comparison, return both the first order and residual viscosity when evaluating the residual. Add the first order and residual viscosity to the state of the RungekuttaRV time steppers
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1017
diff changeset
44 function [viscosity, Df, firstOrderViscosity, residualViscosity] = evaluate(obj, v, dvdt)
1017
2d7c1333bd6c Add support for using the ODE to approximate the time derivative in the residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1016
diff changeset
45 Df = obj.Df(v);
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
46 firstOrderViscosity = obj.Mfirst*abs(obj.waveSpeed(v));
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
47 residualViscosity = obj.fRes(v,dvdt);
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
48 viscosity = min(firstOrderViscosity, obj.fRes(v,dvdt));
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
49 end
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
50 function res = maxResidualNeighbors(obj,v,dvdt)
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
51 res = obj.Mres*abs(dvdt + obj.Df(v))./obj.normalization(v);
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
52 resMat = grid.funcToMatrix(obj.grid,res);
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
53 res = reshape(max(movmax(resMat,3,1),movmax(resMat,3,2))',obj.grid.N(),1);
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
54 end
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
55 end
1150
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
56 methods (Static)
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
57 function minmaxDiff = minmaxDiffNeighborhood1d(u)
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
58 umax = movmax(u,3);
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
59 umin = movmin(u,3);
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
60 minmaxDiff = umax - umin;
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
61 end
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
62
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
63 function minmaxDiff = minmaxDiffNeighborhood2d(grid, u)
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
64 uMatrix = grid.funcToMatrix(grid,u);
1150
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
65 umax = max(movmax(uMatrix,3,1),movmax(uMatrix,3,2));
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
66 umin = min(movmin(uMatrix,3,1),movmin(uMatrix,3,2));
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
67 minmaxDiff = umax - umin;
1158
2ba63553ccfc Add option to compute maximum neighbordhood residual
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1152
diff changeset
68 minmaxDiff = reshape(minmaxDiff',g.N(),1);
1150
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
69 end
922996695952 Implement local residual normalization functions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1039
diff changeset
70 end
1012
1e437c9e5132 Create residual viscosity package +rv and generalize the ResidualViscosity class
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
71 end