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

Enhancement/enhanced polyhedral gravity model #825

Merged
merged 6 commits into from
Oct 24, 2024

Conversation

julsanmer
Copy link
Contributor

  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

Changed the math to evaluate polyhedron gravity to be more computationally efficient. The key is to initialize and store several variables that are non-related to the evaluation point.

Verification

The polyhedron gravBody unit test succeeds.

Documentation

I've included html documentation for the polyhedron gravity. I think that by proceeding this way, the documentation is more clearer and accessible than with the big pdf on gravityEffector. But open to other thoughts.

Future work

Should the gravity models be stored in specific folders within the gravityEffector folder? It'd feel more organized this way.
As my time allows, I'd try to PR other features that could be of interest to BSK project.

@julsanmer julsanmer requested a review from a team as a code owner October 2, 2024 16:42
@schaubh schaubh self-assigned this Oct 15, 2024
@schaubh schaubh added the enhancement New feature or request label Oct 15, 2024
Copy link
Contributor

@schaubh schaubh 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 the contribution. Please see
https://github.com/AVSLab/basilisk/blob/develop/CONTRIBUTING.md
on the new contributing requirements where we run a precommit script to ensure proper formatting, removing of trailing white spaces, etc. I already fixed the issues and pushed the fix.

The documentation is now also auto-built and tested on the CI server. It had an error with the RST formatting, and because your last section had non content. Could you please add content or remove the last section title?

@schaubh
Copy link
Contributor

schaubh commented Oct 17, 2024

I see odd structure in your branch now. Please use rebasing to make a clean branch, not merging. Also, let me know when ready to review again. Please do a rebase on develop before asking for next review to ensure there are no conflicts.

@schaubh schaubh force-pushed the feature/enhanced_polyhedralGravityModel branch from d0ec09f to 96ffe84 Compare October 19, 2024 10:42
Copy link
Contributor

@schaubh schaubh left a comment

Choose a reason for hiding this comment

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

We have a clean branch now. Please double check that you are still getting the expected functionality.

  • address the variable naming issue
  • add release notes

@julsanmer julsanmer force-pushed the feature/enhanced_polyhedralGravityModel branch from 59ed291 to 1b13e3b Compare October 23, 2024 17:00
@schaubh schaubh force-pushed the feature/enhanced_polyhedralGravityModel branch from 1b13e3b to 659dca5 Compare October 23, 2024 18:30
@schaubh schaubh merged commit 438c600 into develop Oct 24, 2024
9 checks passed
@schaubh schaubh deleted the feature/enhanced_polyhedralGravityModel branch October 24, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants