Shallow Water

[garrettbyrd]

This PR adds the linear shallow water model in 2d with some examples included.

Documentation has been updated to:

• define the linear shallow water 2D model in the Models section
• describe a tutorial for a gaussian "drop" in a square domain with no-normal-flow boundary conditions.

The linear shallow water model does not include GPU acceleration (similar implementation to Burgers1D). No-normal-flow boundary conditions are implemented in the base model.

[fluidnumerics-joe]

To fix fprettify-lint failure, run the following

fprettify  './src/' --config-file ./fprettify.config --recursive --case 1 1 1 1
fprettify  './test/' --config-file ./fprettify.config --recursive --case 1 1 1 1
fprettify  './examples/' --config-file ./fprettify.config --recursive --case 1 1 1 1

And commit & push the changes up to the repo.. I'm sure we could write a bot for this at some point...

[fluidnumerics-joe]

I would increase the time limit for the github workflows -- the debug and coverage builds run quite slowly.

[fluidnumerics-joe]

/superci

[codecov]

Codecov Report

Attention: Patch coverage is 95.16129% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/SELF_LinearShallowWater2D_t.f90	97.36%	1 Missing ⚠️
src/cpu/SELF_LinearShallowWater2D.f90	0.00%	1 Missing ⚠️
src/gpu/SELF_LinearShallowWater2D.f90	95.65%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

[fluidnumerics-joe]

In addition to the above inline review comments, you'll need to add the Linear Shallow Water (2D) model and your tutorial to the appropriate spot in the nav: in the mkdocs.yml; currently, this model doesn't appear in the navigation on the rendered site. Other than those things, this is looking good.

[fluidnumerics-joe]

@garrettbyrd - We need to get full gpu offloading implemented for this one as well