Class BaseFieldSource#

Defined in File BaseFieldSource.hh

Inheritance Relationships#

Base Type#

public OrbitUtils::CppPyWrapper (Class CppPyWrapper)

Derived Types#

public OrbitUtils::FieldSourceContainer (Class FieldSourceContainer)
public OrbitUtils::PyBaseFieldSource (Class PyBaseFieldSource)
public OrbitUtils::ShiftedFieldSource (Class ShiftedFieldSource)
public SuperFishFieldSource (Class SuperFishFieldSource)

Class Documentation#

class BaseFieldSource : public OrbitUtils::CppPyWrapper #

The base class for electro-magnetic field source. It should be sub-classed. The units for E and B are unknown at this point. They should be defined in subclasses.

Subclassed by OrbitUtils::FieldSourceContainer, OrbitUtils::PyBaseFieldSource, OrbitUtils::ShiftedFieldSource, SuperFishFieldSource

Public Functions

BaseFieldSource()#: Constructor. It does nothing.

virtual ~BaseFieldSource()#: Destructor. It does nothing.

virtual void getElectricMagneticField(double x, double y, double z, double t, double &E_x, double &E_y, double &E_z, double &H_x, double &H_y, double &H_z)#: Returns components of the electric and magnetic filds.