comparison +multiblock/+domain/Rectangle.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 b0208b130880
children e53b1e25970a
comparison
equal deleted inserted replaced
1290:b0208b130880 1296:2853b655c172
91 for j = 1:nx 91 for j = 1:nx
92 S_id = flat_index(m,j,ny); 92 S_id = flat_index(m,j,ny);
93 N_id = flat_index(m,j,1); 93 N_id = flat_index(m,j,1);
94 S{j} = {S_id,'s'}; 94 S{j} = {S_id,'s'};
95 N{j} = {N_id,'n'}; 95 N{j} = {N_id,'n'};
96 end 96 end
97 boundaryGroups.E = multiblock.BoundaryGroup(E); 97 boundaryGroups.E = multiblock.BoundaryGroup(E);
98 boundaryGroups.W = multiblock.BoundaryGroup(W); 98 boundaryGroups.W = multiblock.BoundaryGroup(W);
99 boundaryGroups.S = multiblock.BoundaryGroup(S); 99 boundaryGroups.S = multiblock.BoundaryGroup(S);
100 boundaryGroups.N = multiblock.BoundaryGroup(N); 100 boundaryGroups.N = multiblock.BoundaryGroup(N);
101 boundaryGroups.all = multiblock.BoundaryGroup([E,W,S,N]); 101 boundaryGroups.all = multiblock.BoundaryGroup([E,W,S,N]);
115 115
116 116
117 % Returns a multiblock.Grid given some parameters 117 % Returns a multiblock.Grid given some parameters
118 % ms: cell array of [mx, my] vectors 118 % ms: cell array of [mx, my] vectors
119 % For same [mx, my] in every block, just input one vector. 119 % For same [mx, my] in every block, just input one vector.
120 % Currently defaults to equidistant grid if varargin is empty. 120 % Currently defaults to equidistant grid if varargin is empty.
121 % If varargin is non-empty, the first argument should supply the grid, followed by 121 % If varargin is non-empty, the first argument should supply the grid type, followed by
122 % additional arguments required to construct the grid. 122 % additional arguments required to construct the grid.
123 % Grid types: 123 % Grid types:
124 % 'equidist' - equidistant grid 124 % 'equidist' - equidistant grid
125 % Additional argumets: none 125 % Additional argumets: none
126 % 'boundaryopt' - boundary optimized grid based on boundary 126 % 'boundaryopt' - boundary optimized grid based on boundary
127 % optimized SBP operators 127 % optimized SBP operators
128 % Additional arguments: order, stencil option 128 % Additional arguments: order, stencil option
129 % Example: g = getGrid() - the local blocks are 21x21 equidistant grids. 129 % Example: g = getGrid() - the local blocks are 21x21 equidistant grids.
130 % g = getGrid(ms,) - block i is an equidistant grid with size given by ms{i}. 130 % g = getGrid(ms,) - block i is an equidistant grid with size given by ms{i}.
131 % g = getGrid(ms,'equidist') - block i is an equidistant grid with size given by ms{i}. 131 % g = getGrid(ms,'equidist') - block i is an equidistant grid with size given by ms{i}.
132 % g = getGrid(ms,'boundaryopt',4,'minimal') - block i is an cartesian grid with size given by ms{i} 132 % g = getGrid(ms,'boundaryopt',4,'minimal') - block i is a Cartesian grid with size given by ms{i}
133 % and nodes placed according to the boundary optimized minimal 4th order SBP operator. 133 % and nodes placed according to the boundary optimized minimal 4th order SBP operator.
134 function g = getGrid(obj, ms, varargin) 134 function g = getGrid(obj, ms, varargin)
135 135
136 default_arg('ms',[21,21]) 136 default_arg('ms',[21,21])
137 137