view +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
line wrap: on
line source

% Creates a Cartesian grid of dimension length(m)
% over the domain xlim, ylim, ...
% The grid is non-equidistant in the boundary regions,
% 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
            matchingParams = iscell([varargin{1:n}]) && ...
                             isfloat([varargin{n+1}]);
    elseif length(varargin) == n+2 % Stencil options supplied
            matchingParams = iscell([varargin{1:n}]) && ...
                             isfloat([varargin{n+1}]) && ...
                             ischar([varargin{n+2}]);
    end
    assert(matchingParams,'grid:boundaryoptimized:NonMatchingParameters','The number of parameters per dimensions do not match.');

    % Check that stencil options are passed correctly (if supplied)
    if length(varargin) == n+2 % Stencil options supplied
        availabe_opts = ["Accurate","accurate","A","Minimal","minimal","M"];
        assert(any(varargin{n+2} == availabe_opts), ...
            'grid:boundaryoptimized:InvalidOption',"The operator option must be 'accurate' or 'minimal.'");
    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'}
            gridgenerator = @sbp.util.accurateBoundaryOptimizedGrid;
        case {'Minimal','minimal','M'}
            gridgenerator = @sbp.util.minimalBoundaryOptimizedGrid;
    end

    X = {};
    h = [];
    for i = 1:n
        try
            [X{i},h(i)] = gridgenerator(varargin{i},m(i),varargin{n+1});
        catch exception % Propagate any errors in the grid generation functions.
            msgText = getReport(exception);
            error('grid:boundaryoptimized:InvalidParameter',msgText)
        end
    end

    g = grid.Cartesian(X{:});
    g.h = h;
end