Skip to content

Commit

Permalink
Merge branch 'master' into development
Browse files Browse the repository at this point in the history
  • Loading branch information
reuterbal committed Mar 16, 2018
2 parents 6f24e26 + 4486e73 commit ca37419
Show file tree
Hide file tree
Showing 20 changed files with 4,424 additions and 38 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*.log
doc
output
octave-workspace
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
FESTUNG
=======
# FESTUNG

**FESTUNG** (Finite Element Simulation Toolbox for Unstructured Grids) is a Matlab / GNU Octave toolbox for the discontinuous Galerkin (DG) method on unstructured grids. It is primarily intended as a fast and flexible prototyping platform and testbed for students and developers.

FESTUNG relies on fully vectorized matrix/vector operations to deliver optimized computational performance combined with a compact, user-friendly interface and a comprehensive documentation.

![](doxygen/images/features.png)

## Download
* Tarballs of previous code versions and further information about the project can be found on our [Project page](https://math.fau.de/FESTUNG).
* The latest published version can always be downloaded from the [Github repository](https://github.com/FESTUNG/project).
* The latest published version can always be downloaded from the [GitHub repository](https://github.com/FESTUNG/project).

## Usage
To check out the latest version, run `git clone https://github.com/FESTUNG/project.git`
To check out the latest version, run

Model problems are defined following a generic [solver structure](doxygen/solver-structure.md).
git clone https://github.com/FESTUNG/project.git

Model problems are defined following a generic [solver structure](doxygen/solverStructure.md).
Have a look at the implementation of the standard (element-based) DG discretizations of linear advection (folders `advection` for time-explicit and `advection_implicit` for time-implicit) or the LDG discretization of the diffusion operator (folder `diffusion`).
A hybridized DG discretization of linear advection can be found in the folder `hdg_advection`.

Expand All @@ -22,7 +26,7 @@ Start the computation for any of these problems using `main(<folder name>)`, for
Output files are written in [VTK format](http://www.vtk.org/VTK/img/file-formats.pdf) or [TecPlot ASCII file format](http://paulbourke.net/dataformats/tp/) and can be visualized, e.g., using [Paraview](http://www.paraview.org/).

## Development
When developing code for or with FESTUNG we suggest to stick to the [Naming Convention](NAMING_CONVENTION.md) to allow for better readability and a similar appearance of all code parts. All files should be documented using the [Doxygen syntax](http://www.stack.nl/~dimitri/doxygen/manual/).
When developing code for or with FESTUNG we suggest to stick to the [Naming convention](namingConvention.md) to allow for better readability and a similar appearance of all code parts. All files should be documented using the [Doxygen syntax](http://www.stack.nl/~dimitri/doxygen/manual/).

## Documentation
All routines are carefully documented in the Doxygen format, which allows to produce [this documentation](https://www1.am.uni-erlangen.de/FESTUNG). It can be generated by calling
Expand All @@ -32,7 +36,6 @@ All routines are carefully documented in the Doxygen format, which allows to pro
in the main directory.

## Contributors

FESTUNGs main developers are [Florian Frank](http://frank.ink), [Balthasar Reuter](https://math.fau.de/reuter), and [Vadym Aizinger](https://math.fau.de/aizinger). Its initial release was developed at the [Chair for Applied Mathematics I](https://www.mso.math.fau.de/applied-mathematics-1.html) at [Friedrich-Alexander-University Erlangen-Nürnberg](https://www.fau.eu).

### Third party libraries
Expand All @@ -41,7 +44,7 @@ FESTUNGs main developers are [Florian Frank](http://frank.ink), [Balthasar Reute
* [m2cpp.pl](https://github.com/FESTUNG/project/blob/master/thirdParty/doxygenMatlab/m2cpp.pl) by Fabrice to generate a [Doxygen](http://www.stack.nl/~dimitri/doxygen/) documentation. See [license.txt](https://github.com/FESTUNG/project/blob/master/thirdParty/doxygenMatlab/license.txt) for license details.

## License
* see [LICENSE](LICENSE.md) file
* see [License](license.md) file

## Version
* Version 0.1 as published in the paper *Frank, Reuter, Aizinger, Knabner:* "FESTUNG: A MATLAB / GNU Octave toolbox for the discontinuous Galerkin method. Part I: Diffusion operator". *In: Computers & Mathematics with Applications 70 (2015) 11-46, Available online 15 May 2015, ISSN 0898-1221, http://dx.doi.org/10.1016/j.camwa.2015.04.013.*
Expand Down
Loading

0 comments on commit ca37419

Please sign in to comment.