SolenoidTEAPOT#

class orbit.teapot.SolenoidTEAPOT(name='solenoid no name', B=0.0, length=0.0, nparts=1, waveform=None)[source]#

Bases: orbit.teapot.teapot.NodeTEAPOT

Solenoid TEAPOT element.

Methods Summary

setWaveform(waveform)

Sets the time dependent waveform function

track(paramsDict)

The Solenoid TEAPOT class implementation of the AccNodeBunchTracker class track(probe) method.

Methods Documentation

Parameters

  • name (str) –

  • B (float) –

  • length (float) –

  • nparts (int) –

  • waveform (Any) –

Return type

None

setWaveform(waveform)[source]#

Sets the time dependent waveform function

Return type

None

Parameters

waveform (Any) –

track(paramsDict)[source]#

The Solenoid TEAPOT class implementation of the AccNodeBunchTracker class track(probe) method.

Return type

None

Parameters

paramsDict (dict) –