dunemodule.md

---
title: Making my own Dune-Module
---

# Custom Dune-Module

## My own workspace?

We all want to implement our own models and create our own test cases.

But where?

## The Dune/Dumux Suite
<img src=img/dependenciesCore.png width="100%">

## The Dune/Dumux Suite
<img src=img/dependenciesOptional.png width="100%">

## The Dune/Dumux Suite
<img src=img/dependenciesMyModule.png width="100%">

## Creating a new dune module
Start the script `duneproject` to initiate creating a new module:

```bash
./dune-common/bin/duneproject
```

## How are these modules linked?
Compile modules via:

```bash
./dune-common/bin/dunecontrol --opts=dumux/cmake.opts all
```

## Adding test cases to an `appl` folder

- Adjust the
    - source (.cc) file,
    - input parameter file,
    - problem file,
    - properties file,
    - (spatialparams file).
- Adjust the `CMakeLists.txt` file.
- Reconfigure your module.

## Pushing an existing folder to an empty git repository

```bash
cd my-module-folder
git init --initial-branch=main
git remote add origin https://git.iws.uni-stuttgart.de/Namespace/my-module.git
git add .
git commit -m "Initial commit"
git push -u origin main
```

## [Exercises](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/tree/master/exercises/exercise-dunemodule):

- Create a new module with the duneproject script
- Run dune control
- Create an appl folder
- Upload to a git repository