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.

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

Use new common time dependent options in Sphere and BCO domains #6115

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

knelli2
Copy link
Contributor

@knelli2 knelli2 commented Jun 25, 2024

Proposed changes

Final PR in the series that revamps the time dependent options for the Sphere and BCO domains.

This actually adds all the new common options to the domain creators.

Fixes #5584.

Upgrade instructions

The options for the Rotation and Expansion map have changed. They are now

    TimeDependentMaps:
      ...
      ExpansionMap:
        InitialValues: [1.0, -4.6148457646200002e-05, 0.0] # <-- Must specify all derivs
        InitialValuesOuterBoundary: [1.0, 0.0, 0.0] # <-- Must specify all derivs
        DecayTimescale: Auto # <-- Used for SettleToConst FoT
        DecayTimescaleOuterBoundary: 50.0 # <-- Same as before
        AsymptoticVelocityOuterBoundary: -1.0e-6 # <-- Same as before
      RotationMap:
        InitialQuaternions: [[1.0, 0.0, 0.0, 0.0]] # <-- Need quat. Can optionally specify derivs
        InitialAngles: # <-- Need angle. Can optionally specify derivs (like angular velocity)
          - [0.0, 0.0, 0.0]
          - [0.0, 0.0, 1.5264577062000000e-02] # <-- This is now angular velocity
        DecayTimescale: Auto # <-- used for SettleToConst FoT

For any of the time dependent map options, you can choose the function of time from a volume file by specifying the following options (not just for Expansion, but for Rotation, Translation, and Shape as well)

    TimeDependentMaps:
      ...
      ExpansionMap:
        H5Filename: BbhVolume0.h5
        SubfileName: VolumeData
        Time: 0.0

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

Depends on and includes #6109, #6113, and #6114.

@knelli2 knelli2 added this to the BBH First Paper milestone Jun 25, 2024
@knelli2 knelli2 changed the title Dc time dep opts 4 Use new common time dependent options in Sphere and BCO domains Jun 25, 2024
@knelli2 knelli2 added dependent Needs a different PR to be merged in first labels Jun 26, 2024
@knelli2 knelli2 removed dependent Needs a different PR to be merged in first labels Sep 19, 2024
@knelli2 knelli2 added the in progress Don't review, used for sharing code and getting feedback label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress Don't review, used for sharing code and getting feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Read in FoT parameters from file in BCO domain creators
1 participant