Interface for a single beam element. More...

#include <Component.h>

Inheritance diagram for Component:

Collaboration diagram for Component:

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

	Component ()

	Component (const Component &right)

virtual	~Component ()

virtual EMField &	getField ()=0
	Return field. More...

virtual const EMField &	getField () const =0
	Return field. More...

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 void	addKR (int i, double t, Vector_t &K)

virtual void	addKT (int i, double t, Vector_t &K)

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

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

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

virtual bool	getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi)

virtual double	getDesignEnergy () const

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

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

virtual void	finalise ()=0

virtual bool	bends () const =0

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

virtual void	getDimensions (double &zBegin, double &zEnd) const =0

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

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 BGeometryBase &	getGeometry ()=0
	Get geometry. More...

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

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 ElementImage *	getImage () const
	Construct an image. More...

virtual void	accept (BeamlineVisitor &visitor) const =0
	Apply visitor. 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...

virtual ElementBase *	makeAlignWrapper ()
	Allow misalignment. More...

virtual ElementBase *	makeFieldWrapper ()
	Allow field errors. More...

virtual ElementBase *	makeWrappers ()
	Allow errors. More...

virtual ElementBase *	removeAlignWrapper ()
	Remove align wrapper. More...

virtual const ElementBase *	removeAlignWrapper () const
	Remove align wrapper. More...

virtual ElementBase *	removeFieldWrapper ()
	Remove field wrapper. More...

virtual const ElementBase *	removeFieldWrapper () const
	Remove field wrapper. More...

virtual ElementBase *	removeWrappers ()
	Return the design element. More...

virtual const ElementBase *	removeWrappers () const
	Return the design element. 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

ElemType	getElType () const
	returns element type as enumeration needed in the envelope tracker More...

void	setElType (ElemType elt)
	set the element type as enumeration needed in the envelope tracker More...

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

virtual bool	isInside (const Vector_t &r) const

void	setMisalignment (double x, double y, double s)

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

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...

Protected Attributes
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
static const std::vector< double >	defaultAperture_m

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

enum	ElementType { ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE, BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER, CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER, DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR, LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR, MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET, PARALLELPLATE, PATCH, PROBE, RBEND, RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE, RING, SBEND3D, SBEND, SBENDWRAPPER, SEPARATOR, SEPTUM, SOLENOID, SOURCE, STRIPPER, TRAVELINGWAVE, 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, double f=1) 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)

Detailed Description

Interface for a single beam element.

Definition at line 51 of file Component.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 53 of file Component.cpp.

References defaultAperture_m, ElementBase::ELLIPTICAL, and ElementBase::setAperture().

Here is the call graph for this function:

Component::Component ( )

Definition at line 40 of file Component.cpp.

Component::Component ( const Component & right )

Definition at line 45 of file Component.cpp.

Component::~Component ( )

virtual

Definition at line 63 of file Component.cpp.

Member Function Documentation

virtual void Component::addKR	(	int	i,
		double	t,
		Vector_t &	K
	)

inlinevirtual

Reimplemented in RBend, SBend, Multipole, RFCavity, TravelingWave, Bend2D, RBend3D, Solenoid, and Source.

Definition at line 102 of file Component.h.

virtual void Component::addKT	(	int	i,
		double	t,
		Vector_t &	K
	)

inlinevirtual

Reimplemented in RBend, SBend, Multipole, RFCavity, TravelingWave, RBend3D, Bend2D, Solenoid, and Source.

Definition at line 104 of file Component.h.

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

virtual

Reimplemented in Cyclotron, MultipoleT, MultipoleTBase, Multipole, RFCavity, Ring, VariableRFCavityFringeField, VariableRFCavity, Monitor, TravelingWave, Corrector, Bend2D, SBend3D, BeamStripping, RBend3D, ParallelPlate, Degrader, CyclotronValley, ScalingFFAMagnet, Solenoid, VerticalFFAMagnet, PluginElement, FlexibleCollimator, Source, and SectorFieldMapComponent.

Definition at line 99 of file Component.cpp.

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

Referenced by RingSection::getFieldValue(), DumpEMFields::writeFieldLine(), and DumpFields::writeFieldThis().

Here is the call graph for this function:

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

virtual

Reimplemented in Cyclotron, Multipole, RFCavity, MultipoleT, Ring, MultipoleTBase, VariableRFCavityFringeField, VariableRFCavity, SBend3D, Bend2D, Corrector, TravelingWave, BeamStripping, RBend3D, ParallelPlate, ScalingFFAMagnet, CyclotronValley, Solenoid, VerticalFFAMagnet, and SectorFieldMapComponent.

Definition at line 110 of file Component.cpp.

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

Here is the call graph for this function:

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

virtual

Reimplemented in RFCavity, Multipole, VariableRFCavityFringeField, VariableRFCavity, Bend2D, TravelingWave, Monitor, RBend3D, ParallelPlate, CyclotronValley, Degrader, Solenoid, PluginElement, and FlexibleCollimator.

Definition at line 121 of file Component.cpp.

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

Here is the call graph for this function:

virtual bool Component::bends ( ) const

pure virtual

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

inline

Return the field in a point.

Definition at line 211 of file Component.h.

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

Here is the call graph for this function:

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

inline

Return the field in a point.

Definition at line 217 of file Component.h.

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

Here is the call graph for this function:

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

inline

Return the field in a point.

Definition at line 220 of file Component.h.

References EMField::EBfield(), and getField().

Here is the call graph for this function:

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

inline

Return the field in a point.

Definition at line 223 of file Component.h.

References EMField::EBfield(), and getField().

Here is the call graph for this function:

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

inline

Return the field in a point.

Definition at line 208 of file Component.h.

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

Here is the call graph for this function:

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

inline

Return the field in a point.

Definition at line 214 of file Component.h.

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

Here is the call graph for this function:

virtual void Component::finalise ( )

pure virtual

virtual std::string Component::getComponentType ( ) const

inlinevirtual

Reimplemented in RFCavity.

Definition at line 170 of file Component.h.

const ElementBase & Component::getDesign ( ) const

virtual

Return design element.

Reimplemented in RBendWrapper, SBendWrapper, CyclotronWrapper, CorrectorWrapper, and MultipoleWrapper.

Definition at line 67 of file Component.cpp.

double Component::getDesignEnergy ( ) const

inlinevirtual

Reimplemented in RFCavity, and BendBase.

Definition at line 240 of file Component.h.

virtual void Component::getDimensions	(	double &	zBegin,
		double &	zEnd
	)		const

pure virtual

virtual EMField& Component::getField ( )

pure virtual

Return field.

Implemented in VariableRFCavity, Offset, Ring, ScalingFFAMagnet, SBend3D, VerticalFFAMagnet, RBend, MultipoleT, SBend, MultipoleTBase, BeamBeamRep, CyclotronRep, CorrectorRep, CyclotronWrapper, RBendWrapper, SBendWrapper, CorrectorWrapper, MultipoleWrapper, SingleMultipole< order >, Corrector, Multipole, RBend3D, RBendRep, SBendRep, BeamStrippingRep, PatchRep, CCollimatorRep, CyclotronValleyRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MonitorRep, ParallelPlateRep, RFCavityRep, SeparatorRep, SolenoidRep, SourceRep, TravelingWaveRep, MultipoleRep, ProbeRep, SeptumRep, StripperRep, MarkerRep, and SectorFieldMapComponent.

Referenced by Bfield(), EBfield(), and Efield().

virtual const EMField& Component::getField ( ) const

pure virtual

virtual bool Component::getPotential	(	const Vector_t &	R,
		const double &	t,
		Vector_t &	A,
		double &	phi
	)

inlinevirtual

Calculate the four-potential at some position relative to the component

Parameters

R	position in the local coordinate system of the component
t	time
A	filled with the calculated magnetic vector potential
phi	filled with the calculated electric potential Note that any existing values in A and phi may be overwritten by this method.