Skip to content

Commit b4a7e92

Browse files
authored
Add overview of experimental features in Roadmap (#667)
Closes #88
1 parent 6b7bc2d commit b4a7e92

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

content/docs/couple-your-code/advanced/couple-your-code-moving-or-changing-meshes.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,11 @@ Note that inactive nodes can lead to numerical instabilities in some acceleratio
5656

5757
{% version 3.2.0 %} This feature is new in preCICE version 3.2.0. {% endversion %}
5858

59-
{% important %}
59+
{% experimental %}
6060
This feature is in active development and not yet feature-complete.
6161
If you are missing features, please check [the GitHub project](https://github.com/orgs/precice/projects/20) and comment on the issues to help us prioritize.
62-
{% endimportant %}
62+
Enable it using `<precice-configuration experimental="true">` and do not consider the configuration to be stable yet.
63+
{% endexperimental %}
6364

6465
**Goal** of the remeshing support in preCICE to allow resetting meshes at runtime.
6566

content/docs/couple-your-code/step-by-step/couple-your-code-gradient-data.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ summary: "So far, our mesh contains only data. This is sufficient for most of th
99
This feature is available since version 2.4.0.
1010
{% endversion %}
1111

12+
{% experimental %}
13+
This is an experimental feature.
14+
Enable it using `<precice-configuration experimental="true">` and do not consider the configuration to be stable yet.
15+
{% endexperimental %}
16+
1217
When using `nearest-neighbor-gradient` mapping, we require coupling data and additional gradient data. We have seen in [Step 3](couple-your-code-mesh-and-data-access.html) how to write data to the mesh.
1318
Now, we will learn how to write gradient data to the mesh. For this purpose, we use the following API method:
1419
<ul id="apiTabs" class="nav nav-tabs">
@@ -126,10 +131,6 @@ while not simulation_done():
126131
</div>
127132
</div>
128133

129-
{% experimental %}
130-
This is an experimental feature.
131-
{% endexperimental %}
132-
133134
{% version 2.4.0 %}
134135
For preCICE versions lower than 2.5.0, you need to set the flag `gradient="on"` in the configuration file, whenever you require to write gradient data. An exemplary xml configuration file is given below. Starting from preCICE version 2.5.0, the gradient requirement is automatically deduced (based on the selected mapping) and can be queried in the code, as usual. Hence, the `gradient="on"` flag must not be set in the configuration file.
135136
{% endversion %}

content/docs/fundamentals/fundamentals-roadmap.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,19 @@ In this page, you can find information about features that we plan to introduce
1313
If you are looking for library features introduced already in the past, have a look at our [Changelog](https://github.com/precice/precice/blob/develop/CHANGELOG.md).
1414
For most recent developments waiting for the next release, have a look at the [unreleased changes](#changelog).
1515

16+
## Experimental
17+
18+
The following features have recently been released, but are still experimental,
19+
meaning that the respective API or configuration might change in a minor release:
20+
21+
- [Dynamic coupling meshes](couple-your-code-moving-or-changing-meshes.html) - Since v3.2.0 ([GitHub project](https://github.com/orgs/precice/projects/20/views/1))
22+
- [Just-in-time data mapping](couple-your-code-just-in-time-mapping.html), e.g., for particle codes - Since v3.2.0
23+
- [Geometric multi-scale data mapping](configuration-mapping.html#geometric-multiscale-mapping), e.g. for 3D-1D coupled problems - Since v3.0.0 ([GitHub project](https://github.com/orgs/precice/projects/14))
24+
- [Gradient data](couple-your-code-gradient-data.html) - Since v2.4.0
25+
1626
## In active development
1727

1828
- [GPU support for partition-of-unity radial-basis-function data mapping](https://github.com/precice/precice/pull/2346)
19-
- [Dynamic coupling meshes](https://github.com/orgs/precice/projects/20/views/1)
20-
- [Geometric multi-scale data mapping](https://github.com/orgs/precice/projects/14), e.g. for 3D-1D and 3D-2D coupled problems
2129
- [Extendable and modular system tests](https://github.com/orgs/precice/projects/12)
2230
- [Volume coupling for OpenFOAM](https://github.com/orgs/precice/projects/9)
2331
- [Standardization of adapter and tooling configurations](https://github.com/precice/preeco-orga/issues/18)

0 commit comments

Comments
 (0)