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 beam eigenemittances to reduced diagnostics. #702

Merged
merged 54 commits into from
Oct 10, 2024
Merged

Add beam eigenemittances to reduced diagnostics. #702

merged 54 commits into from
Oct 10, 2024

Conversation

cemitch99
Copy link
Member

@cemitch99 cemitch99 commented Sep 13, 2024 •
edited
Loading

This PR adds calculation of the 3 eigenemittances (or mode emittances) of the 6D beam distribution from particle data as an additional reduced diagnostic. Addresses Issue #663.

  • implement auxiliary math routines needed to evaluate the characteristic polynomial and find its roots
  • implement calculation of eigenemittances from a covariance matrix
  • add additional required moment calculations in ReducedBeamCharacteristics.cpp
    • skip eigenemittance columns from CSV output if not enabled
    • add normalized emittance independently (always)
  • make reduced diagnostic calculation optional, and add print to output
  • add numerical benchmark example
  • add ParmParse statement to enable/disable calculation
  • check numerical precision for special degenerate cases (zero discriminant)
  • add documentation
    • document user-facing inputs/python control
  • fix pytest using test_transformation.py
  • add liteature citations

@cemitch99
Update ReducedBeamCharacteristics.cpp
d4f0a14 
Comment benchmarking call to Eigenemittance to avoid unused variable errors.
@cemitch99
Copy link
Member Author

This works, but suffers a loss of precision in certain cases (eg, uncoupled beams with et << ex = ey) due to the appearance of a small discriminant in Cardano's formula. A fix for this is under investigation.

Some tests failing for unrelated reasons due to pytest.

ax3l
ax3l reviewed Sep 25, 2024
View reviewed changes
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

Thank you!!

I took a quick first look and added first inline suggestions. More thorough tomorrow :)

src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.H Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Outdated Show resolved Hide resolved
examples/coupled_optics/README.rst Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Show resolved Hide resolved
cemitch99 and others added 2 commits September 25, 2024 10:25
@cemitch99 @ax3l
Apply suggestions from code review
c883ee8 
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
@cemitch99
Update EmittanceInvariants.cpp
0172e10 
Add PROFILE header.
cemitch99 and others added 4 commits September 25, 2024 17:24
@cemitch99
Update CovarianceMatrixMath.H
587a095 
Use math functions from std::  (sqrt, pow, sin, cos, etc) -> (std::sqrt, std::pow, std::sin, std::cos, etc).
@cemitch99 @ax3l
Update src/particles/diagnostics/CovarianceMatrixMath.H
851b46a 
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
@cemitch99
Update CovarianceMatrixMath.H
45f21b9
@cemitch99
Update CovarianceMatrixMath.H
59f5b4d 
Remove std::math for complex functions.
@ax3l ax3l mentioned this pull request Oct 1, 2024
Merged
ax3l
ax3l reviewed Oct 2, 2024
View reviewed changes
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

This looks great!

examples/CMakeLists.txt Outdated Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Show resolved Hide resolved
src/particles/diagnostics/CovarianceMatrixMath.H Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Fixed Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.H Outdated Show resolved Hide resolved
src/particles/diagnostics/EmittanceInvariants.cpp Outdated Show resolved Hide resolved
tests/python/test_transformation.py Outdated Show resolved Hide resolved
ax3l
ax3l reviewed Oct 2, 2024
View reviewed changes
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

Avoid copies of matrices

src/particles/diagnostics/ReducedBeamCharacteristics.cpp Outdated Show resolved Hide resolved
docs/source/dataanalysis/dataanalysis.rst Show resolved Hide resolved
src/particles/diagnostics/ReducedBeamCharacteristics.cpp Show resolved Hide resolved
ax3l pushed a commit to AMReX-Codes/amrex that referenced this pull request Oct 3, 2024
@WeiqunZhang
SmallMatrix: Matrix class with compile time size (#4176)
4ec03b8 
Add amrex::SmallMatrix class with compile time size.

Useful for, e.g.:
- ECP-WarpX/impactx#714
- ECP-WarpX/impactx#702
cemitch99 and others added 2 commits October 8, 2024 11:43
@cemitch99
Update CovarianceMatrixMath.H
4b8f7b3 
Update treatment of warnings.
@cemitch99 @ax3l
Apply suggestions from code review
6d61630 
Changes to test_transformation.py were not intentional.  These were reversed per code review.

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
ax3l
ax3l approved these changes Oct 10, 2024
View reviewed changes
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

Thank you, that looks great!

@ax3l ax3l enabled auto-merge (squash) October 10, 2024 04:10
@ax3l ax3l merged commit 035ea82 into ECP-WarpX:development Oct 10, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ax3l ax3l ax3l approved these changes

@n01r n01r Awaiting requested review from n01r

@qianglbl qianglbl Awaiting requested review from qianglbl

@WeiqunZhang WeiqunZhang Awaiting requested review from WeiqunZhang

Assignees
No one assigned
Labels
component: diagnostics all types of outputs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cemitch99 @ax3l