annotate +grid/boundaryoptimized.m @ 1296:2853b655c172 feature/boundary_optimized_grids

Fix typos in comments
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Tue, 07 Jul 2020 16:00:24 +0200
parents 2fd2e2337b77
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1296
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
1 % Creates a Cartesian grid of dimension length(m)
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
2 % over the domain xlim, ylim, ...
1289
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
3 % The grid is non-equidistant in the boundary regions,
1296
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
4 % with node placement based on boundary-optimized SBP operators.
1289
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
5 % Examples:
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
6 % g = grid.boundaryoptimized([mx, my], xlim, ylim, order, opt)
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
7 % g = grid.boundaryoptimized([10, 15], {0,1}, {0,2}, 4) - defaults to 'accurate' stencils
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
8 % g = grid.boundaryoptimized([10, 15], {0,1}, {0,2}, 4, 'minimal')
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
9 function g = boundaryoptimized(m, varargin)
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
10 n = length(m);
1296
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
11
1289
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
12 % Check that parameters matches dimensions
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
13 matchingParams = false;
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
14 if length(varargin) == n+1 % Minimal number of arguments
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
15 matchingParams = iscell([varargin{1:n}]) && ...
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
16 isfloat([varargin{n+1}]);
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
17 elseif length(varargin) == n+2 % Stencil options supplied
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
18 matchingParams = iscell([varargin{1:n}]) && ...
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
19 isfloat([varargin{n+1}]) && ...
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
20 ischar([varargin{n+2}]);
1296
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
21 end
1289
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
22 assert(matchingParams,'grid:boundaryoptimized:NonMatchingParameters','The number of parameters per dimensions do not match.');
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
23
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
24 % Check that stencil options are passed correctly (if supplied)
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
25 if length(varargin) == n+2 % Stencil options supplied
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
26 availabe_opts = ["Accurate","accurate","A","Minimal","minimal","M"];
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
27 assert(any(varargin{n+2} == availabe_opts), ...
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
28 'grid:boundaryoptimized:InvalidOption',"The operator option must be 'accurate' or 'minimal.'");
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
29 else %If not passed, populate varargin with default option 'accurate'
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
30 varargin(n+2) = {'accurate'};
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
31 end
1296
2853b655c172 Fix typos in comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1289
diff changeset
32
1289
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
33 % Specify generating function
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
34 switch varargin{n+2}
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
35 case {'Accurate','accurate','A'}
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
36 gridgenerator = @sbp.util.accurateBoundaryOptimizedGrid;
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
37 case {'Minimal','minimal','M'}
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
38 gridgenerator = @sbp.util.minimalBoundaryOptimizedGrid;
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
39 end
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
40
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
41 X = {};
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
42 h = [];
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
43 for i = 1:n
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
44 try
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
45 [X{i},h(i)] = gridgenerator(varargin{i},m(i),varargin{n+1});
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
46 catch exception % Propagate any errors in the grid generation functions.
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
47 msgText = getReport(exception);
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
48 error('grid:boundaryoptimized:InvalidParameter',msgText)
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
49 end
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
50 end
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
51
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
52 g = grid.Cartesian(X{:});
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
53 g.h = h;
2fd2e2337b77 Add utility function for constructing a (possibly multidimensional) grid based on the grid points used by the boundary optimized SBP operators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
54 end