Changelog

TrixiShallowWater.jl follows the interpretation of semantic versioning (semver) used in the Julia ecosystem. Notable changes will be documented in this file for human readability.

Changes when updating to v0.3 from v0.2.x

Added

ShallowWaterExner extended to 2D curvilinear meshes (#159).
New equation type HyperbolicSainteMarieEquations1D has been added (#135).

Changed

Trixi.jl v0.17.0 is now required, resulting in changes to the signature of NonConservative jump terms (#160). Moreover, the method of flux_nonconservative_chan_etal accepting two normals was removed (#164).

Deprecated

Removed

Changes in the v0.2 lifecycle

Added

Introduce node-wise limiting functionality for the ShallowWaterMultiLayerEquations2D. (#111)
New equation types ShallowWaterMomentEquations1D and ShallowWaterLinearizedMomentEquations1D have been added. (#128)
ShallowWaterExner extended to 2D on TreeMesh (#150).
Experimental support for rainfall & soil infiltration source terms for ShallowWaterEquations1D and ShallowWaterEquations2D. (#158)
New variants of limiter_shallow_water! needed to ensure positivity preservation after coarsening and refinement steps in AMR via the keyword argument limiter! in AMRCallback (#164 and #167). For details on this callback see (#2396) in Trixi.jl. This made the specialized refine! and coarsen! introduced in #97 obsolete, which is why they were removed (#164).

Changed

Velocity desingularization procedure has been moved into a distinct VelocityDesingularization stage callback. (#111)

Deprecated

Removed

Changes when updating to v0.2 from v0.1.x

Added

New equation ShallowWaterEquationsQuasi1D and functions FluxHydrostaticReconstruction, flux_nonconservative_audusse_etal, and hydrostatic_reconstruction_audusse_etal are now available through TrixiShallowWater.jl instead of Trixi.jl. (#96)

Changed

ShallowWaterEquationsWetDry have been renamed to ShallowWaterEquations. The source code for these equations is now implemented directly in TrixiShallowWater.jl (#96).

Deprecated

Removed

Changes in the v0.1 lifecycle

Added

Experimental support for well-balanced mortars together with AMR #45
New boundary conditions BoundaryConditionWaterHeight and BoundaryConditionMomentum now available for the ShallowWaterEquationsWetDry to impose either the water height or the momentum at the boundary. #91