Skip to content

Model Repositories#

SELF is the spectral element framework: the interpolants, the mapped geometry, the meshes, the DGModel1D, DGModel2D, and DGModel3D template classes, the boundary condition system, the time integrators, and the parallel and GPU infrastructure. The physical models that used to ship inside SELF have moved into their own repositories. Each one is built as a library against an installed SELF, and each one carries its own tests, examples, and documentation.

Repository Models Contents of docs/
SELF-LinearEuler LinearEuler2D, LinearEuler2D_PML, LinearEuler3D Model reference pages for the 2-D, 2-D PML, and 3-D linear Euler equations, and the plane wave, spherical sound wave, and perfectly matched layer tutorials
SELF-ShallowWater LinearShallowWater2D Model reference page for the linear shallow water equations, and the reflecting wave, Kelvin wave, and planetary Rossby wave tutorials
SELF-Burgers Burgers1D Model reference page for the viscous Burgers equation, and the traveling shock tutorial
SELF-ESAtmo ESAtmo2D, ESAtmo3D No pages yet; the examples cover a thermal bubble and an ABC flow

These repositories are private. If you need access, contact support@fluidnumerics.com.

Each repository's README.md explains how to build it against SELF, and docs/README.md lists its model and tutorial pages. Links in those pages that refer to the framework, such as installation, mesh generation, or the boundary condition system, point back to this site.

Advection models in SELF#

SELF keeps its advection models, but only as test fixtures. They are not part of the installed library, so an application cannot use them. The test suite uses them to exercise the framework: the derivative operators, the Riemann flux and boundary condition plumbing, the time integrators, nonconforming mortar interfaces, adaptive mesh refinement, and the GPU backends.

Fixture Source
Advection-diffusion (1-D, 2-D, 3-D) test/models/SELF_advection_diffusion_{1d,2d,3d}_t.f90
Entropy-conserving advection (2-D, 3-D) test/models/SELF_ECAdvection{2D,3D}_t.f90

The CPU and GPU type extensions of each fixture are in test/models/cpu/ and test/models/gpu/, following the same _t template and backend layout as the library source in src/.

To build a model of your own, extend one of the DGModel template classes as described in Model Hooks and Boundary Conditions. The model repositories above are complete worked examples of that pattern.