Interface for general multipole. More...

#include <Multipole.h>

Inheritance diagram for Multipole:

[legend]

Collaboration diagram for Multipole:

[legend]

Public Member Functions
	Multipole (const std::string &name)
	Constructor with given name. More...

	Multipole ()

	Multipole (const Multipole &)

virtual	~Multipole ()

virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Multipole. More...

virtual BMultipoleField &	getField () override=0
	Get multipole field. More...

virtual const BMultipoleField &	getField () const override=0
	Get multipole field. Version for const object. More...

double	getNormalComponent (int n) const
	Get normal component. More...

double	getSkewComponent (int n) const
	Get skew component. More...

void	setNormalComponent (int, double)
	Set normal component. More...

void	setNormalComponent (int, double, double)
	Set normal component. More...

void	setSkewComponent (int, double)
	Set skew component. More...

void	setSkewComponent (int, double, double)
	Set skew component. More...

size_t	getMaxNormalComponentIndex () const

size_t	getMaxSkewComponentIndex () const

void	setNSlices (const std::size_t &nSlices)

std::size_t	getNSlices () const

bool	isFocusing (unsigned int component) const

virtual StraightGeometry &	getGeometry () override=0
	Get geometry. More...

virtual const StraightGeometry &	getGeometry () const override=0
	Get geometry. More...

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override

virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override

virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override

virtual void	finalise () override

virtual bool	bends () const override

virtual ElementBase::ElementType	getType () const override
	Get element type std::string. More...

virtual void	getDimensions (double &zBegin, double &zEnd) const override

virtual bool	isInside (const Vector_t &r) const override

Public Member Functions inherited from Component
	Component (const std::string &name)
	Constructor with given name. More...

	Component ()

	Component (const Component &right)

virtual	~Component ()

EVector	Efield (const Point3D &P) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P) const
	Return the field in a point. More...

EVector	Efield (const Point3D &P, double t) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...

virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)

virtual double	getDesignEnergy () const

virtual void	setDesignEnergy (const double &energy, bool changeable=true)

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

virtual void	setComponentType (std::string)

virtual std::string	getComponentType () const

virtual const ElementBase &	getDesign () const
	Return design element. More...

virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...

virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...

void	setExitFaceSlope (const double &)

Public Member Functions inherited from ElementBase
	ElementBase (const std::string &name)
	Constructor with given name. More...

	ElementBase ()

	ElementBase (const ElementBase &)

virtual	~ElementBase ()

virtual const std::string &	getName () const
	Get element name. More...

virtual void	setName (const std::string &name)
	Set element name. More...

std::string	getTypeString () const

virtual double	getArcLength () const
	Get arc length. More...

virtual double	getElementLength () const
	Get design length. More...

virtual void	setElementLength (double length)
	Set design length. More...

virtual void	getElementDimensions (double &begin, double &end) const

virtual double	getOrigin () const
	Get origin position. More...

virtual double	getEntrance () const
	Get entrance position. More...

virtual double	getExit () const
	Get exit position. More...

virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...

virtual Euclid3D	getTransform (double s) const
	Get transform. More...

virtual Euclid3D	getTotalTransform () const
	Get transform. More...

virtual Euclid3D	getEntranceFrame () const
	Get transform. More...

virtual Euclid3D	getExitFrame () const
	Get transform. More...

virtual Euclid3D	getEntrancePatch () const
	Get patch. More...

virtual Euclid3D	getExitPatch () const
	Get patch. More...

virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...

virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...

virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...

virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...

virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel. More...

virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...

virtual ElementBase *	clone () const =0
	Return clone. More...

virtual ElementBase *	copyStructure ()
	Make a structural copy. More...

bool	isSharable () const
	Test if the element can be shared. More...

virtual void	makeSharable ()
	Set sharable flag. More...

bool	update (const AttributeSet &)
	Update element. More...

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)

virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...

virtual bool	hasBoundaryGeometry () const

virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...

virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

void	setAperture (const ApertureType &type, const std::vector< double > &args)

std::pair< ElementBase::ApertureType, std::vector< double > >	getAperture () const

void	setMisalignment (const CoordinateSystemTrafo &cst)

void	getMisalignment (double &x, double &y, double &s) const

CoordinateSystemTrafo	getMisalignment () const

void	setActionRange (const std::queue< std::pair< double, double > > &range)

void	setCurrentSCoordinate (double s)

void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame. More...

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

void	setOutputFN (std::string fn)
	Set output filename. More...

std::string	getOutputFN () const
	Get output filename. More...

void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...

double	getElementPosition () const

bool	isElementPositionSet () const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Private Member Functions
void	computeField (Vector_t R, Vector_t &E, Vector_t &B)

void	operator= (const Multipole &)

Private Attributes
std::vector< double >	NormalComponents

std::vector< double >	NormalComponentErrors

std::vector< double >	SkewComponents

std::vector< double >	SkewComponentErrors

int	max_SkewComponent_m

int	max_NormalComponent_m

std::size_t	nSlices_m

Additional Inherited Members
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR , ELLIPTICAL , CONIC_RECTANGULAR , CONIC_ELLIPTICAL }

enum	ElementType { BEAMLINE , CCOLLIMATOR , CORRECTOR , CYCLOTRON , DEGRADER , DRIFT , FLEXIBLECOLLIMATOR , MARKER , MONITOR , MPSPLITINTEGRATOR , MULTIPOLE , MULTIPOLET , OFFSET , PROBE , RBEND , RBEND3D , RFCAVITY , RING , SBEND3D , SBEND , SEPTUM , SOLENOID , SOURCE , STRIPPER , TRAVELINGWAVE , UNDULATOR , VACUUM , VARIABLERFCAVITY , ANY }

Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r) const

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from Component
double	exit_face_slope_m

PartBunchBase< double, 3 > *	RefPartBunch_m

bool	online_m

Protected Attributes inherited from ElementBase
bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

std::pair< ApertureType, std::vector< double > >	aperture_m

double	elementEdge_m

double	rotationZAxis_m

Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Interface for general multipole.

Definition at line 47 of file Multipole.h.

Constructor & Destructor Documentation

◆ Multipole() [1/3]

Multipole::Multipole ( const std::string & name )

explicit

Constructor with given name.

Definition at line 64 of file Multipole.cpp.

◆ Multipole() [2/3]

Multipole::Multipole ( )

Definition at line 47 of file Multipole.cpp.

◆ Multipole() [3/3]

Multipole::Multipole ( const Multipole & right )

Definition at line 52 of file Multipole.cpp.

◆ ~Multipole()

Multipole::~Multipole ( )

virtual

Definition at line 76 of file Multipole.cpp.

Member Function Documentation

◆ accept()

void Multipole::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to Multipole.

Implements ElementBase.

Definition at line 80 of file Multipole.cpp.

References BeamlineVisitor::visitMultipole().

Here is the call graph for this function:

◆ apply() [1/2]

bool Multipole::apply	(	const size_t &	i,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B
	)

overridevirtual

Reimplemented from Component.

Definition at line 274 of file Multipole.cpp.

References computeField(), ElementBase::getElementLength(), ElementBase::isInsideTransverse(), PartBunchBase< T, Dim >::R, Attrib::Distribution::R, and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ apply() [2/2]

bool Multipole::apply	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B
	)

overridevirtual

Reimplemented from Component.

Definition at line 290 of file Multipole.cpp.

References computeField(), ElementBase::getElementLength(), ElementBase::isInsideTransverse(), and Attrib::Distribution::R.

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool Multipole::applyToReferenceParticle	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B
	)

overridevirtual

Reimplemented from Component.

Definition at line 299 of file Multipole.cpp.

References computeField(), ElementBase::getElementLength(), ElementBase::isInsideTransverse(), max_NormalComponent_m, max_SkewComponent_m, NormalComponentErrors, NormalComponents, Attrib::Distribution::R, SkewComponentErrors, and SkewComponents.

Here is the call graph for this function:

◆ bends()

bool Multipole::bends ( ) const

overridevirtual

Implements Component.

Definition at line 333 of file Multipole.cpp.

◆ computeField()

void Multipole::computeField	(	Vector_t	R,
		Vector_t &	E,
		Vector_t &	B
	)

private

Definition at line 151 of file Multipole.cpp.

References DECAPOLE, DIPOLE, max_NormalComponent_m, max_SkewComponent_m, NormalComponents, OCTUPOLE, QUADRUPOLE, Attrib::Distribution::R, SEXTUPOLE, and SkewComponents.

Referenced by apply(), and applyToReferenceParticle().

◆ finalise()

void Multipole::finalise ( )

overridevirtual

Implements Component.

Definition at line 329 of file Multipole.cpp.

References Component::online_m.

◆ getDimensions()

void Multipole::getDimensions	(	double &	zBegin,
		double &	zEnd
	)		const

overridevirtual

Implements Component.

Definition at line 338 of file Multipole.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

◆ getField() [1/2]

virtual const BMultipoleField& Multipole::getField ( ) const

overridepure virtual

Get multipole field. Version for const object.

Implements Component.

Implemented in SingleMultipole< order >, and MultipoleRep.

◆ getField() [2/2]

virtual BMultipoleField& Multipole::getField ( )

overridepure virtual

Get multipole field.

Implements Component.

Implemented in SingleMultipole< order >, and MultipoleRep.

Referenced by ThickTracker::visitMultipole().

◆ getGeometry() [1/2]

virtual const StraightGeometry& Multipole::getGeometry ( ) const

overridepure virtual

Get geometry.

Implements ElementBase.

Implemented in SingleMultipole< order >, and MultipoleRep.

◆ getGeometry() [2/2]

virtual StraightGeometry& Multipole::getGeometry ( )

overridepure virtual

Get geometry.

Implements ElementBase.

Implemented in SingleMultipole< order >, and MultipoleRep.

◆ getMaxNormalComponentIndex()

size_t Multipole::getMaxNormalComponentIndex ( ) const

inline

Definition at line 157 of file Multipole.h.

References NormalComponents.

◆ getMaxSkewComponentIndex()

size_t Multipole::getMaxSkewComponentIndex ( ) const

inline

Definition at line 162 of file Multipole.h.

References SkewComponents.

◆ getNormalComponent()

double Multipole::getNormalComponent ( int n ) const

Get normal component.

Definition at line 85 of file Multipole.cpp.

References max_NormalComponent_m, Hypervolume::n, and NormalComponents.

Referenced by MultipoleRep::getChannel().

◆ getNSlices()

std::size_t Multipole::getNSlices ( ) const

Definition at line 147 of file Multipole.cpp.

References nSlices_m.

Referenced by ThickTracker::visitMultipole().

◆ getSkewComponent()

double Multipole::getSkewComponent ( int n ) const

Get skew component.

Definition at line 93 of file Multipole.cpp.

References max_SkewComponent_m, Hypervolume::n, and SkewComponents.

Referenced by MultipoleRep::getChannel().

◆ getType()

ElementBase::ElementType Multipole::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 344 of file Multipole.cpp.

References ElementBase::MULTIPOLE.

◆ initialise()

void Multipole::initialise	(	PartBunchBase< double, 3 > *	bunch,
		double &	startField,
		double &	endField
	)

overridevirtual

Implements Component.

Definition at line 322 of file Multipole.cpp.

References ElementBase::getElementLength(), Component::online_m, and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ isFocusing()

bool Multipole::isFocusing ( unsigned int component ) const

Definition at line 357 of file Multipole.cpp.

References PartBunchBase< T, Dim >::getChargePerParticle(), NormalComponents, pow(), and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ isInside()

bool Multipole::isInside ( const Vector_t & r ) const

overridevirtual

Reimplemented from ElementBase.

Definition at line 349 of file Multipole.cpp.

References ElementBase::getElementLength(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

◆ operator=()

void Multipole::operator= ( const Multipole & )

private

◆ setNormalComponent() [1/2]

void Multipole::setNormalComponent	(	int	n,
		double	v
	)

inline

Set normal component.

Definition at line 147 of file Multipole.h.

References Hypervolume::n.

Referenced by MultipoleRep::getChannel(), OpalMultipole::update(), OpalOctupole::update(), OpalQuadrupole::update(), and OpalSextupole::update().

◆ setNormalComponent() [2/2]

void Multipole::setNormalComponent	(	int	n,
		double	v,
		double	vError
	)

Set normal component.

Definition at line 101 of file Multipole.cpp.

References DIPOLE, max_NormalComponent_m, Hypervolume::n, NormalComponentErrors, NormalComponents, and PAssert_GE.

◆ setNSlices()

void Multipole::setNSlices ( const std::size_t & nSlices )

Definition at line 142 of file Multipole.cpp.

References nSlices_m.

Referenced by OpalQuadrupole::update().

◆ setSkewComponent() [1/2]

void Multipole::setSkewComponent	(	int	n,
		double	v
	)

inline

Set skew component.

Definition at line 152 of file Multipole.h.

References Hypervolume::n.

Referenced by MultipoleRep::getChannel(), OpalMultipole::update(), OpalOctupole::update(), OpalQuadrupole::update(), and OpalSextupole::update().

◆ setSkewComponent() [2/2]

void Multipole::setSkewComponent	(	int	n,
		double	v,
		double	vError
	)

Set skew component.

Definition at line 121 of file Multipole.cpp.

References DIPOLE, max_SkewComponent_m, Hypervolume::n, PAssert_GT, SkewComponentErrors, and SkewComponents.

Member Data Documentation

◆ max_NormalComponent_m

int Multipole::max_NormalComponent_m

private

Definition at line 142 of file Multipole.h.

Referenced by applyToReferenceParticle(), computeField(), getNormalComponent(), and setNormalComponent().

◆ max_SkewComponent_m

int Multipole::max_SkewComponent_m

private

Definition at line 141 of file Multipole.h.

Referenced by applyToReferenceParticle(), computeField(), getSkewComponent(), and setSkewComponent().

◆ NormalComponentErrors

std::vector<double> Multipole::NormalComponentErrors

private

Definition at line 138 of file Multipole.h.

Referenced by applyToReferenceParticle(), and setNormalComponent().

◆ NormalComponents

std::vector<double> Multipole::NormalComponents

private

Definition at line 137 of file Multipole.h.

Referenced by applyToReferenceParticle(), computeField(), getMaxNormalComponentIndex(), getNormalComponent(), isFocusing(), and setNormalComponent().

◆ nSlices_m

std::size_t Multipole::nSlices_m

private

Definition at line 143 of file Multipole.h.

Referenced by getNSlices(), and setNSlices().

◆ SkewComponentErrors

std::vector<double> Multipole::SkewComponentErrors

private

Definition at line 140 of file Multipole.h.

Referenced by applyToReferenceParticle(), and setSkewComponent().

◆ SkewComponents

std::vector<double> Multipole::SkewComponents

private

Definition at line 139 of file Multipole.h.

Referenced by applyToReferenceParticle(), computeField(), getMaxSkewComponentIndex(), getSkewComponent(), and setSkewComponent().

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

/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/Multipole.h
/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/Multipole.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Multipole() [1/3]

◆ Multipole() [2/3]

◆ Multipole() [3/3]

◆ ~Multipole()

Member Function Documentation

◆ accept()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ computeField()

◆ finalise()

◆ getDimensions()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getMaxNormalComponentIndex()

◆ getMaxSkewComponentIndex()

◆ getNormalComponent()

◆ getNSlices()

◆ getSkewComponent()

◆ getType()

◆ initialise()

◆ isFocusing()

◆ isInside()

◆ operator=()

◆ setNormalComponent() [1/2]

◆ setNormalComponent() [2/2]

◆ setNSlices()

◆ setSkewComponent() [1/2]

◆ setSkewComponent() [2/2]

Member Data Documentation

◆ max_NormalComponent_m

◆ max_SkewComponent_m

◆ NormalComponentErrors

◆ NormalComponents

◆ nSlices_m

◆ SkewComponentErrors

◆ SkewComponents