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

Document the CCE example input file #6015

Merged

Conversation

nilsdeppe
Copy link
Member

Proposed changes

This is to help people like me who don't know what anything means actually be able to change things in a meaningful way.

Upgrade instructions

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

@nilsdeppe nilsdeppe requested a review from knelli2 May 21, 2024 15:04
@nilsdeppe nilsdeppe force-pushed the cce_tutorial_and_input_file branch from a2eefa9 to 8b65d43 Compare May 21, 2024 15:06
Copy link
Contributor

@keefemitman keefemitman left a comment

Choose a reason for hiding this comment

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

Thanks for adding these details! Everything looks fine to me, but we may want to lower the constant step chooser to 0.1 for production runs (helps with ringdown studies).

StepChoosers:
- Constant: 0.5
- Constant: 0.5 # Don't take steps bigger than 0.5M
Copy link
Contributor

Choose a reason for hiding this comment

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

We might want to lower this to 0.1 for production runs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay, I'll decrease it! We hopefully can have the tests not time out with that so then we can just have the sample not require changes for production :)

tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
Comment on lines 143 to 146
# How often per CCE time step to output. Given the tight default tolerances of
# 1e-6 with an Adams-Bashforth stepper, once per time step is probably fine.
ScriOutputDensity: 1
Copy link
Contributor

Choose a reason for hiding this comment

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

@keefemitman Is this often enough for waveform analysis? I don't have an intuition on what we need

Copy link
Contributor

Choose a reason for hiding this comment

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

1 seems to be fine for the majority of runs I've looked at

@nilsdeppe nilsdeppe force-pushed the cce_tutorial_and_input_file branch from 8b65d43 to 9ad853d Compare May 21, 2024 19:13
@nilsdeppe
Copy link
Member Author

I've rebased and squashed changes. Thanks for the reviews!

Copy link
Contributor

@knelli2 knelli2 left a comment

Choose a reason for hiding this comment

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

One small thing

tests/InputFiles/Cce/CharacteristicExtract.yaml Outdated Show resolved Hide resolved
This is to help people like me who don't know what anything means actually be
able to change things in a meaningful way.
@nilsdeppe nilsdeppe force-pushed the cce_tutorial_and_input_file branch from 9ad853d to a583b01 Compare May 21, 2024 20:07
@nilsdeppe
Copy link
Member Author

Whoops! Done, thanks!

@knelli2 knelli2 merged commit a47e22c into sxs-collaboration:develop May 22, 2024
21 of 22 checks passed
@nilsdeppe nilsdeppe deleted the cce_tutorial_and_input_file branch August 6, 2024 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants