Skip to content

Add LabFrameParticleDiagnostic to picmi #4148

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

Merged

Conversation

dpgrote
Copy link
Member

@dpgrote dpgrote commented Aug 1, 2023

Note that with LabFrameParticleDiagnostic or LabFrameFieldDiagnostic, both the particles and fields will be written out. Each has a flag to turn the other off. This is the same way that the regular diagnostics are setup.

@dpgrote dpgrote added component: PICMI Standardized input format component: diagnostics all types of outputs labels Aug 1, 2023
@RemiLehe RemiLehe self-assigned this Aug 8, 2023
@@ -2212,16 +2215,19 @@ class LabFrameFieldDiagnostic(picmistandard.PICMI_LabFrameFieldDiagnostic,

warpx_upper_bound: vector of floats, optional
Passed to <diagnostic name>.upper_bound

warpx_write_species: bool, optional, default=True
Copy link
Member

Choose a reason for hiding this comment

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

In PICMI, I think it makes more sense to turn them off by default...

Suggested change
warpx_write_species: bool, optional, default=True
warpx_write_species: bool, optional, default=False

warpx_buffer_size: integer, optional
Passed to <diagnostic name>.buffer_size

warpx_write_fields: bool, optional, default=True
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
warpx_write_fields: bool, optional, default=True
warpx_write_fields: bool, optional, default=False

Comment on lines +2295 to +2297
for more information.

This will by default write out both field and particle data. This can be changed by setting warpx_write_fields.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
for more information.
This will by default write out both field and particle data. This can be changed by setting warpx_write_fields.
for more information.

Comment on lines +2192 to +2194
for more information.

This will by default write out both field and particle data. This can be changed by setting warpx_write_species.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
for more information.
This will by default write out both field and particle data. This can be changed by setting warpx_write_species.
for more information.

self.format = kw.pop('warpx_format', None)
self.openpmd_backend = kw.pop('warpx_openpmd_backend', None)
self.file_prefix = kw.pop('warpx_file_prefix', None)
self.file_min_digits = kw.pop('warpx_file_min_digits', None)
self.buffer_size = kw.pop('warpx_buffer_size', None)
self.lower_bound = kw.pop('warpx_lower_bound', None)
self.upper_bound = kw.pop('warpx_upper_bound', None)
self.write_species = kw.pop('warpx_write_species', None)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self.write_species = kw.pop('warpx_write_species', None)
self.write_species = kw.pop('warpx_write_species', False)

self.file_prefix = kw.pop('warpx_file_prefix', None)
self.file_min_digits = kw.pop('warpx_file_min_digits', None)
self.buffer_size = kw.pop('warpx_buffer_size', None)
self.write_fields = kw.pop('warpx_write_fields', None)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self.write_fields = kw.pop('warpx_write_fields', None)
self.write_fields = kw.pop('warpx_write_fields', False)

@ax3l
Copy link
Member

ax3l commented Aug 28, 2023

We can address my comments in #3207

@ax3l ax3l merged commit a6b73ef into BLAST-WarpX:development Aug 28, 2023
@ax3l ax3l mentioned this pull request Aug 29, 2023
@dpgrote dpgrote deleted the add_LabFrameParticleDiagnostic branch November 17, 2023 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: diagnostics all types of outputs component: PICMI Standardized input format
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants