Waveform interpolation, read direction for parallel implicit coupling by BenjaminRodenberg · Pull Request #1187 · precice/precice

BenjaminRodenberg · 2022-02-17T11:46:46Z

Main changes of this PR

This PR adds experimental support for zeroth and first order waveform interpolation for parallel implicit coupling schemes. Waveforms are only supported in read direction. This means that the user can sample the waveform, but preCICE will only create the waveform based on data at the beginning and at the end of the window. Subcycling is not supported.

This PR is a subtask when solving #1174.

Motivation and additional information

This PR branched off from #1029, because serial implicit coupling requires additional steps for full support of waveforms. The implementation for parallel implicit coupling is simpler and closer to a state where it is ready to be merged.

Todos

Add tests for non-experimental API and subcycling. #1186
Cleanup of existing tests necessary? Yes. See Add tests for non-experimental API and subcycling. #1186.
Simplify implementation of data mapping in SolverInterfaceImpl #1216
Add readVectorData, readBlockScalarData and readBlockVectorData in SolverInterface.
Implement limited number of tests for readVectorData, readBlockScalarData and readBlockVectorData.

Author's checklist

I added a changelog file with make changelog if there are user-observable changes since the last release.
I ran make format to ensure everything is formatted correctly.
I sticked to C++14 features.
I sticked to CMake version 3.10.
I squashed / am about to squash all commits that should be seen as one.

Reviewers' checklist

Does the changelog entry make sense? Is it formatted correctly?
Do you understand the code changes?

* Reduced version of precice#1029 * Don't support serial implicit coupling due to more difficult data initializatio * Add tests/serial/time/implicit/parallel-coupling with experimental="True" * Add src/time/Waveform and tests * Allow to configure waveform order in read-data, if experimental="True" * Add experimental API function readScalarData accepting a relativeReadTime

uekerman

Looks good overall, "only" cosmetics, main concept is good to go 👍
I did not yet look at the integration tests.

There are still a few refactoring things in this PR, which could easily go into separate PRs. Would make this monster easier to skim 😁

Subcycling is not supported.

Actually, on the reading side, this should already be supported, no?
General concern: We should be careful to not further pollute SolverInterfaceImpl (and src/precice/... in general). It is already now hard to skim. Please only introduce new member variables and functions here if really necessary. And please move whatever possible into the time package.
You have not yet added the new API methods to the C and Fortran bindings. Please do here or open an issue such that we don't forget.
There is still a naming inconsistency: "waveform order" or "interpolation order"?

src/precice/SolverInterface.hpp

src/precice/SolverInterface.cpp

src/precice/config/ParticipantConfiguration.cpp

src/time/Waveform.hpp

src/time/tests/WaveformTest.cpp

…rallel-implicit-read-direction

…implicit-read-direction

* Make configuration files valid by adding participants. * Also provide participant configuration. * Refactor tests w.r.t readability.

…it-read-direction

docs/changelog/1187.md

Co-authored-by: Benjamin Uekermann <[email protected]>

* Create couple-your-code-waveform.md * Documentation for new feature introduced in precice/precice#1187 Co-authored-by: Benjamin Uekermann <[email protected]>

* Use experimental API. Related to precice/precice#1187. * Add missing API functions and fix tests. * Remove API mathods that are removed in preCICE v3.0.0.

BenjaminRodenberg added 2 commits February 17, 2022 11:28

Add tests for non-experimental API and subcycling.

4291f89

BenjaminRodenberg self-assigned this Feb 17, 2022

BenjaminRodenberg added 7 commits February 17, 2022 12:52

Make computeUserOrder non-static.

5e63176

Fix documentation.

fec531e

Fix order.

1138e92

Merge branch 'develop' into waveform-parallel-implicit-read-direction

00901d6

Merge branch 'develop' into waveform-parallel-implicit-read-direction

10ea279

Merge branch 'develop' into waveform-parallel-implicit-read-direction

0ad2a8b

Merge branch 'develop' into waveform-parallel-implicit-read-direction

5b868a2

BenjaminRodenberg added a commit to BenjaminRodenberg/python-bindings that referenced this pull request Feb 18, 2022

Use experimental API. Related to precice/precice#1187.

eb457ef

BenjaminRodenberg mentioned this pull request Mar 3, 2022

Draft: Waveform interpolation, read direction #1029

Closed

34 tasks

BenjaminRodenberg added 2 commits March 3, 2022 16:37

Remove unused.

87d483c

Add new API functions in SolverInterface. Tests are missing.

b38a8a2

BenjaminRodenberg added this to the Version 2.4.0 milestone Mar 9, 2022

BenjaminRodenberg requested a review from uekerman March 9, 2022 16:52

uekerman requested changes Mar 10, 2022

View reviewed changes

BenjaminRodenberg added 7 commits March 21, 2022 18:16

Fix formulation.

fc56ed0

Remove unnecessary comment.

89769c6

Simplify code and improve comments.

ad91a3a

Simplify.

1bb4335

Merge branch 'tests-for-non-experimental-subcycling' into waveform-pa…

ca2541f

…rallel-implicit-read-direction

Merge remote-tracking branch 'origin/develop' into waveform-parallel-…

9f146f0

…implicit-read-direction

Refactor cplscheme tests

7300b9d

* Make configuration files valid by adding participants. * Also provide participant configuration. * Refactor tests w.r.t readability.

BenjaminRodenberg mentioned this pull request Mar 22, 2022

Refactor cplscheme tests #1215

Merged

7 tasks

BenjaminRodenberg added 4 commits March 22, 2022 18:36

Use variable dimensions for better readability.

f2e2ba0

Merge branch 'refactor-cplscheme-tests' into waveform-parallel-implic…

d3f9508

…it-read-direction

Fix.

11717cf

Simplify implementation of data mapping.

45d6004

BenjaminRodenberg mentioned this pull request Mar 23, 2022

Simplify implementation of data mapping in SolverInterfaceImpl #1216

Merged

10 tasks

BenjaminRodenberg added 4 commits April 17, 2022 19:10

Documentation cleanup.

b5eb172

Link to precice#1223.

a49d933

Add PRECICE_CHECK for interpolation order.

2adb887

Add check for direct access already for configuration.

5cc3704

BenjaminRodenberg requested a review from uekerman April 17, 2022 18:00

BenjaminRodenberg mentioned this pull request Apr 17, 2022

Add waveform API methods to C and Fortran bindings #1245

Closed

BenjaminRodenberg added 10 commits April 17, 2022 20:13

Add comment. Related to precice#1196.

0b6d1ef

Remove unused.

b989769

Merge branch 'develop' into waveform-parallel-implicit-read-direction

801e9ff

Update name of main suite.

5992ef5

Add test for all API functions.

69002a4

Fix function and remove unnecessary returns.

94fbeb2

Add vector valued test.

0f28da8

Cleanup.

2afbb43

Add changelog entry.

b819b20

Fix range.

63b341c

uekerman reviewed Apr 18, 2022

View reviewed changes

docs/changelog/1187.md Outdated Show resolved Hide resolved

Use waveform order in isReadDataAvailable.

9aeeed7

BenjaminRodenberg mentioned this pull request Apr 19, 2022

Use-case for isReadDataAvailable and isWriteDataRequired? #1223

Closed

BenjaminRodenberg and others added 2 commits April 19, 2022 11:57

More documentation.

8fc9022

Update docs/changelog/1187.md

f979fe3

Co-authored-by: Benjamin Uekermann <[email protected]>

uekerman approved these changes Apr 19, 2022

View reviewed changes

Merge branch 'develop' into waveform-parallel-implicit-read-direction

38e6f66

BenjaminRodenberg merged commit 65f6cb0 into precice:develop Apr 24, 2022

BenjaminRodenberg deleted the waveform-parallel-implicit-read-direction branch April 24, 2022 16:10

BenjaminRodenberg added a commit to BenjaminRodenberg/precice that referenced this pull request Apr 24, 2022

Use copydoc for functions introduced in precice#1187

26bedb9

BenjaminRodenberg mentioned this pull request Apr 27, 2022

Multiple read mappings to same mesh assign wrong mappingContext to dataContext #1204

Closed

BenjaminRodenberg mentioned this pull request Jul 3, 2022

Waveform interpolation, read direction for serial implicit coupling #1352

Merged

10 tasks

IshaanDesai pushed a commit to precice/python-bindings that referenced this pull request Dec 2, 2022

Compatibility v3.0.0 (#147)

a142d01

* Use experimental API. Related to precice/precice#1187. * Add missing API functions and fix tests. * Remove API mathods that are removed in preCICE v3.0.0.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Waveform interpolation, read direction for parallel implicit coupling#1187

Waveform interpolation, read direction for parallel implicit coupling#1187
BenjaminRodenberg merged 76 commits intoprecice:developfrom
BenjaminRodenberg:waveform-parallel-implicit-read-direction

BenjaminRodenberg commented Feb 17, 2022 •

edited

Loading

Uh oh!

uekerman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

BenjaminRodenberg commented Feb 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Main changes of this PR

Motivation and additional information

Todos

Author's checklist

Reviewers' checklist

Uh oh!

uekerman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BenjaminRodenberg commented Feb 17, 2022 •

edited

Loading