Skip to content

Commit

Permalink
update diagnostic
Browse files Browse the repository at this point in the history
  • Loading branch information
simone-silvestri committed Jan 27, 2024
1 parent d141ed9 commit 76bafd8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# WenoNeverworld.jl

<a href="https://mit-license.org">
<!-- <a href="https://mit-license.org">
<img alt="MIT license" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square">
</a>
<a href="https://simone-silvestri.github.io/WenoNeverworld.jl/dev">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-stable%20release-red?style=flat-square">
</a>
<a href="https://github.com/SciML/ColPrac">
<img alt="ColPrac: Contributor's Guide on Collaborative Practices for Community Packages" src="https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet?style=flat-square">
<img alt="ColPrac: Contributor's Guide on Collaborative Practices for Community Packages" src="https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet?style=flat-square"> -->
10 changes: 5 additions & 5 deletions src/Diagnostics/diagnostic_fields.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,37 @@ import Oceananigans.Models.HydrostaticFreeSurfaceModels: VerticalVorticityField
Returns the three-dimensional vertical vorticity at time index i.
"""
VerticalVorticity(f::Dict, i) = compute!(Field(VerticalVorticityOperation(f, i)))
VerticalVorticity(f::Dict, i; indices = (:, :, :)) = compute!(Field(VerticalVorticityOperation(f, i)); indices)


"""
KineticEnergy(f::Dict, i)
Returns the three-dimensional kinetic energy at time index i.
"""
KineticEnergy(f::Dict, i) = compute!(Field(KineticEnergyOperation(f, i)))
KineticEnergy(f::Dict, i; indices = (:, :, :)) = compute!(Field(KineticEnergyOperation(f, i)); indices)


"""
Stratification(f::Dict, i)
Returns the three-dimensional stratification at time index i.
"""
Stratification(f::Dict, i) = compute!(Field(StratificationOperation(f, i)))
Stratification(f::Dict, i; indices = (:, :, :)) = compute!(Field(StratificationOperation(f, i)); indices)

"""
PotentialVorticity(f::Dict, i)
Returns the three-dimensional potential vorticity at time index i.
"""
PotentialVorticity(f::Dict, i) = compute!(Field(PotentialVorticityOperation(f, i)))
PotentialVorticity(f::Dict, i; indices = (:, :, :)) = compute!(Field(PotentialVorticityOperation(f, i)); indices)

"""
DensityField(b::Field; ρ₀ = 1000.0, g = 9.80655)
Returns the three-dimensional density given a buoyancy field b.
"""
DensityField(b::Field; ρ₀ = 1000.0, g = 9.80655) = compute!(Field(DensityOperation(b; ρₒ, g)))
DensityField(b::Field; ρ₀ = 1000.0, g = 9.80655, indices = (:, :, :)) = compute!(Field(DensityOperation(b; ρₒ, g); indices))

"""
DeformationRadius(f::Dict, i)
Expand Down

0 comments on commit 76bafd8

Please sign in to comment.