Skip to content

Commit

Permalink
fix cross references for the mlswe
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickersing committed Apr 2, 2024
1 parent adfe299 commit c4136e9
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
9 changes: 4 additions & 5 deletions src/equations/shallow_water_multilayer_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This affects the implementation and use of these equations in various ways:
* The flux values corresponding to the bottom topography must be zero.
* The bottom topography values must be included when defining initial conditions, boundary
conditions or source terms.
* [`AnalysisCallback`](@ref) analyzes this variable.
* [`Trixi.AnalysisCallback`](@extref) analyzes this variable.
* Trixi's visualization tools will visualize the bottom topography by default.
A good introduction for the MLSWE is available in Chapter 12 of the book:
Expand All @@ -50,7 +50,6 @@ A good introduction for the MLSWE is available in Chapter 12 of the book:
<https://www.sciencedirect.com/bookseries/international-geophysics/vol/101/suppl/C>\
ISBN: 978-0-12-088759-0
"""

struct ShallowWaterMultiLayerEquations1D{NVARS, NLAYERS, RealT <: Real} <:
AbstractShallowWaterMultiLayerEquations{1, NVARS, NLAYERS}
gravity::RealT # gravitational constant
Expand Down Expand Up @@ -128,7 +127,7 @@ end
A smooth initial condition for a three-layer configuration used for convergence tests in combination with
[`source_terms_convergence_test`](@ref) (and
[`BoundaryConditionDirichlet(initial_condition_convergence_test)`](@ref) in non-periodic domains).
[`Trixi.BoundaryConditionDirichlet`](@extref) in non-periodic domains).
"""
function Trixi.initial_condition_convergence_test(x, t,
equations::ShallowWaterMultiLayerEquations1D)
Expand Down Expand Up @@ -156,7 +155,7 @@ end
Source terms used for convergence tests with a three-layer configuration in combination with
[`initial_condition_convergence_test`](@ref)
(and [`BoundaryConditionDirichlet(initial_condition_convergence_test)`](@ref)
(and [`Trixi.BoundaryConditionDirichlet`](@extref)
in non-periodic domains).
"""
@inline function Trixi.source_terms_convergence_test(u, x, t,
Expand Down Expand Up @@ -316,7 +315,7 @@ When the bottom topography is nonzero this scheme will be well-balanced when use
nonconservative [`flux_nonconservative_ersing_etal`](@ref).
To obtain an entropy stable formulation the `surface_flux` can be set as
[`FluxPlusDissipation(flux_ersing_etal, DissipationLocalLaxFriedrichs()), flux_nonconservative_ersing_etal`](@ref).
`FluxPlusDissipation(flux_ersing_etal, DissipationLocalLaxFriedrichs()), flux_nonconservative_ersing_etal`.
In the two-layer setting this combination is equivalent to the fluxes in:
- Patrick Ersing, Andrew R. Winters (2023)
Expand Down
4 changes: 2 additions & 2 deletions src/equations/shallow_water_wet_dry_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ end
equations::ShallowWaterEquationsWetDry1D)
Non-symmetric two-point surface flux that discretizes the nonconservative (source) term.
The discretization uses the `hydrostatic_reconstruction_audusse_etal` on the conservative
The discretization uses the [`hydrostatic_reconstruction_audusse_etal`](@ref) on the conservative
variables.
This hydrostatic reconstruction ensures that the finite volume numerical fluxes remain
Expand All @@ -276,7 +276,7 @@ end
equations::ShallowWaterEquationsWetDry1D)
Non-symmetric two-point surface flux that discretizes the nonconservative (source) term.
The discretization uses the `hydrostatic_reconstruction_chen_noelle` on the conservative
The discretization uses the [`hydrostatic_reconstruction_chen_noelle`](@ref) on the conservative
variables.
Should be used together with [`Trixi.FluxHydrostaticReconstruction`](@extref) and
Expand Down
2 changes: 1 addition & 1 deletion src/equations/shallow_water_wet_dry_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ end
equations::ShallowWaterEquationsWetDry2D)
Non-symmetric two-point surface flux that discretizes the nonconservative (source) term.
The discretization uses the `hydrostatic_reconstruction_audusse_etal` on the conservative
The discretization uses the [`hydrostatic_reconstruction_audusse_etal`](@ref) on the conservative
variables.
This hydrostatic reconstruction ensures that the finite volume numerical fluxes remain
Expand Down

0 comments on commit c4136e9

Please sign in to comment.