Functions
Functions exported from GeophysicalFlows
:
Functions exported from TwoDNavierStokes
:
GeophysicalFlows.TwoDNavierStokes.Problem
— MethodProblem(; parameters...)
Construct a 2D turbulence problem.
GeophysicalFlows.TwoDNavierStokes.dissipation
— Methoddissipation(prob)
Returns the domain-averaged dissipation rate. nν must be >= 1.
GeophysicalFlows.TwoDNavierStokes.drag
— Methoddrag(prob)
Returns the extraction of domain-averaged energy by drag/hypodrag μ.
GeophysicalFlows.TwoDNavierStokes.energy
— Methodenergy(prob)
Returns the domain-averaged kinetic energy in the Fourier-transformed vorticity solution sol
.
GeophysicalFlows.TwoDNavierStokes.enstrophy
— Methodenstrophy(prob)
Returns the domain-averaged enstrophy in the Fourier-transformed vorticity solution sol
.
GeophysicalFlows.TwoDNavierStokes.set_zeta!
— Methodset_zeta!(prob, zeta)
Set the solution sol as the transform of zeta and update variables v on the grid g.
GeophysicalFlows.TwoDNavierStokes.updatevars!
— Methodupdatevars!(prob)
Update the vars in v on the grid g with the solution in sol.
GeophysicalFlows.TwoDNavierStokes.work
— Methodwork(prob)
work(sol, v, g)
Returns the domain-averaged rate of work of energy by the forcing Fh.
Functions exported from BarotropicQG
:
GeophysicalFlows.BarotropicQG.dissipation
— Methoddissipation(prob)
dissipation(s, v, p, g)
Returns the domain-averaged dissipation rate. nν must be >= 1.
GeophysicalFlows.BarotropicQG.drag
— Methoddrag(prob)
drag(s, v, p, g)
Returns the extraction of domain-averaged energy by drag μ.
GeophysicalFlows.BarotropicQG.energy
— Methodenergy(sol, g)
energy(prob)
Returns the domain-averaged kinetic energy of sol.
GeophysicalFlows.BarotropicQG.enstrophy
— Methodenstrophy(sol, g, v)
enstrophy(prob)
Returns the domain-averaged enstrophy of sol.
GeophysicalFlows.BarotropicQG.meanenergy
— Methodmeanenergy(prob)
Returns the energy of the domain-averaged U.
GeophysicalFlows.BarotropicQG.meanenstrophy
— Methodmeanenstrophy(prob)
Returns the enstrophy of the domain-averaged U.
GeophysicalFlows.BarotropicQG.set_zeta!
— Methodset_zeta!(prob, zeta)
set_zeta!(s, v, g, zeta)
Set the solution sol as the transform of zeta and update variables v on the grid g.
GeophysicalFlows.BarotropicQG.updatevars!
— Methodupdatevars!(v, s, g)
Update the vars in v on the grid g with the solution in sol.
GeophysicalFlows.BarotropicQG.work
— Methodwork(prob)
work(s, v, p, g)
Returns the domain-averaged rate of work of energy by the forcing Fqh.
Functions exported from BarotropicQGQL
:
GeophysicalFlows.BarotropicQGQL.Problem
— MethodProblem(; parameters...)
Construct a BarotropicQGQL turbulence problem.
GeophysicalFlows.BarotropicQGQL.dissipation
— Methoddissipation(prob)
dissipation(sol, v, p, g)
Returns the domain-averaged dissipation rate. nnu must be >= 1.
GeophysicalFlows.BarotropicQGQL.drag
— Methoddrag(prob)
drag(sol, v, p, g)
Returns the extraction of domain-averaged energy by drag mu.
GeophysicalFlows.BarotropicQGQL.energy
— Methodenergy(sol, g)
energy(prob)
Returns the domain-averaged kinetic energy of sol.
GeophysicalFlows.BarotropicQGQL.enstrophy
— Methodenstrophy(sol, g, v)
enstrophy(prob)
Returns the domain-averaged enstrophy of sol.
GeophysicalFlows.BarotropicQGQL.set_zeta!
— Methodset_zeta!(prob, zeta)
set_zeta!(sol, v, g, zeta)
Set the solution sol as the transform of zeta and update variables v on the grid g.
GeophysicalFlows.BarotropicQGQL.updatevars!
— Methodupdatevars!(v, s, g)
Update the vars in v on the grid g with the solution in sol.
GeophysicalFlows.BarotropicQGQL.work
— Methodwork(prob)
work(sol, v, p, g)
Returns the domain-averaged rate of work of energy by the forcing Fh.
Functions exported from MultilayerQG
:
GeophysicalFlows.MultilayerQG.energies
— Methodenergies(prob)
Returns the kinetic energy of each fluid layer KE1,...,KEnlayers, and the potential energy of each fluid interface PE{3/2},...,PE{nlayers-1/2}.
GeophysicalFlows.MultilayerQG.fluxes
— Methodfluxes(prob)
Returns the lateral eddy fluxes within each fluid layer lateralfluxes1,...,lateralfluxesnlayers and also the vertical eddy fluxes for each fluid interface verticalfluxes{3/2},...,verticalfluxes{nlayers-1/2}
GeophysicalFlows.MultilayerQG.set_psi!
— Methodset_psi!(prob)
Set the solution prob.sol
to correspond to a streamfunction psi
and updates variables.
GeophysicalFlows.MultilayerQG.set_q!
— Methodset_q!(prob)
Set the solution prob.sol
as the transform of q
and updates variables.
GeophysicalFlows.MultilayerQG.updatevars!
— Methodupdatevars!(prob)
Update prob.vars
using prob.sol
.