Unify boundary conditions (#126)

* unify boundary conditions

* explicitly pass periodicity and periodic bc

* require Trixi.jl v0.15 for docs

* fix missing periodic boundary conditions

* fix tests

---------

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

Author: JoshuaLampert

Project.toml

@@ -19,5 +19,5 @@ Printf = "1"
 Roots = "2.1.6"
 Static = "1.1.1"
 StaticArrays = "1.9"
-Trixi = "0.14"
+Trixi = "0.15"
 julia = "1.10"

docs/Project.toml

@@ -25,6 +25,6 @@ HOHQMesh = "0.2"
 Literate = "2.20"
 OrdinaryDiffEqLowStorageRK = "1.3"
 OrdinaryDiffEqSSPRK = "1.2"
-Trixi = "0.14"
+Trixi = "0.15"
 Trixi2Vtk = "0.3.16"
 TrixiBottomTopography = "0.1"

docs/src/tutorials/elixir_shallowwater_monai_tsunami.jl

@@ -255,10 +255,10 @@ end;
 # are the default names provided by HOHQMesh. As per the problem definition,
 # three of the domain boundaries are walls and the incident wave maker boundary condition
 # implemented above is set at the `Left` domain
-boundary_condition = Dict(:Bottom => boundary_condition_slip_wall,
-                          :Top => boundary_condition_slip_wall,
-                          :Right => boundary_condition_slip_wall,
-                          :Left => boundary_condition_wave_maker);
+boundary_condition = (; Bottom = boundary_condition_slip_wall,
+                      Top = boundary_condition_slip_wall,
+                      Right = boundary_condition_slip_wall,
+                      Left = boundary_condition_wave_maker);
 
 # For this application, we also need to model the bottom friction.
 # Thus, we create a new source term, which adds a Manning friction term to the momentum equations.

examples/dgmulti_1d/elixir_shallow_water_quasi_1d.jl

@@ -16,7 +16,7 @@ volume_flux = (flux_chan_etal, flux_nonconservative_chan_etal)
 # In the `StepsizeCallback`, though, the less diffusive `max_abs_speeds` is employed which is consistent with `max_abs_speed`.
 # Thus, we exchanged in PR#2458 of Trixi.jl the default wave speed used in the LLF flux and dissipation operator to `max_abs_speed`.
 # To ensure that every example still runs we specify explicitly `DissipationLocalLaxFriedrichs(max_abs_speed_naive)`.
-# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the 
+# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the
 # `StepsizeCallback` (CFL-Condition) and less diffusion.
 surface_flux = (FluxPlusDissipation(flux_chan_etal,
                                     DissipationLocalLaxFriedrichs(max_abs_speed_naive)),
@@ -31,7 +31,8 @@ mesh = DGMultiMesh(dg, cells_per_dimension,
                    coordinates_min = (0.0,), coordinates_max = (sqrt(2),),
                    periodicity = true)
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, dg;
-                                    source_terms = source_terms_convergence_test)
+                                    source_terms = source_terms_convergence_test,
+                                    boundary_conditions = boundary_condition_periodic)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

examples/dgmulti_2d/elixir_shallowwater_source_terms.jl

@@ -15,7 +15,7 @@ volume_flux = (flux_wintermeyer_etal, flux_nonconservative_wintermeyer_etal)
 # In the `StepsizeCallback`, though, the less diffusive `max_abs_speeds` is employed which is consistent with `max_abs_speed`.
 # Thus, we exchanged in PR#2458 of Trixi.jl the default wave speed used in the LLF flux to `max_abs_speed`.
 # To ensure that every example still runs we specify explicitly `FluxLaxFriedrichs(max_abs_speed_naive)`.
-# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the 
+# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the
 # `StepsizeCallback` (CFL-Condition) and less diffusion.
 surface_flux = (FluxLaxFriedrichs(max_abs_speed_naive), flux_nonconservative_fjordholm_etal)
 dg = DGMulti(polydeg = 3, element_type = Quad(), approximation_type = SBP(),
@@ -28,7 +28,8 @@ mesh = DGMultiMesh(dg, cells_per_dimension,
                    periodicity = true)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, dg;
-                                    source_terms = source_terms_convergence_test)
+                                    source_terms = source_terms_convergence_test,
+                                    boundary_conditions = boundary_condition_periodic)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

examples/p4est_2d_dgsem/elixir_shallowwater_multilayer_blast_wet_dry_sc_subcell.jl

@@ -4,7 +4,7 @@ using Trixi
 using TrixiShallowWater
 
 ###############################################################################
-# Semidiscretization of the multilayer shallow water equations with a single layer and a bottom 
+# Semidiscretization of the multilayer shallow water equations with a single layer and a bottom
 # topography function for a blast wave test with a wet/dry front with discontinuous initial conditions.
 # This example combines the subcell limiter with a velocity desingularization callback to ensure
 # robustness at wet/dry fronts.
@@ -36,10 +36,10 @@ end
 
 initial_condition = initial_condition_blast_wave
 
-boundary_condition = Dict(:x_neg => boundary_condition_slip_wall,
-                          :y_neg => boundary_condition_slip_wall,
-                          :x_pos => boundary_condition_slip_wall,
-                          :y_pos => boundary_condition_slip_wall)
+boundary_condition = (; x_neg = boundary_condition_slip_wall,
+                      y_neg = boundary_condition_slip_wall,
+                      x_pos = boundary_condition_slip_wall,
+                      y_pos = boundary_condition_slip_wall)
 
 ###############################################################################
 # Get the DG approximation space
@@ -66,7 +66,7 @@ solver = DGSEM(basis, surface_flux, volume_integral)
 # Get the P4estMesh
 
 coordinates_min = (0.0, 0.0) # minimum coordinates (min(x), min(y))
-coordinates_max = (4.0, 4.0)  # maximum coordinates (max(x), max(y))
+coordinates_max = (4.0, 4.0) # maximum coordinates (max(x), max(y))
 
 trees_per_dimension = (1, 1)
 
@@ -106,7 +106,7 @@ callbacks = CallbackSet(summary_callback, analysis_callback, alive_callback, sav
 
 ###############################################################################
 
-# Setup the stage callbacks 
+# Setup the stage callbacks
 stage_limiter! = VelocityDesingularization()
 stage_callbacks = (SubcellLimiterIDPCorrection(), stage_limiter!)
 

examples/p4est_2d_dgsem/elixir_shallowwater_multilayer_convergence_sc_subcell.jl

@@ -39,7 +39,8 @@ mesh = P4estMesh(trees_per_dimension, polydeg = 3,
 
 # create the semi discretization object
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_convergence_test)
+                                    source_terms = source_terms_convergence_test,
+                                    boundary_conditions = boundary_condition_periodic)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

examples/p4est_2d_dgsem/elixir_shallowwater_multilayer_monai_flood_amr.jl

@@ -111,10 +111,10 @@ H_from_wave_maker(t::RealT) = spline_interpolation(h_spline_struct, t)
     return flux, noncons_flux
 end
 
-boundary_condition = Dict(:Bottom => boundary_condition_slip_wall,
-                          :Top => boundary_condition_slip_wall,
-                          :Right => boundary_condition_slip_wall,
-                          :Left => boundary_condition_wave_maker)
+boundary_condition = (; Bottom = boundary_condition_slip_wall,
+                      Top = boundary_condition_slip_wall,
+                      Right = boundary_condition_slip_wall,
+                      Left = boundary_condition_wave_maker)
 
 # Manning friction source term
 @inline function source_terms_manning_friction(u, x, t,
@@ -147,7 +147,7 @@ volume_flux = (flux_ersing_etal, flux_nonconservative_ersing_etal)
 # In the `StepsizeCallback`, though, the less diffusive `max_abs_speeds` is employed which is consistent with `max_abs_speed`.
 # Thus, we exchanged in PR#2458 of Trixi.jl the default wave speed used in the LLF flux and dissipation operator to `max_abs_speed`.
 # To ensure that every example still runs we specify explicitly `DissipationLocalLaxFriedrichs(max_abs_speed_naive)`.
-# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the 
+# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the
 # `StepsizeCallback` (CFL-Condition) and less diffusion.
 surface_flux = (FluxHydrostaticReconstruction(FluxPlusDissipation(flux_ersing_etal,
                                                                   DissipationLocalLaxFriedrichs(max_abs_speed_naive)),

examples/p4est_2d_dgsem/elixir_shallowwater_multilayer_perturbation_wet_dry_amr.jl

@@ -48,7 +48,7 @@ end
 initial_condition = initial_condition_perturbation
 
 # Wall BCs
-boundary_condition = Dict(:all => boundary_condition_slip_wall)
+boundary_condition = (; all = boundary_condition_slip_wall)
 
 ###############################################################################
 # Get the DG approximation space
@@ -60,7 +60,7 @@ volume_flux = (flux_ersing_etal, flux_nonconservative_ersing_etal)
 # In the `StepsizeCallback`, though, the less diffusive `max_abs_speeds` is employed which is consistent with `max_abs_speed`.
 # Thus, we exchanged in PR#2458 of Trixi.jl the default wave speed used in the LLF flux and dissipation operator to `max_abs_speed`.
 # To ensure that every example still runs we specify explicitly `DissipationLocalLaxFriedrichs(max_abs_speed_naive)`.
-# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the 
+# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the
 # `StepsizeCallback` (CFL-Condition) and less diffusion.
 surface_flux = (FluxHydrostaticReconstruction(FluxPlusDissipation(flux_ersing_etal,
                                                                   DissipationLocalLaxFriedrichs(max_abs_speed_naive)),

examples/p4est_2d_dgsem/elixir_shallowwater_multilayer_three_mound_dam_break_amr.jl

@@ -80,10 +80,10 @@ function boundary_condition_outflow(u_inner, normal_direction::AbstractVector, x
     return flux, noncons_flux
 end
 
-boundary_conditions = Dict(:Bottom => boundary_condition_slip_wall,
-                           :Top => boundary_condition_slip_wall,
-                           :Right => boundary_condition_outflow,
-                           :Left => boundary_condition_slip_wall)
+boundary_conditions = (; Bottom = boundary_condition_slip_wall,
+                       Top = boundary_condition_slip_wall,
+                       Right = boundary_condition_outflow,
+                       Left = boundary_condition_slip_wall)
 
 ###############################################################################
 # Get the DG approximation space
@@ -95,7 +95,7 @@ volume_flux = (flux_ersing_etal, flux_nonconservative_ersing_etal)
 # In the `StepsizeCallback`, though, the less diffusive `max_abs_speeds` is employed which is consistent with `max_abs_speed`.
 # Thus, we exchanged in PR#2458 of Trixi.jl the default wave speed used in the LLF flux and dissipation operator to `max_abs_speed`.
 # To ensure that every example still runs we specify explicitly `DissipationLocalLaxFriedrichs(max_abs_speed_naive)`.
-# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the 
+# We remark, however, that the now default `max_abs_speed` is in general recommended due to compliance with the
 # `StepsizeCallback` (CFL-Condition) and less diffusion.
 surface_flux = (FluxHydrostaticReconstruction(FluxPlusDissipation(flux_ersing_etal,
                                                                   DissipationLocalLaxFriedrichs(max_abs_speed_naive)),