ENH: Enable only radial burning
Pull request type
- [X] Code changes (bugfix, features)
Checklist
- [ ] Lint (
black rocketpy/ tests/) has passed locally - [ ] All tests (
pytest tests -m slow --runslow) have passed locally - [x]
CHANGELOG.mdhas been updated (if relevant)
Current behavior
Rocketpy SolidMotor class simulates the grain regression either radially and axially by default.
This PR is related to the following issue: ENH: Enable only radial burning #801
New behavior
Now it's possible to the user to change from the default behavior to a only radial regression by setting the new "only_radial_burning" optional parameter as True in the SolidMotor class.
Breaking change
- [x] No
Additional information
Here is an example of the comparison between the default burning and the only radial one applied to the getting_started.ipynb simulation. The pytest tests haven't passed locally because of a windows problem.
Codecov Report
:x: Patch coverage is 45.83333% with 13 lines in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 80.24%. Comparing base (9cf3dd4) to head (ef661c4).
:warning: Report is 5 commits behind head on develop.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| rocketpy/motors/solid_motor.py | 45.83% | 13 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## develop #815 +/- ##
===========================================
- Coverage 80.27% 80.24% -0.04%
===========================================
Files 104 104
Lines 12769 12829 +60
===========================================
+ Hits 10250 10294 +44
- Misses 2519 2535 +16
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
Are we missing something in the HybridMotor class here? If we want to define a a HybridMotor with only radial burning garin how would we do that currently?
I recommend modifyng the hybrid class in another PR, it's easier to reivew it.
But if you really want to include hybrid motors here, not a problem
@phmbressan I will wait for your re-review before reviewing this one. I think you have more critical comments than me.
I would like to release this one soon.