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

Apply transverse aperture to thick elements. #788

Merged
merged 33 commits into from
Jan 16, 2025

Conversation

cemitch99
Copy link
Member

@cemitch99 cemitch99 commented Jan 8, 2025

Adds the comparison of particles against the transverse aperture within thick elements, at the end of each space charge slice. This will close #763 .

Note: Need to verify that using the same name Aperture for the thin aperture element and for the mixin class will not cause conflicts. Otherwise, one of these should be renamed.

  • add mixin class
  • add application to a drift (as a template)
  • address particle id
  • add a benchmark example
  • add element documentation
  • add Python support
  • add application to other elements
  • update "thin" Aperture element to use consistent naming
  • Inputs: make aperture constructor non-breaking with warnings
  • Python: Aperture constructor is now breaking, please rename xmax argument to aperture_x and likewise for y
  • add example documentation

@cemitch99 cemitch99 added this to the Advanced Methods (SciDAC-5) milestone Jan 9, 2025
@cemitch99 cemitch99 added the component: elements Elements/external fields label Jan 9, 2025
@ax3l ax3l self-requested a review January 9, 2025 00:21
src/particles/elements/Drift.H Outdated Show resolved Hide resolved
@cemitch99
Copy link
Member Author

Note: Windows test fail now, but all tests were previously passing.

examples/aperture/input_aperture_thick.in Outdated Show resolved Hide resolved
examples/aperture/run_aperture_thick.py Outdated Show resolved Hide resolved
src/particles/elements/mixin/aperture.H Outdated Show resolved Hide resolved
src/particles/elements/mixin/aperture.H Outdated Show resolved Hide resolved
src/particles/elements/mixin/aperture.H Outdated Show resolved Hide resolved
src/particles/elements/Drift.H Outdated Show resolved Hide resolved
src/particles/elements/mixin/aperture.H Outdated Show resolved Hide resolved
src/python/elements.cpp Outdated Show resolved Hide resolved
src/python/elements.cpp Outdated Show resolved Hide resolved
cemitch99 and others added 4 commits January 9, 2025 17:08
src/python/elements.cpp Outdated Show resolved Hide resolved
src/python/elements.cpp Outdated Show resolved Hide resolved
@cemitch99
Copy link
Member Author

cemitch99 commented Jan 14, 2025

Problems on Windows after merging in 'development'...
Appears to have resolved.

@ax3l ax3l self-assigned this Jan 14, 2025
docs/source/usage/parameters.rst Show resolved Hide resolved
docs/source/usage/python.rst Show resolved Hide resolved
src/initialization/InitElement.cpp Outdated Show resolved Hide resolved
src/particles/elements/Aperture.H Show resolved Hide resolved
src/particles/elements/mixin/aperture.H Outdated Show resolved Hide resolved
src/python/elements.cpp Outdated Show resolved Hide resolved
src/python/elements.cpp Outdated Show resolved Hide resolved
Comment on lines +350 to +351
py::arg("aperture_x"),
py::arg("aperture_y"),
Copy link
Member

Choose a reason for hiding this comment

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

As above: we could avoid this breaking change for the Aperture element itself.

Copy link
Member

@ax3l ax3l Jan 15, 2025

Choose a reason for hiding this comment

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

The break of API arg name here might be ok, for python people might not use the named arguments yet that much.

Copy link
Member

Choose a reason for hiding this comment

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

I'll keep this as breaking change for the Python API.

ax3l added 4 commits January 14, 2025 18:06
We do not want to create variables from them.
Mirror directory structure and separate from "physical"
elements as we do in Python.
@ax3l ax3l added the changes input scripts / defaults Changes the syntax or meaning of input scripts and/or defaults label Jan 15, 2025
@ax3l ax3l merged commit 7f8d15f into ECP-WarpX:development Jan 16, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes input scripts / defaults Changes the syntax or meaning of input scripts and/or defaults component: elements Elements/external fields
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Apertures for "thick" elements
3 participants