Skip to content

Add functions to convert from sf to vorticity and vv. #138

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
merged 1 commit into from
Jul 10, 2025
Merged

Add functions to convert from sf to vorticity and vv. #138

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
52 changes: 51 additions & 1 deletion toolbox/+otp/+quasigeostrophic/QuasiGeostrophicProblem.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@
JacobianFlowVelocityMagnitudeVectorProduct
JacobianFlowVelocityMagnitudeAdjointVectorProduct
end

properties (Access = private)
Lxinternal
Lyinternal
L12internal
P1internal
P2internal
Pmtinternal
end

methods (Static)

Expand All @@ -39,8 +48,37 @@
end

end

methods (Access = public)

function q = streamfunction2vorticity(obj, psi)
L12 = obj.L12internal;
Lx = obj.Lxinternal;
Ly = obj.Lyinternal;
pmt = obj.Pmtinternal;
[nx, ny] = size(L12);

psi = reshape(psi, nx, ny, []);
q = -(pmt(Lx, psi) + pmt(psi, Ly));
q = reshape(q, nx*ny, []);
end

function psi = vorticity2streamfunction(obj, q)
L12 = obj.L12internal;
P1 = obj.P1internal;
P2 = obj.P2internal;
pmt = obj.Pmtinternal;
[nx, ny] = size(L12);

q = reshape(q, nx, ny, []);
psi = pmt(pmt(P1, L12.*pmt(pmt(P1, q), P2)), P2);
psi = reshape(psi, nx*ny, []);
end

end

methods (Access = protected)

function onSettingsChanged(obj)

nx = obj.Parameters.Nx;
Expand Down Expand Up @@ -96,7 +134,7 @@ function onSettingsChanged(obj)
L12 = -(hx2*hy2./(2*(-hx2 - hy2 + hy2*cos(pi*cx).' + hx2*cos(pi*cy))));
P1 = sqrt(2/(nx + 1))*sin(pi*(1:nx).'*(1:nx)/(nx + 1));
P2 = sqrt(2/(ny + 1))*sin(pi*(1:ny).'*(1:ny)/(ny + 1));

% define the ydomain for the external force
ys = linspace(ydomain(1), ydomain(end), ny + 2);
ys = ys(2:end-1);
Expand All @@ -112,6 +150,16 @@ function onSettingsChanged(obj)
else
pmt = @pagemtimes;
end

% set internal variables
obj.Lxinternal = Lx;
obj.Lyinternal = Ly;
obj.L12internal = L12;
obj.P1internal = P1;
obj.P2internal = P2;
obj.Pmtinternal = pmt;

% set right hand side

obj.RHS = otp.RHS(@(t, psi) ...
otp.quasigeostrophic.f(psi, Lx, Ly, P1, P2, L12, Dx, DxT, Dy, DyT, F, Re, Ro, pmt), ...
Expand Down Expand Up @@ -158,7 +206,9 @@ function onSettingsChanged(obj)
end

function sol = internalSolve(obj, varargin)

sol = [email protected](obj, 'Solver', otp.utils.Solver.Nonstiff, varargin{:});

end

end
Expand Down