Document differences between OpenFOAM versions #351
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
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.
During the preCICE Workshop 2024, and in the context of #328, we decided (among other things) to document the relevant differences between OpenFOAM versions. This should help maintainers port new versions of the adapters to other OpenFOAM versions, even if the development state diverges so much that Git rebasing becomes difficult.
This PR adds documentation for each version (under OpenFOAM support):
The list of differences is based on a text comparison between the release artifacts of v1.2.3.
This is now ready for review, but it might be worth it waiting for me to do the actual porting before merging, as more changes might be relevant now.
TODO list:
docs/changelog-entries/(create directory if missing)