Enable different types of diagnostics for ParticleDiagnostic() in Python #4720
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
EyaDammak
changed the title
ParticleScraping in Python
EyaDammak
changed the title
EyaDammak
changed the title
EyaDammak
changed the title
ax3l
reviewed
Feb 23, 2024
| @@ -2404,6 +2404,7 @@ class ParticleDiagnostic(picmistandard.PICMI_ParticleDiagnostic, WarpXDiagnostic | |||
| def init(self, kw): | |||
|
|
|||
| self.format = kw.pop('warpx_format', 'plotfile') | |||
| self.type = kw.pop('warpx_diag_type', 'Full') | |||
There was a problem hiding this comment.
Awesome, great work!
Can you please just a few lines above, in the documentation string, add an entry for the new warpx_diag_type option? That way it will be shown in our manual automatically and users will find it.
https://warpx.readthedocs.io/en/latest/usage/python.html#diagnostics
RemiLehe
reviewed
Feb 29, 2024
| @@ -2383,6 +2383,9 @@ class ParticleDiagnostic(picmistandard.PICMI_ParticleDiagnostic, WarpXDiagnostic | |||
| warpx_format: {plotfile, checkpoint, openpmd, ascent, sensei}, optional | |||
| Diagnostic file format | |||
|
|
|||
| warpx_diag_type: {Full, BoundaryScraping, BackTransformed}, 'Full' by default, optional | |||
There was a problem hiding this comment.
Hm, allowing BackTransformed makes it confusing, since this seems to duplicate the capability of LabFrameParticleDiagnostic... We can discuss this in more detail.
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.
This PR enables to have the file of
ParticleDiagnosticwith different type ("Full", "BoundaryScraping" or "BackTransformed").This is possible in adding the option
warpx_diag_typeinpicmi.ParticleDiagnostic()The option warpx_diag_type='Full' is set by default.