Skip to content

Solve: minor bug with inputParser #1056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlbertoCuadra merged 1 commit into from
Apr 8, 2025
Merged

Solve: minor bug with inputParser #1056

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions +combustiontoolbox/+turbulence/@VelocityField/VelocityField.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
velocity.w = velocity.w - mean(velocity.w, 'all');
end

function velocity = getCrossplaneFluctuations(obj, varargin)
function velocity = getCrossplaneFluctuations(obj, axisType, varargin)
% Compute fluctuating velocity components
%
% Args:
Expand All @@ -170,31 +170,21 @@
% * The velocity field is assumed to be periodic in the direction perpendicular to the axis.
% * By default, the velocity is weighted by density, if provided.
%
% Shortcuts:
% * velocity = getCrossplaneFluctuations(obj, 'x');
%
% Examples:
% * velocity = getCrossplaneFluctuations(obj, 'x');
% * velocity = getCrossplaneFluctuations(obj, 'axis', 'x');
% * velocity = getCrossplaneFluctuations(obj, 'axis', 'x', 'density', rho);
% * velocity = getCrossplaneFluctuations(obj, 'axis', 'x', 'density', rho, 'weighted', true);
% * velocity = getCrossplaneFluctuations(obj, 'x', 'density', rho);
% * velocity = getCrossplaneFluctuations(obj, 'x', 'density', rho, 'weighted', true);

% Default
defaultDensity = [];
defaultAxis = [];
defaultWeighted = true;

% Shortcut: getCrossplaneFluctuations(obj, 'x')
if isscalar(varargin)
varargin = {'axis', varargin{1}};
end

% Parse input arguments
p = inputParser;
addRequired(p, 'axis', defaultAxis, @(x) ischar(x) && ismember(lower(x), {'x', 'y', 'z'}))
addRequired(p, 'axis', @(x) ischar(x) && ismember(lower(x), {'x', 'y', 'z'}))
addParameter(p, 'density', defaultDensity, @(x) isnumeric(x));
addParameter(p, 'weighted', defaultWeighted, @(x) islogical(x));
parse(p, varargin{:});
parse(p, axisType, varargin{:});

axisType = p.Results.axis;
rho = p.Results.density;
Expand Down