SuperFish_3D_RF_FieldReader#

class orbit.py_linac.rf_field_readers.SuperFish_3D_RF_FieldReader[source]#

Bases: object

This class reads the SuperFish file with the 3D axial symmetric RF field. It uses z and r as variables. The file include Ez, Er, and H. The file will work in parallel environment.

Methods Summary

`getAxisEz`([zSimmetric])	Returns the Spline with Ez(z) on the axis of the RF.
`getDataArray`()	A convinience method.
`getNumberStepsR`()	Returns the number of steps along the radius.
`getNumberStepsZ`()	Returns the number of steps in Z-axis.
`makeGrid2DFileds_EzErH`()	It fills out the Grid2D instances with the electric and magnetic filed components - Ez, Er, H.
`readFile`(file_name)

Methods Documentation

getAxisEz(zSimmetric=- 1)[source]#: Returns the Spline with Ez(z) on the axis of the RF. If zSimmetric > 0 the table has only half of the table, and the Function should be added points for (-Zmax) to (Zmin - step).

getDataArray()[source]#: A convinience method. It returns the raw array with records with tuples [z,r,Ez,Er,E,B]

getNumberStepsR()[source]#: Returns the number of steps along the radius. The number of grid points is self.rSteps+1.

getNumberStepsZ()[source]#: Returns the number of steps in Z-axis. The number of grid points is self.zSteps+1.

makeGrid2DFileds_EzErH()[source]#: It fills out the Grid2D instances with the electric and magnetic filed components - Ez, Er, H. The Ez and Er are in MV in SuperFish file, and H in [A/m]. In the Grid2D Ez and Er will be placed in [V/m].

readFile(file_name)[source]#