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

Write an H5::Cce file from the *CharacteristicExtract execs #5985

Merged
merged 3 commits into from
May 15, 2024

Conversation

knelli2
Copy link
Contributor

@knelli2 knelli2 commented May 11, 2024

Proposed changes

Instead of writing a bunch of .dat files in the H5 file for each Bondi quantity at future null infinity, CharacteristicExtract and KleinGordonCharacteristicExtract now output an H5::Cce subfile. See #5963 for more details about the subfile.

Upgrade instructions

The output from CCE in the reductions file should only be a Cce.cce subfile. It won't have a bunch of .dat files anymore.

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

@knelli2 knelli2 requested a review from nilsdeppe May 11, 2024 21:49
@knelli2 knelli2 added the in progress Don't review, used for sharing code and getting feedback label May 11, 2024
@knelli2
Copy link
Contributor Author

knelli2 commented May 11, 2024

Note that I still need to update the CCE tutorial docs

@knelli2 knelli2 removed the in progress Don't review, used for sharing code and getting feedback label May 13, 2024
Copy link
Contributor Author

@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.

Ok @nilsdeppe this is ready for review

Comment on lines 210 to 211

const std::string subfile_name{"Cce"};
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this what we want to name the subfile? This produces output in the H5 file like

/Cce.cce                 Group
/Cce.cce/EthInertialRetardedTime Dataset {26451/Inf, 163}
/Cce.cce/News            Dataset {26451/Inf, 163}
/Cce.cce/Psi0            Dataset {26451/Inf, 163}
/Cce.cce/Psi1            Dataset {26451/Inf, 163}
/Cce.cce/Psi2            Dataset {26451/Inf, 163}
/Cce.cce/Psi3            Dataset {26451/Inf, 163}
/Cce.cce/Psi4            Dataset {26451/Inf, 163}
/Cce.cce/Strain          Dataset {26451/Inf, 163}
/src.tar.gz              Dataset {7757329}

which seems a bit redundant? Other options could be /Bondi.cce, /Scri.cce, /FutureNullInfinity.cce, /SpECTRE.cce.

Copy link
Member

Choose a reason for hiding this comment

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

I agree. I think any are fine, except maybe Bondi to avoid confusion with the BondiSachs worldtube data we write out from GH that's input into CCE? Another option could be to append the worldtube radius? E.g. SpectreR100.cce in case we do want to run multiple CCE's simultaneously in the future.

Copy link
Member

@nilsdeppe nilsdeppe left a comment

Choose a reason for hiding this comment

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

LGTM, please go ahead and squash :)

Comment on lines 210 to 211

const std::string subfile_name{"Cce"};
Copy link
Member

Choose a reason for hiding this comment

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

I agree. I think any are fine, except maybe Bondi to avoid confusion with the BondiSachs worldtube data we write out from GH that's input into CCE? Another option could be to append the worldtube radius? E.g. SpectreR100.cce in case we do want to run multiple CCE's simultaneously in the future.

@knelli2 knelli2 force-pushed the h5_cce_action branch 2 times, most recently from bbdbcd5 to 0cafb3e Compare May 14, 2024 21:05
@knelli2
Copy link
Contributor Author

knelli2 commented May 14, 2024

@nilsdeppe Rebased and squashed in existing fixups. Added one new commit that adds the extraction radius to the global cache for CCE execs because it wasn't there before, and then another fixup that changes the subfile name to SpectreRXXXX.cce. I also discussed this name with @keefemitman and this was the one he preferred.

Copy link
Member

@nilsdeppe nilsdeppe left a comment

Choose a reason for hiding this comment

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

Looks great! A couple small optional things you can do if you want while squashing. Thanks for checking with Keefe! I like this naming :)

#include <string>

namespace Cce {
// retrieves the extraction radius from the specified file.
Copy link
Member

Choose a reason for hiding this comment

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

Add another slash to make these Doxygen comments?

And maybe group together with next one?

ERROR(
"The CCE filename must encode the extraction radius as an integer "
"between the first instance of 'R' and the first instance of '.' "
"(SpEC "
Copy link
Member

Choose a reason for hiding this comment

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

[optional] Combine with next line?

@nilsdeppe nilsdeppe merged commit 6298f5d into sxs-collaboration:develop May 15, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants