Skip to content

Commit 8fcecc4

Browse files
Fix docstrings for the ShallowWaterEquations3D (#90)
* fix docstrings * Apply suggestions from code review Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com> --------- Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
1 parent 83b4e90 commit 8fcecc4

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/equations/shallow_water_3d.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,9 @@ end
115115
end
116116

117117
"""
118-
flux_wintermeyer_etal(u_ll, u_rr, orientation_or_normal_direction,
119-
equations::ShallowWaterEquations2D)
118+
flux_wintermeyer_etal(u_ll, u_rr,
119+
normal_direction::AbstractVector,
120+
equations::ShallowWaterEquations3D)
120121
121122
Total energy conservative (mathematical entropy for shallow water equations) split form.
122123
When the bottom topography is nonzero this scheme will be well-balanced when used as a `volume_flux`.
@@ -160,8 +161,9 @@ Further details are available in Theorem 1 of the paper:
160161
end
161162

162163
"""
163-
flux_fjordholm_etal(u_ll, u_rr, orientation,
164-
equations::ShallowWaterEquations1D)
164+
flux_fjordholm_etal(u_ll, u_rr,
165+
normal_direction::AbstractVector,
166+
equations::ShallowWaterEquations3D)
165167
166168
Total energy conservative (mathematical entropy for shallow water equations). When the bottom topography
167169
is nonzero this should only be used as a surface flux otherwise the scheme will not be well-balanced.

0 commit comments

Comments
 (0)