changeset 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
files +grid/boundaryoptimized.m +multiblock/+domain/Rectangle.m
diffstat 2 files changed, 11 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/+grid/boundaryoptimized.m	Wed Jul 01 17:34:40 2020 +0200
+++ b/+grid/boundaryoptimized.m	Tue Jul 07 16:00:24 2020 +0200
@@ -1,14 +1,14 @@
-% Creates a cartesian grid of dimension length(m)
-% over the doman xlim, ylim, ...
+% Creates a Cartesian grid of dimension length(m)
+% over the domain xlim, ylim, ...
 % The grid is non-equidistant in the boundary regions,
-% with node node placement based of boundary-optimized SBP operators.
+% with node placement based on boundary-optimized SBP operators.
 % Examples:
 %   g = grid.boundaryoptimized([mx, my], xlim, ylim, order, opt)
 %   g = grid.boundaryoptimized([10, 15], {0,1}, {0,2}, 4) - defaults to 'accurate' stencils
 %   g = grid.boundaryoptimized([10, 15], {0,1}, {0,2}, 4, 'minimal')
 function g = boundaryoptimized(m, varargin)
     n = length(m);
-    
+
     % Check that parameters matches dimensions
     matchingParams = false;
     if length(varargin) == n+1 % Minimal number of arguments
@@ -18,7 +18,7 @@
             matchingParams = iscell([varargin{1:n}]) && ...
                              isfloat([varargin{n+1}]) && ...
                              ischar([varargin{n+2}]);
-    end    
+    end
     assert(matchingParams,'grid:boundaryoptimized:NonMatchingParameters','The number of parameters per dimensions do not match.');
 
     % Check that stencil options are passed correctly (if supplied)
@@ -29,7 +29,7 @@
     else %If not passed, populate varargin with default option 'accurate'
         varargin(n+2) = {'accurate'};
     end
-    
+
     % Specify generating function
     switch varargin{n+2}
         case {'Accurate','accurate','A'}
--- a/+multiblock/+domain/Rectangle.m	Wed Jul 01 17:34:40 2020 +0200
+++ b/+multiblock/+domain/Rectangle.m	Tue Jul 07 16:00:24 2020 +0200
@@ -93,7 +93,7 @@
                 N_id = flat_index(m,j,1);
                 S{j} = {S_id,'s'};
                 N{j} = {N_id,'n'};
-            end  
+            end
             boundaryGroups.E = multiblock.BoundaryGroup(E);
             boundaryGroups.W = multiblock.BoundaryGroup(W);
             boundaryGroups.S = multiblock.BoundaryGroup(S);
@@ -117,19 +117,19 @@
         % Returns a multiblock.Grid given some parameters
         % ms: cell array of [mx, my] vectors
         % For same [mx, my] in every block, just input one vector.
-        % Currently defaults to equidistant grid if varargin is empty. 
-        % If varargin is non-empty, the first argument should supply the grid, followed by
+        % Currently defaults to equidistant grid if varargin is empty.
+        % If varargin is non-empty, the first argument should supply the grid type, followed by
         % additional arguments required to construct the grid.
         % Grid types:
         %          'equidist' - equidistant grid
         %                       Additional argumets: none
-        %          'boundaryopt' - boundary optimized grid based on boundary 
+        %          'boundaryopt' - boundary optimized grid based on boundary
         %                          optimized SBP operators
         %                          Additional arguments: order, stencil option
         % Example: g = getGrid() - the local blocks are 21x21 equidistant grids.
         %          g = getGrid(ms,) - block i is an equidistant grid with size given by ms{i}.
         %          g = getGrid(ms,'equidist') - block i is an equidistant grid with size given by ms{i}.
-        %          g = getGrid(ms,'boundaryopt',4,'minimal') - block i is an cartesian grid with size given by ms{i}
+        %          g = getGrid(ms,'boundaryopt',4,'minimal') - block i is a Cartesian grid with size given by ms{i}
         %              and nodes placed according to the boundary optimized minimal 4th order SBP operator.
         function g = getGrid(obj, ms, varargin)