Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions assets/xmlreference.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- generated with preCICE 3.4.1 -->
<!-- generated with preCICE 3.5.0 -->
# precice-configuration

Main tag containing preCICE configuration.
Expand Down Expand Up @@ -272,7 +272,7 @@ Represents one solver using preCICE. At least two participants have to be define
<action:multiply-by-area timing="{string}" mesh="{string}">
...
</action:multiply-by-area>
<export:vtk directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<export:vtk mesh="" directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<watch-point name="{string}" mesh="{string}" coordinate="{vector}"/>
<watch-integral name="{string}" mesh="{string}" scale-with-connectivity="{boolean}"/>
<provide-mesh name="{string}"/>
Expand Down Expand Up @@ -1796,11 +1796,12 @@ Exports meshes to VTK legacy format files. Parallel participants will use the VT
**Example:**

```xml
<export:vtk directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<export:vtk mesh="" directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
```

| Attribute | Type | Description | Default | Options |
| --- | --- | --- | --- | --- |
| mesh | string | Name of the mesh to export, or empty to export all meshes of the participant. | `` | none |
| directory | string | Directory to export the files to. | `.` | none |
| every-n-time-windows | integer | preCICE does an export every X time windows. Choose -1 for no exports. | `1` | none |
| every-iteration | boolean | Exports in every coupling (sub)iteration. For debug purposes. | `false` | none |
Expand All @@ -1815,11 +1816,12 @@ Exports meshes to VTU files in serial or PVTU files with VTU piece files in para
**Example:**

```xml
<export:vtu directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<export:vtu mesh="" directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
```

| Attribute | Type | Description | Default | Options |
| --- | --- | --- | --- | --- |
| mesh | string | Name of the mesh to export, or empty to export all meshes of the participant. | `` | none |
| directory | string | Directory to export the files to. | `.` | none |
| every-n-time-windows | integer | preCICE does an export every X time windows. Choose -1 for no exports. | `1` | none |
| every-iteration | boolean | Exports in every coupling (sub)iteration. For debug purposes. | `false` | none |
Expand All @@ -1834,11 +1836,12 @@ Exports meshes to VTP files in serial or PVTP files with VTP piece files in para
**Example:**

```xml
<export:vtp directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<export:vtp mesh="" directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
```

| Attribute | Type | Description | Default | Options |
| --- | --- | --- | --- | --- |
| mesh | string | Name of the mesh to export, or empty to export all meshes of the participant. | `` | none |
| directory | string | Directory to export the files to. | `.` | none |
| every-n-time-windows | integer | preCICE does an export every X time windows. Choose -1 for no exports. | `1` | none |
| every-iteration | boolean | Exports in every coupling (sub)iteration. For debug purposes. | `false` | none |
Expand All @@ -1853,11 +1856,12 @@ Exports vertex coordinates and data to CSV files.
**Example:**

```xml
<export:csv directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
<export:csv mesh="" directory="." every-n-time-windows="1" every-iteration="false" update-series="false"/>
```

| Attribute | Type | Description | Default | Options |
| --- | --- | --- | --- | --- |
| mesh | string | Name of the mesh to export, or empty to export all meshes of the participant. | `` | none |
| directory | string | Directory to export the files to. | `.` | none |
| every-n-time-windows | integer | preCICE does an export every X time windows. Choose -1 for no exports. | `1` | none |
| every-iteration | boolean | Exports in every coupling (sub)iteration. For debug purposes. | `false` | none |
Expand Down
6 changes: 3 additions & 3 deletions config/_default/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ site_title = "preCICE - The Coupling Library"
company_name = "preCICE"
description = "preCICE is an open-source coupling library and ecosystem for general partitioned multi-physics and multi-scale simulations, including surface and volume coupling."
sidebars = ["home_sidebar", "docs_sidebar", "tutorials_sidebar", "community_sidebar"]
precice_version = "3.4.1"
precice_v1_citations = 481
precice_version = "3.5.0"
precice_v1_citations = 493
precice_v1_citations_url = "https://scholar.google.com/scholar?cites=5053469347483527186&as_sdt=2005&sciodt=0,5&hl=en"
precice_v2_citations = 280
precice_v2_citations = 291
precice_v2_citations_url = "https://scholar.google.com/scholar?oi=bibs&hl=en&cites=17974677460269868025,12004404035922881061"

[params.algolia]
Expand Down
17 changes: 10 additions & 7 deletions content/docs/installation/building-from-source/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ If you find a problem with preCICE and a latest versions of these dependencies,
| Dependency | Version required | Availability |
| --- | --- | --- |
| [C++ compiler](#c-compiler) | C++17 | [C++17 compiler support](https://cppreference.com/w/cpp/compiler_support/17.html) |
| [CMake](#cmake) | >= 3.22.1 | [![Repology - CMake](https://img.shields.io/repology/repositories/cmake)](https://repology.org/project/cmake/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-cmake-blue)](https://pkgs.org/search/?q=cmake){:.no-icon} |
| [CMake](#cmake) | >= 3.28.3 | [![Repology - CMake](https://img.shields.io/repology/repositories/cmake)](https://repology.org/project/cmake/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-cmake-blue)](https://pkgs.org/search/?q=cmake){:.no-icon} |
| [Eigen](#eigen) | >= 3.4.0 | [![Repology - Eigen](https://img.shields.io/repology/repositories/eigen)](https://repology.org/project/eigen/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-eigen3-blue)](https://pkgs.org/search/?q=eigen3){:.no-icon} |
| [Boost](#boost) | >= 1.74.0 | [![Repology - Boost](https://img.shields.io/repology/repositories/boost)](https://repology.org/project/boost/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-libboost-blue)](https://pkgs.org/search/?q=libboost){:.no-icon} |
| [Boost](#boost) | >= 1.83.0 | [![Repology - Boost](https://img.shields.io/repology/repositories/boost)](https://repology.org/project/boost/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-libboost-blue)](https://pkgs.org/search/?q=libboost){:.no-icon} |
| [libxml2](#libxml2) | >= 2 | [![Repology - libxml2](https://img.shields.io/repology/repositories/libxml2)](https://repology.org/project/libxml2/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-libxml2-blue)](https://pkgs.org/search/?q=libxml2){:.no-icon} |

Note that more recent versions of some dependencies (e.g., Boost) might also need more recent or upcoming releases of preCICE.
Expand All @@ -44,7 +44,7 @@ Note that more recent versions of some dependencies (e.g., Boost) might also nee
| Dependency | Required for | Version required | Availability |
| --- | --- | --- | --- |
| [MPI](#mpi) (opt-out) | [Communication over MPI](configuration-communication.html) | implementation of MPI-3 | Various [implementations](https://en.wikipedia.org/wiki/Message_Passing_Interface#Official_implementations) |
| [PETSc](#petsc) (opt-out) | [Some RBF mappings](configuration-mapping.html#execution-backends) | >= 3.15 | [![Repology - PETSc](https://img.shields.io/repology/repositories/petsc)](https://repology.org/project/petsc/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-petsc-blue)](https://pkgs.org/search/?q=petsc){:.no-icon} |
| [PETSc](#petsc) (opt-out) | [Some RBF mappings](configuration-mapping.html#execution-backends) | >= 3.19 | [![Repology - PETSc](https://img.shields.io/repology/repositories/petsc)](https://repology.org/project/petsc/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-petsc-blue)](https://pkgs.org/search/?q=petsc){:.no-icon} |
| [Ginkgo](#ginkgo) (opt-in) | [Some RBF mappings](configuration-mapping.html#execution-backends) | >= 1.8, with Kokkos >= 4.1 | [![Repology - Ginkgo](https://img.shields.io/repology/repositories/ginkgo-linear-algebra)](https://repology.org/project/ginkgo-linear-algebra/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-ginkgo-blue)](https://pkgs.org/search/?q=ginkgo){:.no-icon} |
| [Kokkos-Kernels](#kokkos-kernels) (opt-in) | [Some RBF mappings](configuration-mapping.html#execution-backends) | >= 4.1, with Kokkos >= 4.1 | [![Repology - Kokkos-Kernels](https://img.shields.io/repology/repositories/kokkos-kernels)](https://repology.org/project/kokkos-kernels/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-kokkos-kernels)](https://pkgs.org/search/?q=kokkos-kernels){:.no-icon} |
| [Python](#python) (opt-out) | [Python Action interface](configuration-action.html#python-callback-interface) | >= 3 | [![Repology - Python](https://img.shields.io/repology/repositories/python)](https://repology.org/project/python/versions){:.no-icon} [![pkgs.org](https://img.shields.io/badge/pkgs.org-python-blue)](https://pkgs.org/search/?q=python){:.no-icon} |
Expand Down Expand Up @@ -87,7 +87,7 @@ History of required version:
| 1.4.0 | min 3.10.2 |
| 2.4.0 | min 3.16.3 |
| 3.2.0 | min 3.22.1 |
| 3.3.0 | as above |
| 3.5.0 | min 3.28.3 |

#### Download CMake binaries

Expand All @@ -113,6 +113,7 @@ History of required version:
| older | min 3.2.0 |
| 1.5.0 | min 3.3.7 |
| 3.3.0 | min 3.4.0, supports 5.0.0 or later |
| 3.5.0 | as above |

#### Download the Eigen headers

Expand Down Expand Up @@ -163,6 +164,7 @@ History of required versions:
| 3.1.2 | as above | 1.86.0 |
| 3.2.0 | 1.74.0 | 1.89.0 |
| 3.3.0 | 1.74.0 | none known yet |
| 3.5.0 | 1.83.0 | none known yet |

For help, see also the ranges set in the [Spack recipe](https://github.com/spack/spack-packages/blob/develop/repos/spack_repo/builtin/packages/precice/package.py).

Expand Down Expand Up @@ -252,7 +254,7 @@ History of required versions:
| older | 3.6.0 (with 64bit indices) | 3.12.0 |
| 2.1.0 | 3.12.0 | none known yet |
| 3.2.0 | 3.15.0 | as above |
| 3.3.0 | as above | as above |
| 3.5.0 | 3.19.0 | as above |

#### Build PETSc from source

Expand Down Expand Up @@ -284,7 +286,7 @@ History of required versions:
| preCICE | Ginkgo required | Kokkos required |
| --- | --- | --- |
| 3.2.0 | 1.8.0 | 4.1.0 |
| 3.3.0 | same as above | same as above |
| 3.5.0 | same as above | same as above |

### Kokkos-Kernels

Expand All @@ -301,6 +303,7 @@ History of required versions:
| preCICE | Kokkos-Kernels required | Kokkos required |
| --- | --- | --- |
| 3.4.1 | 4.1.0 | 4.1.0 |
| 3.5.0 | as above | as above |

### Python

Expand All @@ -315,7 +318,7 @@ History of required versions:
| --- | --- | --- | --- | --- |
| older | 2.7 | 2.8 | not defined | 1.17 |
| 2.0.0 | 3 | None known yet | 1.17 | None known yet |
| 3.3.0 | same as above | same as above | same as above | same as above |
| 3.5.0 | same as above | same as above | same as above | same as above |

## System guides

Expand Down
Loading