Skip to content

Commit 51f5987

Browse files
committed
Cleanup the configuration section
1 parent b2e9d2b commit 51f5987

File tree

1 file changed

+49
-52
lines changed

1 file changed

+49
-52
lines changed

pages/docs/couple-your-code/couple-your-code-porting-v2-3.md

Lines changed: 49 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -208,58 +208,55 @@ error: ‘class precice::SolverInterface’ has no member named ‘initializeDat
208208

209209
- The XML tag `<solver-interface>` was removed and all underlying functionality was moved to the `<precice-configuration>` tag. Remove the lines including `<solver-interface>` and `</solver-interface>`, and move any attributes (such as `experimental`) from the `solver-interface` to the `precice-configuration` tag. Move the `sync-mode` attribute to the new `<profiling>` tag (see below).
210210
- The `dimensions` configuration is now defined per mesh. Move the `dimensions="2"` or `dimensions="3"` from the `<solver-interface>` tag to each `<mesh>` tag: `<mesh name="MeshOne" dimensions="3">`.
211-
- Replace mapping constraint `scaled-consistent` with `scaled-consistent-surface`.
212-
- Replace `<use-mesh provide="true" ... />` with `<provide-mesh ... />`, and `<use-mesh provide="false" ... />` with `<receive-mesh ... />`.
213-
- Remove `<extraplation-order value="..." />` in `<coupling-scheme>`.
214-
- Replace all RBF related `<mapping:rbf-... />` tags. RBF mappings are now defined in terms of the applied solver (current options `<mapping:rbf-global-direct ...`, `<mapping:rbf-global-iterative` or `<mapping:rbf-pum-direct ...`) and the applied basis function as a subtag of the solver. Users should use the additionally added auto selection of an appropriate solver, which omits the solver specification, as follows:
215-
216-
```xml
217-
<mapping:rbf ...>
218-
<basis-function:... />
219-
</mapping:rbf>
220-
```
221-
222-
Example:
223-
224-
preCICE version 2 rbf configuration:
225-
226-
```xml
227-
<mapping:compact-polynomial-c0 direction="read" from= ... support-radius="0.3" />
228-
```
229-
230-
corresponding preCICE version 3 rbf configuration (using the recommended auto selection):
231-
232-
```xml
233-
<mapping:rbf direction="read" from= ...>
234-
<basis-function:compact-polynomial-c0 support-radius="0.3" />
235-
</mapping:rbf>
236-
```
237-
238-
A specific solver should only be configured if you want to force preCICE to use and stick to a certain solver, independent of your problem size and execution.
239-
240-
- Renamed `<mapping:rbf... use-qr-decomposition="true" />` to `<mapping:rbf-global-direct ... > <basis-function:... /> </mapping:rbf-global-direct>`.
241-
- Remove all timings in the mapping configuration `<mapping: ... timing="initial/onadvance/ondemand" />`.
242-
- Remove the preallocations in the mapping configuration `<mapping: ... preallocation="tree/compute/estimate/save/off" />`.
243-
244-
<!--
245-
- Add `<profiling mode="all" />` after the `<log>` tag if you need profiling data.
246-
- Replace `<export:vtk />` for parallel participants with `<export:vtu />` or `<export:vtp />`.
247-
-->
248-
249-
- Renamed the `<m2n: ... />` attributes `from` -> `acceptor` and `to` -> `connector`.
250-
251-
- Moved and renamed the optional attribute `<read-data: ... waveform-order="1" />` to `<data:scalar/vector ... waveform-degree="1"`.
252-
253-
- We dropped quite some functionality concerning [data actions](https://precice.org/configuration-action.html) as these were not used to the best of our knowledge and hard to maintain:
254-
- Removed deprecated action timings `regular-prior`, `regular-post`, `on-exchange-prior`, and `on-exchange-post`.
255-
- Removed action timings `read-mapping-prior`, `write-mapping-prior`, and `on-time-window-complete-post`.
256-
- Removed `ComputeCurvatureAction` and `ScaleByDtAction` actions.
257-
- Removed callback functions `vertexCallback` and `postAction` from `PythonAction` interface.
258-
- Removed timewindowsize from the `performAction` signature of `PythonAction`. The new signature is `performAction(time, data)`
259-
260-
- Replace `<min-iteration-convergence-measure min-iterations="3" ... />` by `<min-iterations value="3"/>`.
261-
262-
- We removed the plain `Broyden` acceleration. You could use `IQN-IMVJ` instead, which is a [multi-vector Broyden variant](http://hdl.handle.net/2117/191193).
211+
- Rename the `<m2n: ... />` attributes `from` -> `acceptor` and `to` -> `connector`.
212+
- Add `<profiling mode="all" />` after the `<log>` tag if you need full profiling data.
213+
214+
- Participants
215+
- Replace `<use-mesh provide="true" ... />` with `<provide-mesh ... />`, and `<use-mesh provide="false" ... />` with `<receive-mesh ... />`.
216+
- Move and renamed the optional attribute `<read-data: ... waveform-order="1" />` to `<data:scalar/vector ... waveform-degree="1"`.
217+
- Replace `<export:vtk />` for parallel participants with `<export:vtu />` or `<export:vtp />`.
218+
- Replace mapping constraint `scaled-consistent` with `scaled-consistent-surface`.
219+
- Remove all timings in the mapping configuration `<mapping: ... timing="initial/onadvance/ondemand" />`.
220+
- Remove the preallocations in the mapping configuration `<mapping: ... preallocation="tree/compute/estimate/save/off" />`. We always use the superior `tree` method.
221+
- Replace all RBF related `<mapping:rbf-... />` tags. RBF mappings are now defined in terms of the applied solver (current options `<mapping:rbf-global-direct ...`, `<mapping:rbf-global-iterative` or `<mapping:rbf-pum-direct ...`) and the applied basis function as a subtag of the solver. Users should use the additionally added auto selection of an appropriate solver, which omits the solver specification, as follows:
222+
223+
```xml
224+
<mapping:rbf ...>
225+
<basis-function:... />
226+
</mapping:rbf>
227+
```
228+
229+
Example:
230+
231+
preCICE version 2 rbf configuration:
232+
233+
```xml
234+
<mapping:compact-polynomial-c0 direction="read" from= ... support-radius="0.3" />
235+
```
236+
237+
corresponding preCICE version 3 rbf configuration (using the recommended auto selection):
238+
239+
```xml
240+
<mapping:rbf direction="read" from= ...>
241+
<basis-function:compact-polynomial-c0 support-radius="0.3" />
242+
</mapping:rbf>
243+
```
244+
245+
A specific solver should only be configured if you want to force preCICE to use and stick to a certain solver, independent of your problem size and execution.
246+
247+
- Rename `<mapping:rbf... use-qr-decomposition="true" />` to `<mapping:rbf-global-direct ... > <basis-function:... /> </mapping:rbf-global-direct>`.
248+
- We dropped quite some functionality concerning [data actions](https://precice.org/configuration-action.html) as these were not used to the best of our knowledge and hard to maintain:
249+
- Removed deprecated action timings `regular-prior`, `regular-post`, `on-exchange-prior`, and `on-exchange-post`.
250+
- Removed action timings `read-mapping-prior`, `write-mapping-prior`, and `on-time-window-complete-post`.
251+
- Removed `ComputeCurvatureAction` and `ScaleByDtAction` actions.
252+
- Removed callback functions `vertexCallback` and `postAction` from `PythonAction` interface.
253+
- Removed timewindowsize from the `performAction` signature of `PythonAction`. The new signature is `performAction(time, data)`
254+
- Using actions with multiple couping schemes and mixed time window sizes is not well defined!
255+
256+
- Coupling schemes
257+
- Remove `<extraplation-order value="..." />` in `<coupling-scheme>`. Contact us if you need this feature.
258+
- Replace `<min-iteration-convergence-measure min-iterations="3" ... />` by `<min-iterations value="3"/>`. No convergence measures won't lead to an error and iterate until `max-iterations`.
259+
- We removed the plain `Broyden` acceleration. You could use `IQN-IMVJ` instead, which is a [multi-vector Broyden variant](http://hdl.handle.net/2117/191193).
263260

264261
## Building preCICE
265262

0 commit comments

Comments
 (0)