Class MagnetFieldSourceGrid3D#

Defined in File MagnetFieldSourceGrid3D.hh

Inheritance Relationships#

Base Type#

public OrbitUtils::ShiftedFieldSource (Class ShiftedFieldSource)

Class Documentation#

class MagnetFieldSourceGrid3D : public OrbitUtils::ShiftedFieldSource #

A class implements of BaseFiledSource class with magnetic fields in Grid3D.

Public Functions

MagnetFieldSourceGrid3D(Grid3D *BxGrid, Grid3D *ByGrid, Grid3D *BzGrid)#: Constructor.

~MagnetFieldSourceGrid3D()#: Destructor

Grid3D *getBxGrid()#: Returns pointer to Grid3D object with Bx field map

Grid3D *getByGrid()#: Returns pointer to Grid3D object with By field map

Grid3D *getBzGrid()#: Returns pointer to Grid3D object with Bz field map

void setSymmetry(int symmetry_x, int symmetry_y, int symmetry_z)#: Sets symmetry properties in Grid3D fields along x,y,z axises

void getSymmetry(int &symmetry_x, int &symmetry_y, int &symmetry_z)#: Returns symmetry properties in Grid3D fields along x,y,z axises

void setFieldSignsForQuadrants(int signX, int signY, int signZ, int signBx, int signBy, int signBz)#: Sets signs for fields in different quadrants that defined by signs of signX, signY, signZ

void getFieldSignsForQuadrants(int signX, int signY, int signZ, int &signBx, int &signBy, int &signBz)#

Returnss signs for fields in different quadrants that defined by signs of signX, signY, signZ

Returns signs for fields in different quadrants that defined by signs of signX, signY, signZ

void setFieldCoeff(double field_coeff)#: Sets the scaling coefficient for inner fields in Grid3D instances

double getFieldCoeff()#: Returns the scaling coefficient for inner fields in Grid3D instances

virtual void getInnerElectricMagneticField(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 inner components of the electric and magnetic filds.