Skip to content

Commit

Permalink
update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickersing committed Jan 23, 2024
1 parent 2c55e29 commit 9ab4208
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/TrixiShallowWater.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module TrixiShallowWater
# TODO: rewrite this
# We decided to import only Trixi.jl and qualify symbols explicitly with e.g. `Trixi.function_name`.
# While we do using Trixi.jl to extend a method from Trixi.jl symbols need to be qualified explicitly
# e.g. `Trixi.function_name`.
# For more information, see
# https://github.com/trixi-framework/TrixiShallowWater.jl/pull/10#discussion_r1433720559
using Trixi
Expand Down
5 changes: 5 additions & 0 deletions src/equations/shallow_water_wet_dry_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ Trixi.varnames(::typeof(cons2cons), ::ShallowWaterEquationsWetDry2D) = ("h", "h_
Trixi.varnames(::typeof(cons2prim), ::ShallowWaterEquationsWetDry2D) = ("H", "v1", "v2",
"b")

# This equation set extends the basic ShallowWaterEquations2D from Trixi.jl with additional
# functionality for wet/dry transitions. Since many functions correspond to the fully wet case, we
# make use of the exisiting functionality and introduce a number of wrapper functions, that dispatch
# to the ShallowWaterEquations2D.

# Set initial conditions at physical location `x` for time `t`
"""
initial_condition_convergence_test(x, t, equations::ShallowWaterEquationsWetDry2D)
Expand Down

0 comments on commit 9ab4208

Please sign in to comment.