From 9ab42089e1d42abd369e3cf049dd2279113eb263 Mon Sep 17 00:00:00 2001 From: patrickersing Date: Tue, 23 Jan 2024 09:44:15 +0100 Subject: [PATCH] update comments --- src/TrixiShallowWater.jl | 3 ++- src/equations/shallow_water_wet_dry_2d.jl | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/TrixiShallowWater.jl b/src/TrixiShallowWater.jl index 04d8066..a6ca0ab 100644 --- a/src/TrixiShallowWater.jl +++ b/src/TrixiShallowWater.jl @@ -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 diff --git a/src/equations/shallow_water_wet_dry_2d.jl b/src/equations/shallow_water_wet_dry_2d.jl index 67148da..0d9f287 100644 --- a/src/equations/shallow_water_wet_dry_2d.jl +++ b/src/equations/shallow_water_wet_dry_2d.jl @@ -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)