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

Unify naming pattern of excision spheres #4747

Merged
merged 1 commit into from Feb 17, 2023

Conversation

knelli2
Copy link
Contributor

@knelli2 knelli2 commented Feb 16, 2023

Proposed changes

Most other things have the convention ThingLabel, but the excision spheres were named ObjectLabelThing. This changes all occurrences of Object{A,B}ExcisionSphere to ExcisionSphere{A,B} and CentralExcisionSphere to just ExcisionSphere

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

Most other things have the convention ThingLabel, but the excision
spheres were named ObjectLabelThing. This changes all occurrences
of Object{A,B}ExcisionSphere to ExcisionSphere{A,B} and
CentralExcisionSphere to just ExcisionSphere
@@ -510,7 +510,7 @@ Domain<3> BinaryCompactObject::create_domain() const {
std::unordered_map<std::string, ExcisionSphere<3>> excision_spheres{};
if (object_A_.is_excised()) {
excision_spheres.emplace(
"ObjectAExcisionSphere",
"ExcisionSphereA",
Copy link
Member

Choose a reason for hiding this comment

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

Maybe replace all these hardcoded names with get_output(label)? It's easier to regex-replace domain::ObjectLabel::A than literal single-character As :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was going to do a separate PR where I used the ObjectLabel for the names in the BBH domains (excision spheres and functions of time). Does that sound ok?

Copy link
Member

Choose a reason for hiding this comment

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

sure whatever is easiest

@nilsvu nilsvu added the auto-merge GitHub's auto-merge has been enabled for this PR. label Feb 16, 2023
@nilsvu nilsvu merged commit f2ce66c into sxs-collaboration:develop Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-merge GitHub's auto-merge has been enabled for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants