BSingleMultipoleField< order > Class Template Reference

Representation for a single magnetic multipole field. More...

#include <BSingleMultipoleField.h>

Inheritance diagram for BSingleMultipoleField< order >:

Collaboration diagram for BSingleMultipoleField< order >:

Public Member Functions
	BSingleMultipoleField ()
	Default constructor. More...
	BSingleMultipoleField (const BSingleMultipoleField &)
virtual	~BSingleMultipoleField ()
BSingleMultipoleField &	operator= (const BSingleMultipoleField &)
	operator BMultipoleField () const
	Conversion operator. More...
virtual BVector	Bfield (const Point3D &X) const
	Field at a given point. More...
virtual BVector	Bfield (const Point3D &P, double t) const
	Get field. More...
virtual double	getComponent () const
	Return field coefficient. More...
virtual void	setComponent (double)
	Set field coefficient. More...
void	scale (double scalar)
	Scale the field. More...
int	size () const
	Return order. More...
Public Member Functions inherited from EMField
	EMField ()
	Default constructor. More...
	EMField (const EMField &right)
virtual	~EMField ()
const EMField &	operator= (const EMField &right)
virtual EVector	Efield (const Point3D &P) const
	Get field. More...
virtual EVector	Efield (const Point3D &P, double t) const
	Get field. More...
virtual EBVectors	EBfield (const Point3D &P) const
	Get field. More...
virtual EBVectors	EBfield (const Point3D &P, double t) const
	Get field. More...

Private Attributes
double	strength

Additional Inherited Members
Static Public Attributes inherited from EMField
static const EVector	ZeroEfield
	The constant representing a zero electric field. More...
static const BVector	ZeroBfield
	The constant representing a zero magnetic field. More...
static const EBVectors	ZeroEBfield
	The constant representing a zero electromagnetic field. More...

Detailed Description

template<int order>
class BSingleMultipoleField< order >

Representation for a single magnetic multipole field.

Definition at line 40 of file BSingleMultipoleField.h.

Constructor & Destructor Documentation

template<int order>

BSingleMultipoleField< order >::BSingleMultipoleField ( )

inline

Default constructor.

Definition at line 91 of file BSingleMultipoleField.h.

template<int order>

BSingleMultipoleField< order >::BSingleMultipoleField ( const BSingleMultipoleField< order > &  field )

inline

Definition at line 98 of file BSingleMultipoleField.h.

template<int order>

BSingleMultipoleField< order >::~BSingleMultipoleField ( )

virtual

Definition at line 104 of file BSingleMultipoleField.h.

Member Function Documentation

template<int order>

BVector BSingleMultipoleField< order >::Bfield ( const Point3D &  X ) const

inlinevirtual

Field at a given point.

Reimplemented from EMField.

Definition at line 130 of file BSingleMultipoleField.h.

References Point3D::getX(), Point3D::getY(), imag(), and real().

Here is the call graph for this function:

template<int order>

BVector BSingleMultipoleField< order >::Bfield ( const Point3D &  P, double  t  ) const

inlinevirtual

Get field.

Reimplemented from EMField.

Definition at line 149 of file BSingleMultipoleField.h.

template<int order>

double BSingleMultipoleField< order >::getComponent ( ) const

inlinevirtual

Return field coefficient.

Definition at line 155 of file BSingleMultipoleField.h.

template<int order>

BSingleMultipoleField< order >::operator BMultipoleField ( ) const

inline

Conversion operator.

Definition at line 117 of file BSingleMultipoleField.h.

References BMultipoleField::setNormalComponent(), and BMultipoleField::setSkewComponent().

Here is the call graph for this function:

template<int order>

BSingleMultipoleField< order > & BSingleMultipoleField< order >::operator= ( const BSingleMultipoleField< order > &  field )

inline

Definition at line 110 of file BSingleMultipoleField.h.

References BSingleMultipoleField< order >::strength.

template<int order>

void BSingleMultipoleField< order >::scale ( double  scalar )

inlinevirtual

Scale the field.

Implements EMField.

Definition at line 167 of file BSingleMultipoleField.h.

template<int order>

void BSingleMultipoleField< order >::setComponent ( double  value )

inlinevirtual

Set field coefficient.

Definition at line 161 of file BSingleMultipoleField.h.

template<int order>

int BSingleMultipoleField< order >::size ( ) const

inline

Return order.

Definition at line 173 of file BSingleMultipoleField.h.

References abs().

Here is the call graph for this function:

Member Data Documentation

template<int order>

double BSingleMultipoleField< order >::strength

private

Definition at line 83 of file BSingleMultipoleField.h.

Referenced by BSingleMultipoleField< order >::operator=().

---

The documentation for this class was generated from the following file:

• src/Classic/Fields/BSingleMultipoleField.h