Elements¶

Accelerator elements, including methods for their manipulation and conversion to the representation expected by Dynac.

class Pynac.Elements.AccFieldFromFile(filename, scaleFactor)[source]¶

Bases: Pynac.Elements.PynacElement

dynacRepresentation()[source]¶: Return the Pynac representation of this AccFieldFromFile instance.

classmethod from_dynacRepr(pynacRepr)[source]¶

class Pynac.Elements.AccGap(L, TTF, TTFprime, TTFprimeprime, EField, phase, F, atten)[source]¶

Bases: Pynac.Elements.PynacElement

A Pynac representation of an accelerating gap.

Before the simulation is run, any changes made to elements using this class have to be put back into the lattice attribute of Pynac using the dynacRepresentation method.

dynacRepresentation()[source]¶: Return the Dynac representation of this accelerating gap instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a AccGap instance from the Pynac lattice element

class Pynac.Elements.Buncher(voltage, phase, harmonicNum, apertureRadius)[source]¶

Bases: Pynac.Elements.PynacElement

dynacRepresentation()[source]¶: Return the Pynac representation of this Set4DAperture instance.

classmethod from_dynacRepr(pynacRepr)[source]¶

class Pynac.Elements.CavityAnalytic(phase, fieldReduction, cavID=0, xesln=0, isec=0)[source]¶

Bases: Pynac.Elements.PynacElement

A Pynac representation of a resonant EM cavity (i.e., the CAVMC model used by Dynac to do analytic calculations).

Before the simulation is run, any changes made to elements using this class have to be put back into the lattice attribute of Pynac using the dynacRepresentation method.

adjustPhase(adjustment)[source]¶: Adjust the accelerating phase of the cavity by the value of adjustment. The adjustment is additive, so a value of scalingFactor = 0.0 will result in no change of the phase.

dynacRepresentation()[source]¶: Return the Dynac representation of this cavity instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a CavityAnalytic instance from the Pynac lattice element

scaleField(scalingFactor)[source]¶: Adjust the accelerating field of the cavity by the value of scalingFactor. The adjustment is multiplicative, so a value of scalingFactor = 1.0 will result in no change of the field.

class Pynac.Elements.Drift(L)[source]¶

Bases: Pynac.Elements.PynacElement

A Pynac representation of a drift.

Before the simulation is run, any changes made to elements using this class have to be put back into the lattice attribute of Pynac using the dynacRepresentation method.

dynacRepresentation()[source]¶: Return the Dynac representation of this drift instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a Drift instance from the Pynac lattice element

class Pynac.Elements.PynacElement[source]¶

Bases: object

classmethod dynacRepresentation()[source]¶

classmethod from_dynacRepr(pynacRepr)[source]¶

class Pynac.Elements.Quad(L, B, aperRadius)[source]¶

Bases: Pynac.Elements.PynacElement

A Pynac representation of a quadrupole magnet.

Before the simulation is run, any changes made to elements using this class have to be put back into the lattice attribute of Pynac using the dynacRepresentation method.

dynacRepresentation()[source]¶: Return the Pynac representation of this quadrupole instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a Quad instance from the Pynac lattice element

scaleField(scalingFactor)[source]¶: Adjust the field of the magnet by the value of scalingFactor. The adjustment is multiplicative, so a value of scalingFactor = 1.0 will result in no change of the field.

setField(new_value)[source]¶: Adjust the field of the magnet by the value of scalingFactor. The adjustment is multiplicative, so a value of scalingFactor = 1.0 will result in no change of the field.

class Pynac.Elements.Set4DAperture(energy, phase, x, y, radius, energyDefnFlag=0)[source]¶

Bases: Pynac.Elements.PynacElement

dynacRepresentation()[source]¶: Return the Pynac representation of this Set4DAperture instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a Set4DAperture instance from the Pynac lattice element

class Pynac.Elements.Steerer(field_strength, plane)[source]¶

Bases: Pynac.Elements.PynacElement

dynacRepresentation()[source]¶: Return the Dynac representation of this steerer instance.

classmethod from_dynacRepr(pynacRepr)[source]¶: Construct a Steerer instance from the Pynac lattice element

scaleField(scalingFactor)[source]¶: Adjust the field of the magnet by the value of scalingFactor. The adjustment is multiplicative, so a value of scalingFactor = 1.0 will result in no change of the field.

setField(new_value)[source]¶: Adjust the field of the magnet by the value of scalingFactor. The adjustment is multiplicative, so a value of scalingFactor = 1.0 will result in no change of the field.