Abstract collimator. More...

#include <FlexibleCollimator.h>

Inheritance diagram for FlexibleCollimator:

Collaboration diagram for FlexibleCollimator:

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

	FlexibleCollimator ()

	FlexibleCollimator (const FlexibleCollimator &rhs)

virtual	~FlexibleCollimator ()

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

virtual bool	apply (const size_t &i, 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 bool	checkCollimator (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep)

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

virtual void	initialise (PartBunchBase< double, 3 > *bunch)

virtual void	finalise () override

virtual bool	bends () const override

virtual void	goOnline (const double &kineticEnergy) override

virtual void	goOffline () override

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

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

void	print ()

void	setOutputFN (const std::string &fn)

std::string	getOutputFN () const

unsigned int	getLosses () const

void	setDescription (const std::string &desc)

std::string	getDescription () const

bool	isStopped (const Vector_t &R, const Vector_t &P, double recpgamma)

void	writeHolesAndQuadtree (const std::string &baseFilename) const

Public Member Functions inherited from Component
	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 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 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 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 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...

Private Member Functions
void	operator= (const FlexibleCollimator &)

Private Attributes
std::string	description_m

std::vector< std::shared_ptr < mslang::Base > >	holes_m

mslang::BoundingBox	bb_m

mslang::QuadTree	tree_m

std::string	filename_m

bool	informed_m

unsigned int	losses_m

std::unique_ptr< LossDataSink >	lossDs_m

ParticleMatterInteractionHandler *	parmatint_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)

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

Abstract collimator.

Definition at line 17 of file FlexibleCollimator.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 44 of file FlexibleCollimator.cpp.

FlexibleCollimator::FlexibleCollimator ( )

Definition at line 18 of file FlexibleCollimator.cpp.

FlexibleCollimator::FlexibleCollimator ( const FlexibleCollimator & rhs )

Definition at line 23 of file FlexibleCollimator.cpp.

References mslang::QuadTree::bb_m, bb_m, mslang::QuadTree::buildUp(), holes_m, mslang::QuadTree::objects_m, and tree_m.

Here is the call graph for this function:

FlexibleCollimator::~FlexibleCollimator ( )

virtual

Definition at line 55 of file FlexibleCollimator.cpp.

References goOffline(), and Component::online_m.

Here is the call graph for this function:

Member Function Documentation

void FlexibleCollimator::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to FlexibleCollimator.

Implements ElementBase.

Definition at line 65 of file FlexibleCollimator.cpp.

References BeamlineVisitor::visitFlexibleCollimator().

Here is the call graph for this function:

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

overridevirtual

Reimplemented from Component.

Definition at line 88 of file FlexibleCollimator.cpp.

References Physics::c, dot(), PartBunchBase< T, Dim >::dt, PartBunchBase< T, Dim >::ID, isStopped(), lossDs_m, losses_m, PartBunchBase< T, Dim >::P, Attrib::Distribution::R, PartBunchBase< T, Dim >::R, Component::RefPartBunch_m, and sqrt().

Here is the call graph for this function:

bool FlexibleCollimator::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 108 of file FlexibleCollimator.cpp.

bool FlexibleCollimator::bends ( ) const

inlineoverridevirtual

Implements Component.

Definition at line 92 of file FlexibleCollimator.h.

bool FlexibleCollimator::checkCollimator	(	PartBunchBase< double, 3 > *	bunch,
		const int	turnnumber,
		const double	t,
		const double	tstep
	)

virtual

Definition at line 114 of file FlexibleCollimator.cpp.

void FlexibleCollimator::finalise ( )

overridevirtual

Implements Component.

Definition at line 150 of file FlexibleCollimator.cpp.

References endl(), ElementBase::getName(), goOffline(), and Component::online_m.

Here is the call graph for this function:

std::string FlexibleCollimator::getDescription ( ) const

inline

Definition at line 107 of file FlexibleCollimator.h.

References description_m.

Referenced by OpalECollimator::fillRegisteredAttributes(), OpalSlit::fillRegisteredAttributes(), OpalRCollimator::fillRegisteredAttributes(), and OpalFlexibleCollimator::fillRegisteredAttributes().

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

overridevirtual

Implements Component.

Definition at line 188 of file FlexibleCollimator.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

unsigned int FlexibleCollimator::getLosses ( ) const

inline

Definition at line 87 of file FlexibleCollimator.h.

References losses_m.

Referenced by ParallelTTracker::writePhaseSpace().

std::string FlexibleCollimator::getOutputFN ( ) const

inline

Definition at line 102 of file FlexibleCollimator.h.

References filename_m.

ElementBase::ElementType FlexibleCollimator::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 193 of file FlexibleCollimator.cpp.

References ElementBase::FLEXIBLECOLLIMATOR.

void FlexibleCollimator::goOffline ( )

overridevirtual

Reimplemented from Component.

Definition at line 181 of file FlexibleCollimator.cpp.

References lossDs_m, and Component::online_m.

Referenced by finalise(), and ~FlexibleCollimator().

void FlexibleCollimator::goOnline ( const double & kineticEnergy )

overridevirtual

Reimplemented from Component.

Definition at line 157 of file FlexibleCollimator.cpp.

References Component::online_m, and print().

Referenced by initialise().

Here is the call graph for this function:

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

overridevirtual

Implements Component.

Definition at line 119 of file FlexibleCollimator.cpp.

References Options::asciidump, filename_m, ElementBase::getElementLength(), ElementBase::getName(), ElementBase::getParticleMatterInteraction(), goOnline(), lossDs_m, parmatint_m, and Component::RefPartBunch_m.

Here is the call graph for this function:

void FlexibleCollimator::initialise ( PartBunchBase< double, 3 > * bunch )

virtual

Definition at line 135 of file FlexibleCollimator.cpp.

References Options::asciidump, filename_m, ElementBase::getName(), ElementBase::getParticleMatterInteraction(), goOnline(), lossDs_m, parmatint_m, and Component::RefPartBunch_m.

Here is the call graph for this function:

bool FlexibleCollimator::isStopped	(	const Vector_t &	R,
		const Vector_t &	P,
		double	recpgamma
	)

Definition at line 70 of file FlexibleCollimator.cpp.

References bb_m, ElementBase::getElementLength(), mslang::BoundingBox::isInside(), mslang::QuadTree::isInside(), ElementBase::isInsideTransverse(), Attrib::Distribution::R, and tree_m.

Referenced by apply().

Here is the call graph for this function:

void FlexibleCollimator::operator= ( const FlexibleCollimator & )

private

void FlexibleCollimator::print ( )

Definition at line 163 of file FlexibleCollimator.cpp.

References endl(), ERRORMSG, informed_m, level3(), IpplInfo::myNode(), Component::RefPartBunch_m, and Fieldmap::typeset_msg().

Referenced by goOnline().

Here is the call graph for this function:

void FlexibleCollimator::setDescription ( const std::string & desc )

Definition at line 197 of file FlexibleCollimator.cpp.

References mslang::Function::apply(), mslang::QuadTree::bb_m, bb_m, mslang::QuadTree::buildUp(), mslang::BoundingBox::center_m, Physics::e, mslang::BoundingBox::height_m, holes_m, max(), min(), mslang::QuadTree::objects_m, mslang::parse(), mslang::QuadTree::reset(), tree_m, and mslang::BoundingBox::width_m.

Referenced by OpalECollimator::update(), OpalSlit::update(), OpalRCollimator::update(), OpalFlexibleCollimator::update(), and OpalPepperPot::update().

Here is the call graph for this function:

void FlexibleCollimator::setOutputFN ( const std::string & fn )

inline

Definition at line 97 of file FlexibleCollimator.h.

References filename_m.

Referenced by OpalECollimator::update(), OpalSlit::update(), OpalRCollimator::update(), OpalFlexibleCollimator::update(), and OpalPepperPot::update().

void FlexibleCollimator::writeHolesAndQuadtree ( const std::string & baseFilename ) const

Definition at line 250 of file FlexibleCollimator.cpp.

References holes_m, IpplInfo::myNode(), tree_m, and mslang::QuadTree::writeGnuplot().

Referenced by OpalFlexibleCollimator::update().

Here is the call graph for this function:

Member Data Documentation

mslang::BoundingBox FlexibleCollimator::bb_m

private

Definition at line 74 of file FlexibleCollimator.h.

Referenced by FlexibleCollimator(), isStopped(), and setDescription().

std::string FlexibleCollimator::description_m

private

Definition at line 72 of file FlexibleCollimator.h.

Referenced by getDescription().

std::string FlexibleCollimator::filename_m

private

The name of the outputfile

Definition at line 77 of file FlexibleCollimator.h.

Referenced by getOutputFN(), initialise(), and setOutputFN().

std::vector<std::shared_ptr<mslang::Base> > FlexibleCollimator::holes_m

private

Definition at line 73 of file FlexibleCollimator.h.

Referenced by FlexibleCollimator(), setDescription(), and writeHolesAndQuadtree().

bool FlexibleCollimator::informed_m

private

Definition at line 79 of file FlexibleCollimator.h.

Referenced by print().

std::unique_ptr<LossDataSink> FlexibleCollimator::lossDs_m

private

Definition at line 81 of file FlexibleCollimator.h.

Referenced by apply(), goOffline(), and initialise().

unsigned int FlexibleCollimator::losses_m

private

Definition at line 80 of file FlexibleCollimator.h.

Referenced by apply(), and getLosses().

ParticleMatterInteractionHandler* FlexibleCollimator::parmatint_m

private

Definition at line 83 of file FlexibleCollimator.h.

Referenced by initialise().

mslang::QuadTree FlexibleCollimator::tree_m

private

Definition at line 75 of file FlexibleCollimator.h.

Referenced by FlexibleCollimator(), isStopped(), setDescription(), and writeHolesAndQuadtree().

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

src/Classic/AbsBeamline/FlexibleCollimator.h
src/Classic/AbsBeamline/FlexibleCollimator.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation