Skip to content

Add zero_phase enum to RFP group. #146

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

Merged
cemitch99 merged 1 commit into from
Jan 12, 2026
Merged

Add zero_phase enum to RFP group. #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions source/parameters/rf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,16 @@ RFP:
multipass_phase: 0 # [unitless] RF Phase added to multipass elements
cavity_type: STANDING_WAVE # [string] Cavity type
n_cell: 1 # [unitles] Number of cavity cells
zero_phase: ACCELERATING # [enum] Sets what phase = 0 means.
```

Whether `voltage` or `gradient` is kept constant with length changes is determined by
the setting of `field_master` ([](#s:non.params)). If `field_master` is `true`, the
`gradient` is kept constant and vice versa.

The `zero_phase` parameter sets what zero `phase` is in reference to. Possible settings are:
```{code} yaml
ACCELERATING # Default. Zero phase is the maximum accelerating phase.
BELOW_TRANSITION # Zero phase is at the stable zero crossing for particles below transition.
ABOVE_TRANSITION # Zero phase is at the stable zero crossing for particles above transition.
```