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.

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

move Diagnostic class from Fields to Hipace class #513

Merged

Conversation

SeverinDiederichs
Copy link
Member

In preparation to make the diagnostics more general, the FieldDiagnostic class is moved from Fields to Hipace and renamed to Diagnostic.

This does not change anything for the user.

Further PRs will include more flexibility on the beam IO and moving functions and input parameters (FillDiagnostic, output_period) to this class.

  • 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

@SeverinDiederichs SeverinDiederichs added cleaning Code cleaning, avoid duplication, better naming, better style etc. component: diagnostics About any types of diagnostics labels May 20, 2021
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.

Looks good to me, thanks.

@MaxThevenet MaxThevenet merged commit 51225c1 into Hi-PACE:development May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleaning Code cleaning, avoid duplication, better naming, better style etc. component: diagnostics About any types of diagnostics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants