diff --git a/pages/docs/configuration/configuration-mapping.md b/pages/docs/configuration/configuration-mapping.md index e85dc7b61d..bdb8be4ab1 100644 --- a/pages/docs/configuration/configuration-mapping.md +++ b/pages/docs/configuration/configuration-mapping.md @@ -131,11 +131,9 @@ ASTE and our [ASTE tutorial](tutorials-aste-turbine.html) enable full insight in #### Execution backends -{% experimental %} -Although this feature is well-tested in preCICE, it relies on an unreleased version of Ginkgo. Hence, this feature might change in the future. -{% endexperimental %} +Starting from version 3.2, preCICE offers to execute `mapping:rbf-global...` on different executor backends using the linear-operator library Ginkgo in conjunction with Kokkos. -Starting from version 3, preCICE offers to execute `mapping:rbf-global...` on different executor backends using the linear-operator library Ginkgo +To use this feature, please build preCICE from source with [Ginkgo Mappings enabled](installation-source-dependencies.html#ginkgo). ![RBF executors](images/docs/configuration/doc-mapping-rbf-executors.svg) diff --git a/pages/docs/installation/installation-source-dependencies.md b/pages/docs/installation/installation-source-dependencies.md index 8360f189be..037688d736 100644 --- a/pages/docs/installation/installation-source-dependencies.md +++ b/pages/docs/installation/installation-source-dependencies.md @@ -41,6 +41,7 @@ If you find a problem with preCICE and a latest versions of these dependencies, | [MPI](#mpi) | implementation of MPI-3 | | [PETSc](#petsc) | >= 3.12 | | [Python](#python) | >= 3 | +| [Ginkgo](#ginkgo) | >= 1.8 with Kokkos >= 4.1 | ### C++ compiler @@ -132,7 +133,7 @@ The following header-only Boost libraries are also needed: 'asio', `vmd`, `geome 1. [Download](http://www.boost.org/users/download/) and extract Boost into any directory. Switch to that directory. 2. Prepare the installation, selecting only the libraries that need to be built (this does not affect the header-only libraries). Select a prefix to install Boost to. This will later contain the directories `include` and `lib`. - On systems using modules, we recommend to specify the toolset manually by additionally passing `--with-toolset=gcc` (or `intel`). + On systems using modules, we recommend to specify the toolset manually by additionally passing `--with-toolset=gcc` (or `intel`). Now run with the prefix of your choice: @@ -257,6 +258,16 @@ Keep in mind that already [PETSc](installation-source-dependencies.html#petsc) s Make sure that PETSc, preCICE, and your solvers are all compiled with the same MPI version! {% endimportant %} +### Ginkgo + +| preCICE | 3.2.0 >= | +| Required Ginkgo | 1.8.0 >= | +| Required Kokkos | 4.1.0 >= | + +[Ginkgo](https://ginkgo-project.github.io/) enables support for GPU- and OpenMP-accelerated (global) radial-basis function mappings. To enable the feature in preCICE, use the CMake option `-DPRECICE_FEATURE_GINKGO_MAPPING=ON`. Using this feature in preCICE requires additionally [Kokkos](https://kokkos.org/). + +Both packages follow the usual CMake build instructions and can be downloaded on the GitHub release page for [Ginkgo](https://github.com/ginkgo-project/ginkgo/releases) and [Kokkos](https://github.com/kokkos/kokkos/releases). For Kokkos, system packages might be available through your package manager as well. + ## System guides If you want build preCICE on your own computer and you are using one of the following Linux distributions, we provide a summary here to quickly install everything you need. If everything works, you may ignore the rest of this page.