FringeFieldTEAPOT#

class orbit.teapot.FringeFieldTEAPOT(parentNode, trackFunction=None, name='fringe field no name')[source]#

Bases: BaseTEAPOT

The class is a base class for the fringe field classes for others TEAPOT elements.

Methods Summary

getFringeFieldFunction()

Returns the fringe field function.

getUsage()

Returns the boolean flag describing if the fringe field will be used in calculation.

setFringeFieldFunction(trackFunction)

Sets the fringe field function that will track the bunch through the fringe.

setUsage([usage])

Sets the boolean flag describing if the fringe field will be used in calculation.

track(paramsDict)

It is tracking the dictionary with parameters through the fringe field node.

Methods Documentation

Parameters:

  • parentNode (AccNode)

  • trackFunction (Callable)

  • name (str)

getFringeFieldFunction()[source]#

Returns the fringe field function.

Return type:

Callable

getUsage()[source]#

Returns the boolean flag describing if the fringe field will be used in calculation.

Return type:

bool

setFringeFieldFunction(trackFunction)[source]#

Sets the fringe field function that will track the bunch through the fringe.

Return type:

None

Parameters:

trackFunction (Callable)

setUsage(usage=True)[source]#

Sets the boolean flag describing if the fringe field will be used in calculation.

Return type:

None

Parameters:

usage (bool)

track(paramsDict)[source]#

It is tracking the dictionary with parameters through the fringe field node.

Return type:

None

Parameters:

paramsDict (dict)