The magnetic field of a multipole. More...

#include <BMultipoleField.h>

Inheritance diagram for BMultipoleField:

Collaboration diagram for BMultipoleField:

Classes
struct	Pair

Public Member Functions
	BMultipoleField ()
	Default constructor.

	BMultipoleField (const BMultipoleField &)

virtual	~BMultipoleField ()

BMultipoleField &	operator= (const BMultipoleField &)

virtual BVector	Bfield (const Point3D &P) const
	Get field.

virtual BVector	Bfield (const Point3D &P, double t) const
	Get field.

double	getNormalComponent (int n) const
	Get component.

double	getSkewComponent (int n) const
	Get component.

void	setNormalComponent (int n, double Bn)
	Set component.

void	setSkewComponent (int n, double Bn)
	Set component.

double	normal (int) const
	Get component.

double	skew (int) const
	Get component.

double &	normal (int)
	Get component.

double &	skew (int)
	Get component.

BMultipoleField &	addField (const BMultipoleField &field)
	Add to field.

BMultipoleField &	subtractField (const BMultipoleField &field)
	Subtract from field.

void	scale (double scalar)
	Scale the field.

int	order () const
	Return order.

virtual EVector	Efield (const Point3D &P) const
	Get field.

virtual EVector	Efield (const Point3D &P, double t) const
	Get field.

virtual EBVectors	EBfield (const Point3D &P) const
	Get field.

virtual EBVectors	EBfield (const Point3D &P, double t) const
	Get field.

Static Public Attributes
static const EVector	ZeroEfield
	The constant representing a zero electric field.

static const BVector	ZeroBfield
	The constant representing a zero magnetic field.

static const EBVectors	ZeroEBfield
	The constant representing a zero electromagnetic field.

Private Member Functions
void	reserve (int n)

Private Attributes
Pair *	pairs

int	itsOrder

Detailed Description

The magnetic field of a multipole.

The static components are defined by the equation By + i * Bx = sum (Bn + i * An) (x + i * y) ** (n - 1)

where the index n runs from 0 (dipole) to N-1 (2(N+1)-pole)

Definition at line 16 of file BMultipoleField.h.

Constructor & Destructor Documentation

◆ BMultipoleField() [1/2]

BMultipoleField::BMultipoleField ( )

Default constructor.

Definition at line 81 of file BMultipoleField.cpp.

◆ BMultipoleField() [2/2]

BMultipoleField::BMultipoleField ( const BMultipoleField & rhs )

Definition at line 83 of file BMultipoleField.cpp.

References itsOrder, and pairs.

◆ ~BMultipoleField()

BMultipoleField::~BMultipoleField ( )

virtual

Definition at line 92 of file BMultipoleField.cpp.

References pairs.

Member Function Documentation

◆ addField()

BMultipoleField & BMultipoleField::addField ( const BMultipoleField & field )

Add to field.

Definition at line 149 of file BMultipoleField.cpp.

References itsOrder, pairs, and reserve().

Here is the call graph for this function:

◆ Bfield() [1/2]

BVector BMultipoleField::Bfield ( const Point3D & P ) const

virtual

Get field.

Reimplemented from EMField.

Definition at line 109 of file BMultipoleField.cpp.

References Point3D::getX(), Point3D::getY(), itsOrder, and pairs.

Referenced by Bfield().

Here is the call graph for this function:

◆ Bfield() [2/2]

BVector BMultipoleField::Bfield	(	const Point3D &	P,
		double	t
	)		const

virtual

Get field.

Reimplemented from EMField.

Definition at line 121 of file BMultipoleField.cpp.

References Bfield().

Here is the call graph for this function:

◆ EBfield() [1/2]

EBVectors EMField::EBfield ( const Point3D & P ) const

virtualinherited

Get field.

Definition at line 127 of file EMField.cpp.

References EMField::Bfield(), and EMField::Efield().

Referenced by Component::EBfield(), Component::EBfield(), and EMField::EBfield().

Here is the call graph for this function:

◆ EBfield() [2/2]

EBVectors EMField::EBfield	(	const Point3D &	P,
		double	t
	)		const

virtualinherited

Get field.

Definition at line 129 of file EMField.cpp.

References EMField::EBfield().

Here is the call graph for this function:

◆ Efield() [1/2]

EVector EMField::Efield ( const Point3D & P ) const

virtualinherited

Get field.

Reimplemented in ConstEzField, and OscillatingField< ConstEzField >.

Definition at line 119 of file EMField.cpp.

References EMField::ZeroEfield.

Referenced by EMField::EBfield(), Component::Efield(), Component::Efield(), and EMField::Efield().

◆ Efield() [2/2]

EVector EMField::Efield	(	const Point3D &	P,
		double	t
	)		const

virtualinherited

Get field.

Reimplemented in ConstEzField, and OscillatingField< ConstEzField >.

Definition at line 123 of file EMField.cpp.

References EMField::Efield().

Here is the call graph for this function:

◆ getNormalComponent()

double BMultipoleField::getNormalComponent ( int n ) const

inline

Get component.

Get normal component.

Definition at line 141 of file BMultipoleField.h.

References BMultipoleField::Pair::B, itsOrder, and pairs.

Referenced by BendBase::apply(), BendBase::computeFieldHost(), and BendBase::getB().

◆ getSkewComponent()

double BMultipoleField::getSkewComponent ( int n ) const

inline

Get component.

Get skew component.

Definition at line 152 of file BMultipoleField.h.

References BMultipoleField::Pair::A, itsOrder, and pairs.

Referenced by BendBase::apply(), and BendBase::computeFieldHost().

◆ normal() [1/2]

double & BMultipoleField::normal ( int n )

inline

Get component.

Definition at line 160 of file BMultipoleField.h.

References BMultipoleField::Pair::B, and pairs.

◆ normal() [2/2]

double BMultipoleField::normal ( int n ) const

inline

Get component.

Definition at line 164 of file BMultipoleField.h.

References BMultipoleField::Pair::B, and pairs.

Referenced by BMultipoleField::Pair::Pair().

◆ operator=()

BMultipoleField & BMultipoleField::operator= ( const BMultipoleField & rhs )

Definition at line 94 of file BMultipoleField.cpp.

References itsOrder, and pairs.

◆ order()

int BMultipoleField::order ( ) const

inline

Return order.

Return the order of the multipole field.

Definition at line 136 of file BMultipoleField.h.

References itsOrder.

Referenced by BendBase::apply(), and BendBase::computeFieldHost().

◆ reserve()

void BMultipoleField::reserve ( int n )

private

Definition at line 169 of file BMultipoleField.cpp.

References itsOrder, and pairs.

Referenced by addField(), setNormalComponent(), setSkewComponent(), and subtractField().

◆ scale()

void BMultipoleField::scale ( double scalar )

virtual

Scale the field.

Implements EMField.

Definition at line 163 of file BMultipoleField.cpp.

References itsOrder, and pairs.

Referenced by BMultipoleField::Pair::operator*(), and BMultipoleField::Pair::operator*=().

◆ setNormalComponent()

void BMultipoleField::setNormalComponent	(	int	n,
		double	Bn
	)

Set component.

Definition at line 123 of file BMultipoleField.cpp.

References BMultipoleField::Pair::B, itsOrder, pairs, and reserve().

Referenced by BendBase::setB(), OpalMultipole::update(), OpalQuadrupole::update(), OpalRBend::update(), and OpalSBend::update().

Here is the call graph for this function:

◆ setSkewComponent()

void BMultipoleField::setSkewComponent	(	int	n,
		double	Bn
	)

Set component.

Definition at line 138 of file BMultipoleField.cpp.

References BMultipoleField::Pair::A, itsOrder, pairs, and reserve().

Referenced by OpalMultipole::update(), OpalQuadrupole::update(), OpalRBend::update(), and OpalSBend::update().

Here is the call graph for this function:

◆ skew() [1/2]

double & BMultipoleField::skew ( int n )

inline

Get component.

Definition at line 162 of file BMultipoleField.h.

References BMultipoleField::Pair::A, and pairs.

◆ skew() [2/2]

double BMultipoleField::skew ( int n ) const

inline

Get component.

Definition at line 166 of file BMultipoleField.h.

References BMultipoleField::Pair::A, and pairs.

◆ subtractField()

BMultipoleField & BMultipoleField::subtractField ( const BMultipoleField & field )

Subtract from field.

Definition at line 156 of file BMultipoleField.cpp.

References itsOrder, pairs, and reserve().

Here is the call graph for this function:

Member Data Documentation

◆ itsOrder

int BMultipoleField::itsOrder

private

Definition at line 127 of file BMultipoleField.h.

Referenced by addField(), Bfield(), BMultipoleField(), getNormalComponent(), getSkewComponent(), operator=(), order(), reserve(), scale(), setNormalComponent(), setSkewComponent(), and subtractField().

◆ pairs

Pair* BMultipoleField::pairs

private

Definition at line 123 of file BMultipoleField.h.

Referenced by addField(), Bfield(), BMultipoleField(), getNormalComponent(), getSkewComponent(), normal(), normal(), operator=(), reserve(), scale(), setNormalComponent(), setSkewComponent(), skew(), skew(), subtractField(), and ~BMultipoleField().

◆ ZeroBfield

const BVector EMField::ZeroBfield

staticinherited

The constant representing a zero magnetic field.

Definition at line 220 of file EMField.h.

Referenced by EMField::Bfield().

◆ ZeroEBfield

const EBVectors EMField::ZeroEBfield

staticinherited

The constant representing a zero electromagnetic field.

Definition at line 223 of file EMField.h.

◆ ZeroEfield

const EVector EMField::ZeroEfield

staticinherited

The constant representing a zero electric field.

Definition at line 217 of file EMField.h.

Referenced by EMField::Efield().

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

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BMultipoleField() [1/2]

◆ BMultipoleField() [2/2]

◆ ~BMultipoleField()

Member Function Documentation

◆ addField()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ getNormalComponent()

◆ getSkewComponent()

◆ normal() [1/2]

◆ normal() [2/2]

◆ operator=()

◆ order()

◆ reserve()

◆ scale()

◆ setNormalComponent()

◆ setSkewComponent()

◆ skew() [1/2]

◆ skew() [2/2]

◆ subtractField()

Member Data Documentation

◆ itsOrder

◆ pairs

◆ ZeroBfield

◆ ZeroEBfield

◆ ZeroEfield