[doc] explain usage in separate module

precice · Dec 19, 2023 · c1e54c4 · c1e54c4
1 parent a53b73f
commit c1e54c4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/doc/user/docs/example-usage.md b/doc/user/docs/example-usage.md
@@ -1,3 +1,5 @@
 # Adapter usage
 
 Please check out the examples in the `examples/` directory to get an idea on how to use the adapter.
+
+To use the adapter in a separate DUNE module, set `dumux-precice` as a (suggested) dependency and link targets against the `dumux-precice` library as done in the `examples/` directory. If `libdumux-precice` is built as a static library, additionally discover and link the `precice::precice` library. To build the adapter library as a dynamic library, use the CMake option `-DBUILD_SHARED_LIBS=ON` to build `dumux-precice` and upstream modules.
diff --git a/doc/user/docs/installation.md b/doc/user/docs/installation.md
@@ -62,6 +62,8 @@ The DuMuX-preCICE adapter should build fine if DuMuX, preCICE and their dependen
 
     This provided `cmake-test.opts` file turns off some system-dependent optimizations such that the tests create comparable results on different computers.
 
+    To use the adapter in a separate DUNE module it may be desired to build a dynamic version of the adapter's library. To do so, use the CMake option `-DBUILD_SHARED_LIBS=ON` to build the adapter and upstream modules.
+
     For more ways do manipulate/adapt the build and configuration step, please consult the `dunecontrol` documentation.
 
 5. Optional, but recommended: Build all tests to verify the installation. For this navigate in the `build-cmake/` directory and build the `build_tests` target.