SimpleDiscontinuousGalerkin.jl

Docs-dev Build Status codecov Aqua QA License: MIT

SimpleDiscontinuousGalerkin.jl is a Julia package that implements some basic discontinuous Galerkin (DG) methods for the solution of hyperbolic partial differential equations (PDEs). The package is designed to be simple and easy to use and understand. It is intended for educational purposes and to provide a starting point for more complex DG methods. For a more comprehensive and advanced implementation of DG methods, we recommend using the package Trixi.jl. This package can be understood as a minimalistic version of Trixi.jl, which is designed to be easy to understand and modify. Many design concepts are inspired by Trixi.jl, but the implementation is much simpler and more straightforward. SimpleDiscontinuousGalerkin.jl builds on the foundations of the package SummationByPartsOperators.jl.

Installation

If you have not yet installed Julia, then you first need to download Julia. Please follow the instructions for your operating system. SimpleDiscontinuousGalerkin.jl works with Julia v1.10 and newer. You can install SimpleDiscontinuousGalerkin.jl by executing the following commands from the Julia REPL

julia> using Pkg

julia> Pkg.add("https://github.com/JoshuaLampert/SimpleDiscontinuousGalerkin.jl")

Usage

In the Julia REPL, first load the package SimpleDiscontinuousGalerkin.jl

julia> using SimpleDiscontinuousGalerkin

SimpleDiscontinuousGalerkin.jl is built on top of the package SummationByPartsOperators.jl and exports all the functions and types of the package.

Authors

The package is developed and maintained by Joshua Lampert (University of Hamburg).

License and contributing

SimpleDiscontinuousGalerkin.jl is published under the MIT license (see License). We are pleased to accept contributions from everyone, preferably in the form of a PR.