at.collective.wake_elements#

Classes

`LongResonatorElement`(family_name, ring, ...)	Class to generate a longitudinal resonator, inherits from WakeElement additional argument are frequency, qfactor, rshunt
`ResWallElement`(family_name, ring, srange, ...)	Class to generate a resistive wall element, inherits from WakeElement additional argument are yokoya_factor, length, pipe radius, conductivity
`ResonatorElement`(family_name, ring, srange, ...)	Class to generate a resonator, inherits from WakeElement additonal argument are frequency, qfactor, rshunt
`WakeElement`(family_name, ring, wake, **kwargs)	Class to generate an AT wake element using the passmethod WakeFieldPass

class LongResonatorElement(family_name, ring, srange, frequency, qfactor, rshunt, **kwargs)[source]#

Bases: ResonatorElement

Class to generate a longitudinal resonator, inherits from WakeElement additional argument are frequency, qfactor, rshunt

Parameters:

name (family) – Element name
ring (Lattice) – Lattice in which the element will be inserted
srange – Vector of s position where to sample the wake
frequency (float) – Resonator frequency [Hz]
qfactor (float) – Q factor
rshunt (float) – Shunt impedance, [\(\Omega\)] for longitudinal, [\(\Omega/m\)] for transverse

Keyword Arguments:

yokoya_factor – Yokoya factor
Nslice (int) – Number of slices per bunch. Default: 101
Nturns (int) – Number of turn for the wake field. Default: 1
ZCuts – Limits for fixed slicing, default is adaptive
NormFact (Tuple[float,...]) – Normalization for the 3 planes, to account for beta function at the observation point for example. Default: (1,1,1)

class ResWallElement(family_name, ring, srange, wakecomp, rwlength, rvac, conduc, yokoya_factor=1, **kwargs)[source]#

Bases: WakeElement

Class to generate a resistive wall element, inherits from WakeElement additional argument are yokoya_factor, length, pipe radius, conductivity

Parameters:

name (family) – Element name
ring (Lattice) – Lattice in which the element will be inserted
srange – Vector of s position where to sample the wake
wakecomp (WakeComponent) – Wake component
rwlength (float)
rvac (float)
conduc (float)
yokoya_factor – Yokoya factor

Keyword Arguments:

Nslice (int) – Number of slices per bunch. Default: 101
Nturns (int) – Number of turn for the wake field. Default: 1
ZCuts – Limits for fixed slicing, default is adaptive
NormFact (Tuple[float,...]) – Normalization for the 3 planes, to account for beta function at the observation point for example. Default: (1,1,1)

rebuild_wake()[source]#

property Conductivity#: Conductivity of the beam pipe [S/m]

property RWLength#: Length of the resistive wall

property Rvac#: Radius of the beam pipe [m]

property Yokoya#: Yokoya factor for the reistive wall

class ResonatorElement(family_name, ring, srange, wakecomp, frequency, qfactor, rshunt, yokoya_factor=1, **kwargs)[source]#

Bases: WakeElement

Class to generate a resonator, inherits from WakeElement additonal argument are frequency, qfactor, rshunt

Parameters:

name (family) – Element name
ring (Lattice) – Lattice in which the element will be inserted
srange – Vector of s position where to sample the wake
wakecomp (WakeComponent) – Wake component
frequency (float) – Resonator frequency [Hz]
qfactor (float) – Q factor
rshunt (float) – Shunt impedance, [\(\Omega\)] for longitudinal, [\(\Omega/m\)] for transverse
yokoya_factor – Yokoya factor

Keyword Arguments:

Nslice (int) – Number of slices per bunch. Default: 101
Nturns (int) – Number of turn for the wake field. Default: 1
ZCuts – Limits for fixed slicing, default is adaptive
NormFact (Tuple[float,...]) – Normalization for the 3 planes, to account for beta function at the observation point for example. Default: (1,1,1)

rebuild_wake()[source]#

property Qfactor#: Resonator Q factor

property ResFrequency#: Resonator frequency [Hz]

property Rshunt#: Resonator shunt impedance, [\(\Omega\)] for longitudinal, [\(\Omega/m\)] for transverse

property Yokoya#: Resonator Yokoya factor

class WakeElement(family_name, ring, wake, **kwargs)[source]#

Bases: Collective, Element

Class to generate an AT wake element using the passmethod WakeFieldPass

Parameters:

name (family) – Element name
ring (Lattice) – Lattice in which the element will be inserted
wake (Wake) – Wake object

Keyword Arguments:

Nslice (int) – Number of slices per bunch. Default: 101
Nturns (int) – Number of turn for the wake field. Default: 1
ZCuts – Limits for fixed slicing, default is adaptive
NormFact (Tuple[float,...]) – Normalization for the 3 planes, to account for beta function at the observation point for example. Default: (1,1,1)

clear_history(ring=None)[source]#

rebuild_wake(wake)[source]#

set_normfactxy(ring)[source]#

property Nslice#: Number of slices per bunch

property Nturns#: Number of turn for the wake field

property TurnHistory#: Turn histroy of the slices center of mass

property WakeDX#: Dipole X component

property WakeDY#: Dipole Y component

property WakeQX#: Quadrupole X component

property WakeQY#: Quadrupole Y component

property WakeT#

property WakeZ#: Longitudinal component

default_pass = {False: 'IdentityPass', True: 'WakeFieldPass'}#