Skip to content
Snippets Groups Projects
README.md 2.24 KiB
Newer Older
Welcome to the dumux pub table Glaeser2020a
========================================
Dennis Gläser's avatar
Dennis Gläser committed

This module contains the source code for the example shown in the description
of the open-source fracture network generator [Frackit][1]. <!-- and in the paper __TODO: PUT PAPER CITATION HERE__ -->
Installation instruction (__for linux__)
----------------------------------------
Dennis Gläser's avatar
Dennis Gläser committed

For building the code from source, create a new folder and download the `installGlaeser2020a.sh` script from this repository into the newly created folder. Then, type
Dennis Gläser's avatar
Dennis Gläser committed

```sh
chmod +x installGlaeser2020a.sh
./installGlaeser2020a.sh
```
to download and configure all dune dependencies and dumux. This might take a while. Please note that the following requirements need to be installed:
Dennis Gläser's avatar
Dennis Gläser committed

- CMake (>2.8.12)
- C, C++ compiler (C++14 required)
- Fortran compiler (gfortran)
- UMFPack from SuiteSparse
Dennis Gläser's avatar
Dennis Gläser committed

After successfully running the installation script, navigate to the folder containing the example:
Dennis Gläser's avatar
Dennis Gläser committed

```sh
cd glaeser2020a/build-cmake/example/
```
Dennis Gläser's avatar
Dennis Gläser committed

You can choose between three discretization schemes, namely __tpfa__, __mpfa__ and __box__.
Compile the example with the scheme you want to use, by typing one of the following three
commands into the terminal:
Dennis Gläser's avatar
Dennis Gläser committed

```sh
make example_tpfa
make example_mpfa
make example_box
```
Dennis Gläser's avatar
Dennis Gläser committed

You can now execute the example (for instance using the __box__ scheme), by typing:
Dennis Gläser's avatar
Dennis Gläser committed

```sh
./example_box example.input
```
Dennis Gläser's avatar
Dennis Gläser committed

Have a look at the `example.input` file to see what parameters you can change
without having to modify the source code.
[1]: https://git.iws.uni-stuttgart.de/tools/frackit
Sarbani Roy's avatar
Sarbani Roy committed


Installation with Docker
========================

Create a new folder in your favourite location and change into it

```bash
mkdir Glaeser2020a
cd Glaeser2020a
```

Download the container startup script
```bash
wget https://git.iws.uni-stuttgart.de/dumux-pub/glaeser2020a/-/raw/master/docker_glaeser2020a.sh
```

Open the Docker Container by running
```bash
bash docker_glaeser2020a.sh open
```

After the script has run successfully, you may build all executables

```bash
cd glaeser2020a/build-cmake
make build_tests
```

and you can run them individually. They are located in the example folder. It can be executed with an input filr, e.g., by running

```bash
cd example
./example_box example.input
```