Skip to content

Update WR documentation for serial coupling#174

Closed
BenjaminRodenberg wants to merge 5 commits intoprecice-v3from
waveform-serial-coupling
Closed

Update WR documentation for serial coupling#174
BenjaminRodenberg wants to merge 5 commits intoprecice-v3from
waveform-serial-coupling

Conversation

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor

@BenjaminRodenberg BenjaminRodenberg commented Jun 14, 2022

This PR provides documentation related to the feature precice/precice#1029.

Todo

@BenjaminRodenberg BenjaminRodenberg added the documentation Improvements or additions to documentation label Jun 14, 2022
@BenjaminRodenberg BenjaminRodenberg self-assigned this Jun 14, 2022
Comment on lines +97 to +101
## Initialize Data

* When using waveform iteration both participants can initialize data, even when serial implicit coupling is used.
* Reason for this: Initialized data is used at the beginning of the window. First write data at the end of the window. This means: Also first participant can initialize data that will be used by second participant at the beginning of the window. The the same time there is already data available at the end of the window in the first iteration of a serial implict coupling scheme.
* If no initial data is provided, the data at the beginning of the window is **always** implicitly set to zero and there is no possibility to change this.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Initialize Data
* When using waveform iteration both participants can initialize data, even when serial implicit coupling is used.
* Reason for this: Initialized data is used at the beginning of the window. First write data at the end of the window. This means: Also first participant can initialize data that will be used by second participant at the beginning of the window. The the same time there is already data available at the end of the window in the first iteration of a serial implict coupling scheme.
* If no initial data is provided, the data at the beginning of the window is **always** implicitly set to zero and there is no possibility to change this.
## Initialize Data
* When using waveform iteration both participants can initialize data, even when serial implicit coupling is used.
* Reason for this: Initialized data is used at the beginning of the window. First write data at the end of the window. This means: Also first participant can initialize data that will be used by second participant at the beginning of the window. The the same time there is already data available at the end of the window in the first iteration of a serial implict coupling scheme.
* If no initial data is provided, the data at the beginning of the window is **always** implicitly set to zero and there is no possibility to change this.
Suggested change
## Initialize Data
* When using waveform iteration both participants can initialize data, even when serial implicit coupling is used.
* Reason for this: Initialized data is used at the beginning of the window. First write data at the end of the window. This means: Also first participant can initialize data that will be used by second participant at the beginning of the window. The the same time there is already data available at the end of the window in the first iteration of a serial implict coupling scheme.
* If no initial data is provided, the data at the beginning of the window is **always** implicitly set to zero and there is no possibility to change this.
## Initialize data
* When using waveform iteration, both participants can initialize data, even when serial-implicit coupling is used.
* Reason for this: Initialized data is used at the beginning of the window. First write data at the end of the window. Thus, the first participant can initialize data that is used by the second participant at the beginning of the window.
* If no initial data is provided, the data at the beginning of the window is **always** implicitly set to zero.

The sentence "The the same time there is already data available ...", I did not understand.

Could we add figures here? 😁

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will try to come up with a nice figure 👍

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor Author

Since we decided to removed initializeData in precice/precice#1350 I think it might be better to revise https://precice.org/couple-your-code-initializing-coupling-data.html. This might also simplify what we have to explain here. If we drop the restriction that a serial coupling scheme cannot initialize data for both participants, we do not have to worry about this anymore. I will also open an issue in precice/precice.

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor Author

I added an issue on the topic of data initialization: precice/precice#1367

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor Author

I also updated the documentation on data initialization: #186

@BenjaminRodenberg BenjaminRodenberg added the breaking change A change will break backwards compatibilty label Jul 16, 2022
@uekerman uekerman changed the title Update documentation for support of serial coupling Update WR documentation for serial coupling Apr 14, 2023
@BenjaminRodenberg BenjaminRodenberg changed the base branch from master to develop-v3 April 21, 2023 07:55
@BenjaminRodenberg BenjaminRodenberg added this to the Version 3.0.0 milestone Apr 21, 2023
@BenjaminRodenberg BenjaminRodenberg marked this pull request as ready for review November 11, 2023 10:06
@BenjaminRodenberg
Copy link
Copy Markdown
Contributor Author

Closing this PR, because most changes are on precice-v3 already and rest is trivial.

@BenjaminRodenberg BenjaminRodenberg deleted the waveform-serial-coupling branch July 10, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking change A change will break backwards compatibilty documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants