Merge pull request #89 from bmad-sim/zero_phase

Add zero_phase parameters to RFParams.

Author: mattsignorelli

src/Beamlines.jl

@@ -16,6 +16,7 @@ export AbstractParams,
        MetaParams,
        ApertureAt,
        ApertureShape,
+       PhaseReference,
        RFParams,
        BMultipole,
        DefExpr,

src/keymaps.jl

@@ -78,6 +78,7 @@ const PROPERTIES_MAP = Dict{Symbol,Type{<:AbstractParams}}(
   :voltage => RFParams,
   :phi0 => RFParams,
   :harmon_master => RFParams,
+  :zero_phase => RFParams,
   :traveling_wave => RFParams,
   :is_crabcavity => RFParams,
 

src/rf.jl

@@ -1,8 +1,19 @@
+"""
+    @enumx PhaseReference::UInt8 Accelerating BelowTransition AboveTransition
+
+Sets what zero `phi0` RF phase means
+- `Accelerating`      Zero phase is the maximum accelerating phase.
+- `BelowTransition`   Zero phase is at the stable zero crossing for particles below transition.
+- `AboveTransition`   Zero phase is at the stable zero crossing for particles above transition.
+"""
+@enumx PhaseReference::UInt8 Accelerating BelowTransition AboveTransition
+
 @kwdef mutable struct RFParams{T} <: AbstractParams
     rate::T               = Float32(0.0) # RF frequency in Hz or Harmonic number
     voltage::T            = Float32(0.0) # Voltage in V 
     phi0::T               = Float32(0.0) # Phase at reference energy
     const harmon_master::Bool = false    # false = frequency in Hz, true = harmonic number
+    zero_phase::PhaseReference.T = PhaseReference.Accelerating   # Determines the RF phase at phi0 = 0
     traveling_wave::Bool = false         # Traveling wave or standing wave cavity?
     is_crabcavity::Bool = false          # Is this a crab cavity?
     function RFParams(args...)
@@ -19,6 +30,7 @@ function Base.isapprox(a::RFParams, b::RFParams)
             a.voltage        ≈  b.voltage && 
             a.phi0           ≈  b.phi0 &&
             a.harmon_master  == b.harmon_master &&
+            a.zero_phase     == b.zero_phase &&
             a.traveling_wave == b.traveling_wave &&
             a.is_crabcavity  == b.is_crabcavity
 end
@@ -39,8 +51,9 @@ function deval(a::RFParams{<:DefExpr})
     deval(a.voltage),
     deval(a.phi0),
     deval(a.harmon_master),
+    deval(a.zero_phase),
     deval(a.traveling_wave),
-    deval(a.is_crabcavity)   
+    deval(a.is_crabcavity),
   )
 end
 
@@ -60,7 +73,7 @@ end
 function Base.setproperty!(c::RFParams{T}, key::Symbol, value) where {T}
   if key in (:rate, :voltage, :phi0)
     return setfield!(c, key, T(value))
-  elseif key in (:harmon_master, :traveling_wave, :is_crabcavity)
+  elseif key in (:harmon_master, :zero_phase, :traveling_wave, :is_crabcavity)
     return setfield!(c, key, value)
   elseif key in (:rf_frequency, :harmon)
     if (key == :harmon) == c.harmon_master

test/runtests.jl

@@ -876,6 +876,7 @@ using Test
     @test cav.harmon_master == false && cav.rf_frequency == 352e6
     @test_throws ErrorException cav.harmon
     cav.rf_frequency = 500e6 + 1e3im
+    @test cav.zero_phase == PhaseReference.Accelerating
     @test cav.traveling_wave == false
     @test cav.is_crabcavity == false
     @test eltype(cav.RFParams) == ComplexF64
@@ -895,6 +896,7 @@ using Test
     @test cav.harmon_master == false && cav.rf_frequency == 352e6
     @test_throws ErrorException cav.harmon
     cav.rf_frequency = 500e6 + 1e3im
+    @test cav.zero_phase == PhaseReference.Accelerating
     @test cav.traveling_wave == false
     @test cav.is_crabcavity == false
     @test eltype(cav.RFParams) == ComplexF64
@@ -973,7 +975,7 @@ using Test
     integrated = Beamlines.SA[false, true, true]
     @test Beamlines.deval(ele.BMultipoleParams) ≈ BMultipoleParams(n, s, tilt, order, normalized, integrated)
     @test Beamlines.deval(ele.PatchParams) ≈ PatchParams(bo + 20, bo + 21, bo + 22, bo + 23, bo + 24, bo + 25, bo + 26)
-    @test Beamlines.deval(ele.RFParams) ≈ RFParams(bo + 27, bo + 28, bo + 29, false, false, false)
+    @test Beamlines.deval(ele.RFParams) ≈ RFParams(bo + 27, bo + 28, bo + 29, false, PhaseReference.Accelerating, false, false)
 
     # Species addition
     bl = Beamline([LineElement(), LineElement()]; R_ref=-59.52872449027632, species_ref=Species("electron"))