 |
version 3.10-dev
|
|
version 3.10-dev
|
DuMux builds and runs on Linux and Mac operating systems. Installation on Windows is possible but it is definitely not something to try if you are a beginner. If you use Windows, we recommend the Ubuntu bash on Windows (WSL) and a guide to using Dumux with the WSL can be found in the wiki. Alternatively, you can try to employ MinGW, Cygwin or a Linux Virtual Machine.
In order to build DuMux you need at least the following software:
The following software is recommended but optional:
numpy (to execute a number of different scripts used for installation, testing, post-processing, etc.)This installation method requires
wget (for automatically downloading dependencies)git (for cloning the code repositories)python3 (>= 3.7)We provide you with a Python script that facilitates setting up a Dune/DuMux directory tree and configures all modules using CMake. Download installdumux.py and place it in a directory where you want to install Dune/DuMux, for example by running
Executing the script creates a folder "dumux" in which all dependencies will be downloaded and built. Run the script by typing:
Follow the instructions printed after the script has completed successfully to verify everything works as expected.
In brief, the script performs the following steps:
dune-common/bin/dunecontrol and the options in dumux/cmake.optsNote that this process can take several minutes. The next section will guide you through the same process providing the necessary commands for executing each step. The installation is fully contained in the created folder "dumux". The script does not modify your system or local environment.
DuMux depends on Dune. Required are the libraries/modules dune-common, dune-geometry, dune-grid, dune-localfunctions, and dune-istl. You can obtain the required Dune modules in form of binary packages for Debian, Ubuntu and openSUSE, see the Dune binary packages. The Dune releases can also be obtained as tarballs. Alternatively and recommended and described below, you can use git to download the source code and configure and build with the dunecontrol script. To clone the Dune core modules, run:
To clone the latest 3.9 release version, run
The master branch (developer version) can be cloned with
Alternatively, it is also possible to download release tarballs from DaRUS or from GitLab.
After obtaining all modules (at least dune-common,dune-geometry,dune-grid,dune-istl,dune-localfunctions and dumux), DuMux is built together with other Dune modules. Assuming that the Dune core modules and DuMux are folders in the same directory
DUMUX (installation folder) |- dune-common |- dune-geometry |- dune-grid |- dune-istl |- dune-localfunctions |- dumux
you can configure and build the module stack with the dunecontrol helper script:
In case you have obtained the DUNE modules via a package manager, dunecontrol should be an available program in your path environment (replace ./dune-common/bin/dunecontrol by dunecontrol).
Running dunecontrol will create a build folder called build-cmake in each of the module folders. In case you want to build the module stack in a separate build folder use
More details on the DUNE build system can be found in the Dune installation notes.
Dune and DuMux rely heavily on compiler optimization. The speed difference between running a compiler-optimized versus a non-optimized DuMux executable can easily exceed a factor of \(10\). The default cmake.opts in dumux/cmake.opts already enable compiler optimisations. To use debug options use -DCMAKE_BUILD_TYPE=Debug instead of -DCMAKE_BUILD_TYPE=Release in the cmake.opts, or add set(CMAKE_BUILD_TYPE Debug) to any CMakeLists.txt containing a test that you want to compile non-optimised and with debug symbols enabled.
In case you are running macOS on a recent arm chip (M1, M2) your compiler might not support the flag -march=native yet. You can replace this flag by a mcpu=<cpu> flag, where <cpu> is the best match of available option shown by clang --print-supported-cpus.
Often it makes sense to create and keep around a custom option file for dunecontrol tailored to your local setup. You can use dumux/cmake.opts as a starting point.
There are various external libraries and modules that provide additional functionality but are not generally required to run DuMux. DuMux contains the script installexternal.py which allows you to install extension from your DuMux installation directory.
If you run the script with the option --help
it will show a list of installable packages. Dune modules can be installed by adding the name of the package. For example, running the script by typing:
downloads the ALUGrid module dune-alugrid in a separate folder in your installation directory. After the download you can run following command to clean the CMake cache:
Afterwards you can reconfigure and build DuMux with the dunecontrol script:
If you install an external library which is not a Dune module, the script will install the library in the directory external. If you install external libraries in an non-standard location you must usually either set the root path of the package (e.g. CGAL_ROOT=<path/to/folder>) or add the path to the CMAKE_PREFIX_PATH variable. These variables can be added in the option file cmake.opts before running dunecontrol. Compiler definitions are passed to CMake with the -D prefix, e.g. -DCGAL_ROOT=<path/to/folder>, so variables passed via cmake.opts need -D at the beginning. After you have installed an external library you should also clean the CMake cache and reconfigure and build DuMux as mentioned above.
Only the following Dune and DuMux versions are compatible:
| DuMux version | Dune version |
|---|---|
| master | 2.9, master |
| 3.7, 3.8, 3.9 | 2.9 |
| 3.5, 3.6 | 2.8, 2.9 |
| 3.3, 3.4 | 2.7, 2.8 |
| 3.1, 3.2 | 2.6*, 2.7 |
| 3.0 | 2.6*, 2.7 |
| 2.10, 2.11, 2.12 | 2.4, 2.5, 2.6* |
* Use the most recent version of the git branch releases/2.6 instead of the 2.6.0 tarballs.
3.10-dev
Generated by 
1.9.3