Skip to content

Documentation for waveform interpolation#109

Merged
BenjaminRodenberg merged 38 commits intomasterfrom
BenjaminRodenberg-waveform-doc
Apr 24, 2022
Merged

Documentation for waveform interpolation#109
BenjaminRodenberg merged 38 commits intomasterfrom
BenjaminRodenberg-waveform-doc

Conversation

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor

Provides documentation for new feature in precice/precice#1029.

@BenjaminRodenberg BenjaminRodenberg added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 30, 2021
@BenjaminRodenberg BenjaminRodenberg self-assigned this Dec 30, 2021
Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

I think it was a good step to write this down. We clearly see where there are still open problems.

Before merging at some point, also somebody not familiar with the new functionality should review this.

Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Looking good 👍
Still a few tweaks, but should all be easy.
Then, I would suggest that somebody not so familiar with your PRs looks over this.

Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Minor language tweaks, otherwise good to go from my side.
Could still be helpful to let a non-expert read over this.

@boris-martin
Copy link
Copy Markdown
Contributor

I just had a quick read as a naive reader, and I wondered how we reconcile order of the waveform and numbers of subcycles. If I want a 2nd order waveform but perform 10 steps, how will the polynom be built ? Least-squares fit ? Arbirtray selection of 3 points ?
An additional paragraph (or a sentence/reference to something else) looks welcome to me.
Otherwise it's quite easy to understand.

@BenjaminRodenberg
Copy link
Copy Markdown
Contributor Author

I just had a quick read as a naive reader, and I wondered how we reconcile order of the waveform and numbers of subcycles.

Currently the implementation is very limited here. There is basically only the possibility to create a linear interpolant from the first and last sample in the window. If you are subcycling, all samples between will be ignored (they are not even communicated). I'm describing the current restrictions and the rough plan here: precice/precice#1171.

@BenjaminRodenberg BenjaminRodenberg merged commit d8b3978 into master Apr 24, 2022
@MakisH MakisH deleted the BenjaminRodenberg-waveform-doc branch July 27, 2023 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants