Base class for special integrators. More...

#include <Integrator.h>

Inheritance diagram for Integrator:

Collaboration diagram for Integrator:

Public Member Functions
	Integrator (ElementBase *)

	Integrator (const Integrator &rhs)

virtual	~Integrator ()

ElementBase *	getElement () const
	Return the embedded element. More...

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

virtual void	trackParticle (OpalParticle &, const PartData &, bool revBeam, bool revTrack) const =0
	Track a particle. More...

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

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

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

virtual ElementType	getType () const =0
	Get element type std::string. 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 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
Pointer< ElementBase >	itsElement
	Pointer to the replaced element. More...

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
	Integrator ()

void	operator= (const Integrator &)

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

Base class for special integrators.

Definition at line 41 of file Integrator.h.

Constructor & Destructor Documentation

Integrator::Integrator ( ElementBase * elem )

explicit

Definition at line 28 of file Integrator.cpp.

Integrator::Integrator ( const Integrator & rhs )

Definition at line 33 of file Integrator.cpp.

Integrator::~Integrator ( )

virtual

Definition at line 38 of file Integrator.cpp.

Integrator::Integrator ( )

private

Member Function Documentation

ElementBase * Integrator::getElement ( ) const

inline

Return the embedded element.

Definition at line 97 of file Integrator.h.

References itsElement.

Referenced by DefaultVisitor::visitIntegrator(), FlatWriter::visitMapIntegrator(), DefaultVisitor::visitMapIntegrator(), and DefaultVisitor::visitTrackIntegrator().

void Integrator::makeSharable ( )

virtual

Set sharable flag.

Reimplemented from ElementBase.

Definition at line 42 of file Integrator.cpp.

References itsElement, ElementBase::makeSharable(), and ElementBase::shareFlag.

Here is the call graph for this function:

void Integrator::operator= ( const Integrator & )

private

virtual void Integrator::trackBunch	(	PartBunchBase< double, 3 > *	,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

pure virtual

Track a particle bunch.

Implemented in MPSplitIntegrator, and MapIntegrator.

Referenced by Tracker::visitTrackIntegrator().

virtual void Integrator::trackMap	(	FVps< double, 6 > &	,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

pure virtual

Track a map.

Implemented in MPSplitIntegrator, MapIntegrator, and TrackIntegrator.

virtual void Integrator::trackParticle	(	OpalParticle &	,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

pure virtual

Track a particle.

Implemented in MPSplitIntegrator, and MapIntegrator.

Member Data Documentation

Pointer<ElementBase> Integrator::itsElement

protected

Pointer to the replaced element.

Definition at line 84 of file Integrator.h.

Referenced by getElement(), MPSplitIntegrator::getGeometry(), and makeSharable().

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

src/Classic/AbsBeamline/Integrator.h
src/Classic/AbsBeamline/Integrator.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation