Degrader Class Reference

#include <Degrader.h>

Inheritance diagram for Degrader:

Collaboration diagram for Degrader:

Public Types
enum	Plane { OFF, X, Y, XY }
	Plane selection. More...

Public Member Functions
	Degrader (const std::string &name)
	Constructor with given name. More...
	Degrader ()
	Degrader (const Degrader &rhs)
virtual	~Degrader ()
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Degrader. 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 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 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
void	setDimensions (double xsize, double ysize)
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 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 &, const double &, Vector_t &, double &)
virtual double	getDesignEnergy () const
virtual void	setDesignEnergy (const double &energy, bool changeable=true)
virtual bool	Online ()
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 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< 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	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () 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 Degrader &)

Private Attributes
std::vector< double >	PosX_m
std::vector< double >	PosY_m
std::vector< double >	PosZ_m
std::vector< double >	MomentumX_m
std::vector< double >	MomentumY_m
std::vector< double >	MomentumZ_m
std::vector< double >	time_m
std::vector< int >	id_m
double	width_m
double	height_m

Additional Inherited Members
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

Definition at line 28 of file Degrader.h.

Member Enumeration Documentation

enum Degrader::Plane

Plane selection.

Enumerator
OFF	Monitor is off (inactive).
X	Monitor acts on x-plane.
Y	Monitor acts on y-plane.
XY	Monitor acts on both planes.

Definition at line 32 of file Degrader.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 50 of file Degrader.cpp.

Degrader::Degrader

(

)

Definition at line 32 of file Degrader.cpp.

Degrader::Degrader

(

const Degrader &

rhs

)

Definition at line 36 of file Degrader.cpp.

Degrader::~Degrader ( )

virtual

Definition at line 56 of file Degrader.cpp.

References goOffline(), and Component::online_m.

Here is the call graph for this function:

Member Function Documentation

void Degrader::accept ( BeamlineVisitor &  visitor ) const

overridevirtual

Apply visitor to Degrader.

Implements ElementBase.

Definition at line 61 of file Degrader.cpp.

References BeamlineVisitor::visitDegrader().

Here is the call graph for this function:

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

overridevirtual

Reimplemented from Component.

Definition at line 83 of file Degrader.cpp.

References PartBunchBase< T, Dim >::Bin, Physics::c, dot(), PartBunchBase< T, Dim >::dt, PartBunchBase< T, Dim >::ID, id_m, isInside(), MomentumX_m, MomentumY_m, MomentumZ_m, PartBunchBase< T, Dim >::P, PosX_m, PosY_m, PosZ_m, Attrib::Distribution::R, PartBunchBase< T, Dim >::R, Component::RefPartBunch_m, sqrt(), and time_m.

Here is the call graph for this function:

bool Degrader::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 112 of file Degrader.cpp.

References Physics::c, ParticleMatterInteractionHandler::computeEnergyLoss(), euclidean_norm(), PartBunchBase< T, Dim >::getdT(), PartBunchBase< T, Dim >::getM(), ElementBase::getParticleMatterInteraction(), PartBunchBase< T, Dim >::getQ(), isInside(), and Component::RefPartBunch_m.

Here is the call graph for this function:

bool Degrader::bends ( ) const

overridevirtual

Implements Component.

Definition at line 162 of file Degrader.cpp.

void Degrader::finalise ( )

overridevirtual

Implements Component.

Definition at line 136 of file Degrader.cpp.

References endl(), and ElementBase::getName().

Here is the call graph for this function:

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

overridevirtual

Implements Component.

Definition at line 166 of file Degrader.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

ElementType Degrader::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 171 of file Degrader.cpp.

References DEGRADER.

void Degrader::goOffline ( )

overridevirtual

Reimplemented from Component.

Definition at line 156 of file Degrader.cpp.

References endl(), and Component::online_m.

Referenced by ~Degrader().

Here is the call graph for this function:

void Degrader::goOnline ( const double &  kineticEnergy )

overridevirtual

Reimplemented from Component.

Definition at line 140 of file Degrader.cpp.

References PartBunchBase< T, Dim >::getLocalNum(), id_m, MomentumX_m, MomentumY_m, MomentumZ_m, Component::online_m, PosX_m, PosY_m, PosZ_m, Component::RefPartBunch_m, and time_m.

Here is the call graph for this function:

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

overridevirtual

Implements Component.

Definition at line 127 of file Degrader.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

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

virtual

Definition at line 132 of file Degrader.cpp.

References Component::RefPartBunch_m.

bool Degrader::isInside ( const Vector_t &  R ) const

overridevirtual

check if the particle is in the degrader material

Reimplemented from ElementBase.

Definition at line 71 of file Degrader.cpp.

References ElementBase::getElementLength(), height_m, pow(), Attrib::Distribution::R, and width_m.

Referenced by apply(), and applyToReferenceParticle().

Here is the call graph for this function:

void Degrader::operator= ( const Degrader &  )

private

void Degrader::setDimensions	(	double	xsize,
		double	ysize
	)

Definition at line 65 of file Degrader.cpp.

References height_m, and width_m.

Referenced by OpalDegrader::update().

Member Data Documentation

double Degrader::height_m

private

Definition at line 95 of file Degrader.h.

Referenced by isInside(), and setDimensions().

std::vector<int> Degrader::id_m

private

Definition at line 92 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::MomentumX_m

private

Definition at line 88 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::MomentumY_m

private

Definition at line 89 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::MomentumZ_m

private

Definition at line 90 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::PosX_m

private

Definition at line 85 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::PosY_m

private

Definition at line 86 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::PosZ_m

private

Definition at line 87 of file Degrader.h.

Referenced by apply(), and goOnline().

std::vector<double> Degrader::time_m

private

Definition at line 91 of file Degrader.h.

Referenced by apply(), and goOnline().

double Degrader::width_m

private

Definition at line 94 of file Degrader.h.

Referenced by isInside(), and setDimensions().

---

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

• src/Classic/AbsBeamline/Degrader.h
• src/Classic/AbsBeamline/Degrader.cpp