#include <CorrectorRep.h>

Inheritance diagram for CorrectorRep:

[legend]

Collaboration diagram for CorrectorRep:

[legend]

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

	CorrectorRep ()

	CorrectorRep (const CorrectorRep &right)

virtual	~CorrectorRep ()

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

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

virtual StraightGeometry &	getGeometry ()
	Get geometry. More...

virtual const StraightGeometry &	getGeometry () const
	Get geometry. More...

virtual Plane	getPlane () const
	Get plane(s) of action. More...

virtual double	getBx () const
	Get horizontal field component in Teslas. More...

virtual double	getBy () const
	Get vertical field component in Teslas. More...

virtual BDipoleField &	getField ()
	Get corrector field. More...

virtual const BDipoleField &	getField () const
	Get corrector field. Version for const corrector. More...

virtual void	setBx (double)
	Set horizontal field component in Teslas. More...

virtual void	setBy (double)
	Set vertical field component in Teslas. More...

virtual void	setActive (bool flag=true)
	Set active flag. More...

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

	Corrector ()

	Corrector (const Corrector &right)

virtual	~Corrector ()

virtual void	accept (BeamlineVisitor &) const
	Apply a visitor to Corrector. More...

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 void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)

virtual void	goOnline (const double &kineticEnergy)

virtual void	finalise ()

virtual bool	bends () const

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

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

void	setKickX (double k)

void	setKickY (double k)

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

double	getKickX () const

double	getKickY () const

void	setKickField (const Vector_t &k0)

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	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)

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

virtual double	getDesignEnergy () const

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 const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. 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

virtual bool	isInside (const Vector_t &r) 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...

Protected Attributes
StraightGeometry	geometry
	The corrector geometry. More...

BDipoleField	field
	The corrector strengths. More...

bool	active
	The active/inactive flag. More...

Protected Attributes inherited from Corrector
Plane	plane_m

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

Private Member Functions
void	operator= (const CorrectorRep &)

Additional Inherited Members
Public Types inherited from Corrector
enum	Plane { OFF , X , Y , XY }
	Plane selection. More...

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 Corrector
void	operator= (const Corrector &)

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)

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

Detailed Description

Definition at line 26 of file CorrectorRep.h.

Constructor & Destructor Documentation

◆ CorrectorRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 64 of file CorrectorRep.cpp.

◆ CorrectorRep() [2/3]

CorrectorRep::CorrectorRep ( )

Definition at line 54 of file CorrectorRep.cpp.

Referenced by clone().

◆ CorrectorRep() [3/3]

CorrectorRep::CorrectorRep ( const CorrectorRep & right )

Definition at line 59 of file CorrectorRep.cpp.

◆ ~CorrectorRep()

CorrectorRep::~CorrectorRep ( )

virtual

Definition at line 69 of file CorrectorRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * CorrectorRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Reimplemented in YCorrectorRep, and XCorrectorRep.

Definition at line 73 of file CorrectorRep.cpp.

References CorrectorRep().

Here is the call graph for this function:

◆ getBx()

double CorrectorRep::getBx ( ) const

virtual

Get horizontal field component in Teslas.

Reimplemented in XCorrectorRep.

Definition at line 104 of file CorrectorRep.cpp.

References field, and BDipoleField::getBx().

Here is the call graph for this function:

◆ getBy()

double CorrectorRep::getBy ( ) const

virtual

Get vertical field component in Teslas.

Reimplemented in YCorrectorRep.

Definition at line 109 of file CorrectorRep.cpp.

References field, and BDipoleField::getBy().

Here is the call graph for this function:

◆ getChannel()

Channel * CorrectorRep::getChannel	(	const std::string &	aKey,
		bool	create = `false`
	)

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Reimplemented in YCorrectorRep, and XCorrectorRep.

Definition at line 78 of file CorrectorRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getField() [1/2]

BDipoleField & CorrectorRep::getField ( )

virtual

Get corrector field.

Implements Corrector.

Definition at line 114 of file CorrectorRep.cpp.

References field.

◆ getField() [2/2]

const BDipoleField & CorrectorRep::getField ( ) const

virtual

Get corrector field. Version for const corrector.

Implements Corrector.

Definition at line 119 of file CorrectorRep.cpp.

References field.

◆ getGeometry() [1/2]

StraightGeometry & CorrectorRep::getGeometry ( )

virtual

Get geometry.

Implements Corrector.

Definition at line 89 of file CorrectorRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & CorrectorRep::getGeometry ( ) const

virtual

Get geometry.

Implements Corrector.

Definition at line 94 of file CorrectorRep.cpp.

References geometry.

◆ getPlane()

Corrector::Plane CorrectorRep::getPlane ( ) const

virtual

Get plane(s) of action.

Implements Corrector.

Reimplemented in YCorrectorRep, and XCorrectorRep.

Definition at line 99 of file CorrectorRep.cpp.

References active, Corrector::OFF, and Corrector::XY.

◆ operator=()

void CorrectorRep::operator= ( const CorrectorRep & )

private

◆ setActive()

void CorrectorRep::setActive ( bool flag = true )

virtual

Set active flag.

Definition at line 133 of file CorrectorRep.cpp.

References active.

◆ setBx()

void CorrectorRep::setBx ( double Bx )

virtual

Set horizontal field component in Teslas.

Reimplemented in XCorrectorRep.

Definition at line 124 of file CorrectorRep.cpp.

References field, and BDipoleField::setBx().

Referenced by OpalKicker::update(), and OpalVKicker::update().

Here is the call graph for this function:

◆ setBy()

void CorrectorRep::setBy ( double By )

virtual

Set vertical field component in Teslas.

Reimplemented in YCorrectorRep.

Definition at line 129 of file CorrectorRep.cpp.

References field, and BDipoleField::setBy().

Referenced by OpalHKicker::update(), and OpalKicker::update().

Here is the call graph for this function:

Member Data Documentation

◆ active

bool CorrectorRep::active

protected

The active/inactive flag.

Definition at line 92 of file CorrectorRep.h.

Referenced by getPlane(), XCorrectorRep::getPlane(), and setActive().

◆ field

BDipoleField CorrectorRep::field

protected

The corrector strengths.

Definition at line 89 of file CorrectorRep.h.

Referenced by getBx(), getBy(), getField(), setBx(), and setBy().

◆ geometry

StraightGeometry CorrectorRep::geometry

protected

The corrector geometry.

Definition at line 86 of file CorrectorRep.h.

Referenced by getGeometry().

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

/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/CorrectorRep.h
/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/CorrectorRep.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CorrectorRep() [1/3]

◆ CorrectorRep() [2/3]

◆ CorrectorRep() [3/3]

◆ ~CorrectorRep()

Member Function Documentation

◆ clone()

◆ getBx()

◆ getBy()

◆ getChannel()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getPlane()

◆ operator=()

◆ setActive()

◆ setBx()

◆ setBy()

Member Data Documentation

◆ active

◆ field

◆ geometry