fix:replace_spacecharge_with_PIC can now create space charge elements with apply_z_kick set to True#181
Open
MarkusSQ wants to merge 1 commit intoxsuite:mainfrom
Open
fix:replace_spacecharge_with_PIC can now create space charge elements with apply_z_kick set to True#181MarkusSQ wants to merge 1 commit intoxsuite:mainfrom
replace_spacecharge_with_PIC can now create space charge elements with apply_z_kick set to True#181MarkusSQ wants to merge 1 commit intoxsuite:mainfrom
Conversation
szymonlopaciuk
approved these changes
Oct 20, 2025
Contributor
szymonlopaciuk
left a comment
There was a problem hiding this comment.
Thanks for the bug fix with a test! Looks good to me
265c795 to
3956eb0
Compare
…ongitudinal kick for 'FFTSolver3D' Added 'apply_z_kick' parameter to 'replace_spacecharge_with_PIC'. Added logic so that if solver is 'FFTSolver3D' and no 'apply_z_kick' parameter value is specified, 'apply_z_kick' is set to True when creating 'PICCollection'. Previously, PICCollection would always be created with 'apply_z_kick' as False even when using 'FFTSolver3D', and therefore no longitudinal kick would be deposited.
3956eb0 to
78f78e0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
fix:
replace_spacecharge_with_PICnow createsPICCollectionwith longitudinal kick by default forFFTSolver3DAdded
apply_z_kickparameter toreplace_spacecharge_with_PIC. Added logic so that if solver isFFTSolver3Dand noapply_z_kickparameter value is specified when callingreplace_spacecharge_with_PIC,apply_z_kickis set to True when creatingPICCollection.Previously, PICCollection and therefore the line object's
SpaceCharge3Delements would always be created withapply_z_kickasFalsewhen callingreplace_spacecharge_with_PICeven withsolver=FFTSolver3D. In other words, no longitudinal kick would be deposited regardless of specified solver. This change aims to fix that.If the user really wants to use
solver=FFTSolver3Dwithapply_z_kick=Falsethen that is possible by explicitly specifyingapply_z_kick=Falsewhen callingreplace_spacecharge_with_PIC.Checklist
Mandatory:
Optional: