Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add [z], [z^2], [uz], [uz^2] and [z*uz] to beam insitu diagnostics #964

Merged
merged 26 commits into from
Jun 2, 2023
Merged

Add [z], [z^2], [uz], [uz^2] and [z*uz] to beam insitu diagnostics #964

merged 26 commits into from
Jun 2, 2023

Conversation

AlexanderSinn
Copy link
Member

@AlexanderSinn AlexanderSinn commented May 31, 2023 •
edited
Loading

One could previously get similar results using z_axis and [ga], but adding these to the diagnostic directly is more intuitive and accurate.

Backwards compatibility Note:
This PR renames read_insitu_diagnostics.energy_spread(all_data) to read_insitu_diagnostics.gamma_spread(all_data).

  • Small enough (< few 100s of lines), otherwise it should probably be split into smaller PRs
  • Tested (describe the tests in the PR description)
  • Runs on GPU (basic: the code compiles and run well with the new module)
  • Contains an automated test (checksum and/or comparison with theory)
  • Documented: all elements (classes and their members, functions, namespaces, etc.) are documented
  • Constified (All that can be const is const)
  • Code is clean (no unwanted comments, )
  • Style and code conventions are respected at the bottom of https://github.com/Hi-PACE/hipace
  • Proper label and GitHub project, if applicable

@AlexanderSinn AlexanderSinn changed the title Add [z], [z^2], [uz] and [uz^2] to insitu diagnostics Add [z], [z^2], [uz] and [uz^2] to beam insitu diagnostics May 31, 2023
@AlexanderSinn AlexanderSinn added component: beam About the beam species component: diagnostics About any types of diagnostics labels May 31, 2023
@AlexanderSinn AlexanderSinn requested a review from MaxThevenet June 1, 2023 12:15
@MaxThevenet MaxThevenet added the non-backward-compatible Changes the behavior of the code, old input file may give different results label Jun 1, 2023
MaxThevenet
MaxThevenet reviewed Jun 1, 2023
View reviewed changes
Copy link
Member

@MaxThevenet MaxThevenet left a comment

Choose a reason for hiding this comment

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

Thanks for this PR! See 1 comment below. Another point (discussion started offline): Should we add <z*uz> as an output? @SeverinDiederichs @AlexanderSinn.

tools/read_insitu_diagnostics.py Outdated Show resolved Hide resolved
@MaxThevenet MaxThevenet removed the non-backward-compatible Changes the behavior of the code, old input file may give different results label Jun 1, 2023
@AlexanderSinn AlexanderSinn changed the title Add [z], [z^2], [uz] and [uz^2] to beam insitu diagnostics Add [z], [z^2], [uz], [uz^2] and [z*uz] to beam insitu diagnostics Jun 2, 2023
MaxThevenet
MaxThevenet approved these changes Jun 2, 2023
View reviewed changes
Copy link
Member

@MaxThevenet MaxThevenet left a comment

Choose a reason for hiding this comment

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

thanks for this PR!

@MaxThevenet MaxThevenet merged commit 9679eed into Hi-PACE:development Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaxThevenet MaxThevenet MaxThevenet approved these changes

Assignees
No one assigned
Labels
component: beam About the beam species component: diagnostics About any types of diagnostics
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexanderSinn @MaxThevenet