Skip to content

Commit

Permalink
fix docstring of energy_total_modified
Browse files Browse the repository at this point in the history
  • Loading branch information
ranocha committed Aug 17, 2024
1 parent 7e28939 commit 59f7729
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/equations/serre_green_naghdi_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -831,15 +831,15 @@ derivative compared to the usual [`energy_total`](@ref) modeling
non-hydrostatic contributions. The [`energy_total_modified`](@ref)
is a conserved quantity (for periodic boundary conditions).
For a [`bathymetry_flat`](@ref) the total energy is given by
For a [`bathymetry_flat`](@ref) the total modified energy is given by
```math
\\frac{1}{2} g \\eta^2 + \\frac{1}{2} h v^2 + \\frac{1}{6} h^3 v_x^2.
```
For a [`bathymetry_mild_slope`](@ref) the total energy is given by
For a [`bathymetry_mild_slope`](@ref) the total modified energy is given by
```math
\\frac{1}{2} g \\eta^2 + \\frac{1}{2} h v^2 + \\frac{1}{6} h (-h v_x + 1.5 v b_x)^2.
```
For a [`bathymetry_variable`](@ref) the total energy has the additional term
For a [`bathymetry_variable`](@ref) the total modified energy has the additional term
```math
+ \\frac{1}{8} h (v b_x)^2.
```
Expand Down

0 comments on commit 59f7729

Please sign in to comment.