[web] Docs on cpardiso-usage.

ufz · Aug 12, 2024 · 2b68ec8 · 2b68ec8
1 parent f972cc1
commit 2b68ec8
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/Documentation/.vale/Vocab/ogs/accept.txt b/Documentation/.vale/Vocab/ogs/accept.txt
@@ -125,6 +125,7 @@ pacman
 Palandri
 parameteri[zs]ation
 ParaView
+Pardiso
 Parisio
 Parkhurst
 partmesh

diff --git a/web/content/docs/userguide/basics/container/index.md b/web/content/docs/userguide/basics/container/index.md
@@ -41,7 +41,9 @@ Simply download an image from the latest master-branch build:
 
 <!-- vale off -->
 * [ogs-serial.squashfs](https://minio.ufz.de/ogs/public/container/ogs/master/ogs-serial.squashfs)
+* [ogs-mkl.squashfs](https://minio.ufz.de/ogs/public/container/ogs/master/ogs-mkl.squashfs)  (with and MKL Pardiso-support )
 * [ogs-petsc.squashfs](https://minio.ufz.de/ogs/public/container/ogs/master/ogs-petsc.squashfs) (with PETSC-support)
+* [ogs-petsc-mkl.squashfs](https://minio.ufz.de/ogs/public/container/ogs/master/ogs-petsc-mkl.squashfs) (with PETSC- and MKL Pardiso-support )
 <!-- vale on -->
 
 Please note that these images have `.squashfs` as the file ending. Usage is the same as with `.sif`-files.

diff --git a/web/content/docs/userguide/blocks/linear_solvers.md b/web/content/docs/userguide/blocks/linear_solvers.md
@@ -33,3 +33,7 @@ For most cases value below $10^{-10}$ is recommended.
 ## Eigen
 
 <!-- TODO: Add description of Eigen -->
+
+## PETSc
+
+See [Running OGS with MPI]({{< ref "parallel_computing_mpi">}})-page for details.
diff --git a/web/content/docs/userguide/features/parallel_computing_mpi.md b/web/content/docs/userguide/features/parallel_computing_mpi.md
@@ -99,6 +99,24 @@ An introduction and a list of PETSc KSP solvers and preconditioners can be found
 
 <!-- TODO: At best explain the example above in more detail. This can be done by comments in the `xml`-code snippet. -->
 
+<div class="note">
+
+#### PETSc with Pardiso solver
+
+If you have configured OGS (`OGS_USE_MKL=ON`) and PETSc (`--with-mkl_pardiso-dir=... --with-mkl_cpardiso-dir=...`) with MKL support then you can run the parallel Pardiso solver with .e.g.:
+
+```xml
+<petsc>
+     <parameters>-mat_type mpiaij
+                 -pc_type lu
+                 -pc_factor_mat_solver_type mkl_cpardiso</parameters>
+</petsc>
+```
+
+See the [PETSc docs](https://petsc.org/release/overview/linear_solve_table/#direct-solvers) for more info on the solver settings. The [prebuilt containers]({{< relref "container" >}}#get-a-container-image) support this configuration.
+
+</div>
+
 ### 2. Launch MPI OGS
 
 For MPI launcher, either `mpiexec` or `mpirun` can be used to run OGS.