Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document behaviour changes introduced #1784 #1888

Merged
merged 3 commits into from
Feb 18, 2023
Merged

Document behaviour changes introduced #1784 #1888

merged 3 commits into from
Feb 18, 2023

Commits on Feb 17, 2023

  1. Document behaviour changes introduced #1784 

    The PR in #1784 claimed not to introduce behaviour changes,
but actually ended up introducing behaviour changes. Specifically,
it would break a lot of marine simulation code that runs on our tools.
The issue in question is a matter of naming parameters. In the past
`<xUU>` used to refer to the quadratic drag term in the diagonal axis.
This term would be multiplied by the absolute velocity. After #1784 this term
was multiplied by the velocity (no absolute). An equivalent term of `<xUabsU>`
This behaviour change likely breaks all previous maritime simulations that rely on our hydrodynamics plugin.

There are several options:
1. Revert #1784
2. Make `<xUU>` mirror `<xUabsU>`
3. Document the change and mark it as breaking.

This PR goes with option 3 as there are already code bases using `<xUabsU>` nota
tion instead of `<xUU>`. We also add a warning if someone does use the `<xUU>`
term that points to this PR for details.

Signed-off-by: Arjo Chakravarty <arjoc@intrinsic.ai>
    @arjo129
    Arjo Chakravarty authored and arjo129 committed Feb 17, 2023
    Configuration menu
    Copy the full SHA
    27ee7ba View commit details
    Browse the repository at this point in the history

  2. Add link to discussion. 

    Signed-off-by: Arjo Chakravarty <arjoc@intrinsic.ai>
    @arjo129
    arjo129 committed Feb 17, 2023
    Configuration menu
    Copy the full SHA
    0e7f25d View commit details
    Browse the repository at this point in the history

  3. Address knits. 

    Signed-off-by: Arjo Chakravarty <arjoc@intrinsic.ai>
    @arjo129
    arjo129 committed Feb 17, 2023
    Configuration menu
    Copy the full SHA
    78e9e32 View commit details
    Browse the repository at this point in the history