Decorate two_fluid dispersion solver with @particle_input
#2022
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
namurphy
added
plasmapy.dispersion
namurphy
commented
Mar 17, 2023
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #2022 +/- ##
==========================================
- Coverage 98.31% 98.31% -0.01%
==========================================
Files 98 98
Lines 8622 8608 -14
==========================================
- Hits 8477 8463 -14
Misses 145 145
☔ View full report in Codecov by Sentry. |
The charge number is now contained in `ion`.
namurphy
changed the title
two_fluid with @particle_inputtwo_fluid dispersion solver with @particle_input
…article-input-two-fluid
The ones from that are positional are all distinguishable by unit or particle-like-ness, so having allowing it to be positional is not likely to cause any problems.
…article-input-two-fluid
…article-input-two-fluid
…article-input-two-fluid
namurphy
added
breaking change
…article-input-two-fluid
This was referenced May 31, 2023
Make certain functions correctly account for mass of electrons in ions when
z_mean is provided
#2178
Open
namurphy
added
status: ready for review
ejohnson-96
approved these changes
May 31, 2023
My hope is that by implementing Thank you as always for the reviews! |
github-actions
bot
removed
the
status: ready for review
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 decorates
plasmapy.dispersion.analytical.two_fluid_.two_fluidwith@particle_input.A new capability is that
two_fluidwill now acceptmass_numbseparately fromion.There are some breaking changes:
z_meanparameter got changed toZfortwo_fluid(for consistency with how we're handling the charge numberz_meanwill no longer override the charge provided inion(since having contradictory arguments make code confusing to read without referring to the docstring)Motivation and context
Using
@particle_inputhere will allow us to drop two blocks of code which were validatingionandz_mean. Plus, using the mechanics allowed by@particle_inputwill give a more consistent user experience across subpackages.Related issues
This is motivated by #1869, which at present is marking some
z_meanoverride tests as expecting to fail.This is an offshoot of #341, except for
plasmapy.dispersioninstead ofplasmapy.formulary.