README.md 2.38 KB
Newer Older
René Fritze's avatar
René Fritze committed
1
```
2
# This file is part of the dune-gdt project:
3
4
#   https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-gdt
# Copyright 2010-2021 dune-gdt developers and contributors. All rights reserved.
5
6
7
# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause)
#      or  GPL-2.0+ (http://opensource.org/licenses/gpl-license)
#          with "runtime exception" (http://www.dune-project.org/license.html)
René Fritze's avatar
René Fritze committed
8
# Authors:
9
#   Felix Schindler (2010, 2013 - 2014, 2016 - 2017)
René Fritze's avatar
René Fritze committed
10
#   Rene Milk       (2017 - 2018)
11
#   Tobias Leibner  (2021)
René Fritze's avatar
René Fritze committed
12
```
René Fritze's avatar
René Fritze committed
13
14
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![pipeline status](https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-xt/badges/master/pipeline.svg)](https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-xt/-/commits/master)
15

Tobias Leibner's avatar
Tobias Leibner committed
16
17
dune-xt is an eXTensions module for [DUNE](https://www.dune-project.org),
which is often used in the context of
18
the discretization module [dune-gdt](https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-gdt).
Felix Schindler's avatar
Felix Schindler committed
19

Tobias Leibner's avatar
Tobias Leibner committed
20
21
22
There is a paper describing some of the concepts behind this extension. While
already dated (in particular, the four modules dune-xt-common, dune-xt-grid, dune-xt-la and dune-xt-functions have been merged into the single dune-xt module),
most ideas still apply:
Felix Schindler's avatar
Felix Schindler committed
23
24
25
26
27
28

```
T. Leibner and R. Milk and F. Schindler: "Extending DUNE: The dune-xt modules"
Archive of Numerical Software, 5:193-216, 2017
https://www.doi.org/10.11588/ans.2017.1.27720
```
Dr. Felix Tobias Schindler's avatar
Dr. Felix Tobias Schindler committed
29

Felix Schindler's avatar
Felix Schindler committed
30
31
dune-gdt is a [DUNE](http://www.dune-project.org/) module which provides a generic
discretization toolbox for grid-based numerical methods. It contains building blocks - like
32
33
local operators, local evaluations, local assemblers - for discretization methods and suitable
discrete function spaces.
34

35

Felix Schindler's avatar
Felix Schindler committed
36
New users may best try out this module by using the git supermodule
37
[dune-gdt-super](https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-gdt-super). Experienced DUNE users
Felix Schindler's avatar
Felix Schindler committed
38
39
40
may go ahead. As usual, you will have to use
[dunecontrol](https://www.dune-project.org/doc/installation/), working examples are located
in 'dune/gdt/test/'...
Felix Schindler's avatar
Felix Schindler committed
41

Felix Schindler's avatar
Felix Schindler committed
42
If you want to start hacking go ahead and
43
44
45
[fork us on github](https://github.com/dune-community/dune-gdt/)
or [gitlab](https://zivgitlab.uni-muenster.de/ag-ohlberger/dune-community/dune-gdt)!