Decouple KeplerianOrbit from GravityEffector #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Former-commit-id: abf9001d6345caf89a3fe3a6d75dfba1742ad5ed Former-commit-id: 1a25a192811f5d584c42e40a9e14f4275345174c
patkenneally
force-pushed
the
refactor/decouple-keplarian-orbit-from-gravityEffector
branch
from
bca364e to
19515e5
Compare
patkenneally
changed the title
patkenneally
changed the title
patkenneally
changed the title
patkenneally
changed the title
patkenneally
changed the title
patkenneally
changed the title
schaubh
requested changes
Dec 16, 2022
This change seek primarily seeks to establish discipline in preventing "use-before-set" possibilities. Generally member data should be initialized in-class or in a constructor initialization list. See C++ Core Guidelines C.48 and C.49
patkenneally
force-pushed
the
refactor/decouple-keplarian-orbit-from-gravityEffector
branch
from
19515e5 to
44fbc26
Compare
schaubh
approved these changes
Dec 16, 2022
patkenneally
deleted the
refactor/decouple-keplarian-orbit-from-gravityEffector
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is a refactoring and introduces no new functionality. The
KeplerianOrbitmodule's coupling withGravityEffector.GravBodyDatais undesirable. TheKeplerianOrbitmodule is using the GravBodyData to get at the mu gravitational constant parameter. No other feature/aspect of the module needs theGravBodyDatatype. We should uncouple these two and change theKeplerianOrbitmodule to take a mu value which is obtained from a source of truth location such asastroConstants.h. Decoupling these also provides a simpler generated Python API where the user of theKeplerianOrbitmodule won't be surprised that theGravBodyDatatype appears. Rather, users are coached to use single source of truth APIs to get at constants.Verification
The unit tests for the module were updated to account for this change in api.
Documentation
Doc strings in the module are updated
Future work
None