Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Hendrik Ranocha <[email protected]>
  • Loading branch information
JoshuaLampert and ranocha authored Aug 24, 2024
1 parent 686ae52 commit b62ead0
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/equations/hyperbolic_serre_green_naghdi_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ end
"""
DispersiveShallowWater.energy_total_modified!(e, q_global, equations::HyperbolicSerreGreenNaghdiEquations1D, cache)
Return the modified total energy of the primitive variables `q_global` for the
Return the modified total energy `e` of the primitive variables `q_global` for the
[`HyperbolicSerreGreenNaghdiEquations1D`](@ref).
It contains additional terms compared to the usual [`energy_total`](@ref)
modeling non-hydrostatic contributions. The `energy_total_modified`
Expand Down
2 changes: 1 addition & 1 deletion src/equations/serre_green_naghdi_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,7 @@ end
"""
DispersiveShallowWater.energy_total_modified!(q_global, equations::SerreGreenNaghdiEquations1D, cache)
Return the modified total energy of the primitive variables `q_global` for the
Return the modified total energy `e` of the primitive variables `q_global` for the
[`SerreGreenNaghdiEquations1D`](@ref).
It contains an additional term containing a
derivative compared to the usual [`energy_total`](@ref) modeling
Expand Down
4 changes: 2 additions & 2 deletions src/equations/svaerd_kalisch_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -401,9 +401,9 @@ end

# The modified entropy/energy takes the whole `q` for every point in space
"""
DispersiveShallowWater.energy_total_modified!(q_global, equations::SvaerdKalischEquations1D, cache)
DispersiveShallowWater.energy_total_modified!(e, q_global, equations::SvaerdKalischEquations1D, cache)
Return the modified total energy of the primitive variables `q_global` for the
Return the modified total energy `e` of the primitive variables `q_global` for the
[`SvaerdKalischEquations1D`](@ref). It contains an additional term containing a
derivative compared to the usual [`energy_total`](@ref) modeling
non-hydrostatic contributions. The `energy_total_modified`
Expand Down

0 comments on commit b62ead0

Please sign in to comment.