Synchronize porting guide with precice-v3
#298
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…de-porting-v2-3.md
BenjaminRodenberg
requested review from
MakisH,
fsimonis,
davidscn and
IshaanDesai
|
@davidscn @carme-hp @MakisH @IshaanDesai @fsimonis: If you see something here that is wrong: Please directly fix it on the branch. |
IshaanDesai
approved these changes
Nov 13, 2023
MakisH
approved these changes
Nov 13, 2023
Comment on lines
-32
to
+36
| - Replace `precice::constants::*` with `isActionRequired()` and `markActionFulfilled()` with their respective requirement clause: `requiresInitialData()`, `requiresReadingCheckpoint()` or `requiresWritingCheckpoint()`. If these requirements are checked, then they are promised to be acted on. | ||
| - Replace `isMeshConnectivityRequired` with `requiresMeshConnectivityFor`. | ||
| - Replace `isGradientDataRequired` with `requiresGradientDataFor`. Instead of the input argument dataID, pass the meshName and dataName. | ||
| - Replace `isActionRequired()` with their respective requirement clause: `requiresInitialData()`, `requiresReadingCheckpoint()` or `requiresWritingCheckpoint()`. | ||
| - Remove `precice::constants::*` and corresponding `#include` statements as they are no longer needed. | ||
| - Remove `markActionFullfiled()`. If `requiresInitialData()`, `requiresReadingCheckpoint()`, or `requiresWritingCheckpoint()` are called, then they are promised to be acted on. Therefore, `markActionFullfiled()` is no longer needed. | ||
| - Replace `isMeshConnectivityRequired` with `requiresMeshConnectivityFor`. Instead of the input argument `meshID`, pass the `meshName`. | ||
| - Replace `isGradientDataRequired` with `requiresGradientDataFor`. Instead of the input argument `dataID`, pass the `meshName` and `dataName`. |
There was a problem hiding this comment.
I like how this part is broken down to simpler, clearer steps. 👍
(whoever did that: good job! -- that's @IshaanDesai )
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I just did a merge of
masterintoprecice-v3and resolved the resulting merge conflict in the porting guide.After resolving the merge conflict, I created this branch and did
git checkout precice-v3 pages/docs/couple-your-code/couple-your-co…de-porting-v2-3.md. The reson for this PR is to be able to review my resolution of the merge conflict.To avoid this in the future: Generally, we should always keep the porting guide on
masterandprecice-v3synchronized, because there is no reason to not directly publish changes in the porting guide to master. The purpose ofprecice-v3is to develop the documentation that we cannot publish yet, because it would overwrite the v2 documentation that is still relevant for users.There are two important rules:
master. Don't forget to mergemasterintoprecice-v3(e.g. Porting guide hint for removed preallocation option #288 and Clarify some instructions in porting guide #287).precice-v3, you should make sure to synchronize the porting guide withmaster.Relevant changes to review:
@davidscn #290
@carme-hp #287
@IshaanDesai 91efb0a
@MakisH 778ce08
@fsimonis c8740c3