BeamBeamRep Class Reference

Representation of beam-beam interaction. More...

#include <BeamBeamRep.h>

Inheritance diagram for BeamBeamRep:

Collaboration diagram for BeamBeamRep:

Public Member Functions
	BeamBeamRep (const std::string &name)
	Constructor with given name. More...
	BeamBeamRep ()
	BeamBeamRep (const BeamBeamRep &)
virtual	~BeamBeamRep ()
virtual ElementBase *	clone () const
	Return clone. More...
virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel. More...
virtual double	getBunchCharge () const
	Get bunch charge. More...
virtual const Matrix3D &	getBunchMoment () const
	Get moments. More...
virtual const Vector3D &	getBunchDisplacement () const
	Get displacement. More...
virtual NullField &	getField ()
	Get field. More...
virtual const NullField &	getField () const
	Get field. More...
virtual NullGeometry &	getGeometry ()
	Get geometry. More...
virtual const NullGeometry &	getGeometry () const
	Get geometry. More...
virtual ElementImage *	getImage () const
	Construct an image. More...
void	setBunchCharge (double)
	Set the bunch charge. More...
void	setBunchMoment (const Matrix3D &)
	Set moments. More...
void	setBunchDisplacement (const Vector3D &)
	Set displacement. More...
Public Member Functions inherited from BeamBeam
	BeamBeam (const std::string &name)
	Constructor with given name. More...
	BeamBeam ()
	BeamBeam (const BeamBeam &right)
virtual	~BeamBeam ()
virtual void	accept (BeamlineVisitor &) const
	Apply visitor to BeamBeam. More...
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
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
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 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	goOnline (const double &kineticEnergy)
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...
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 BeamBeamRep &)
double	getMoment (int index) const
double	getDisplacement (int index) const
void	setMoment (int index, double)
void	setDisplacement (int index, double)

Private Attributes
NullField	field
NullGeometry	geometry
double	Q
Vector3D	delta
Matrix3D	sigma

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

Representation of beam-beam interaction.

Definition at line 47 of file BeamBeamRep.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 68 of file BeamBeamRep.cpp.

BeamBeamRep::BeamBeamRep

(

)

Definition at line 58 of file BeamBeamRep.cpp.

Referenced by clone().

BeamBeamRep::BeamBeamRep

(

const BeamBeamRep &

right

)

Definition at line 63 of file BeamBeamRep.cpp.

BeamBeamRep::~BeamBeamRep ( )

virtual

Definition at line 73 of file BeamBeamRep.cpp.

Member Function Documentation

ElementBase * BeamBeamRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 77 of file BeamBeamRep.cpp.

References BeamBeamRep().

Here is the call graph for this function:

double BeamBeamRep::getBunchCharge ( ) const

virtual

Get bunch charge.

Implements BeamBeam.

Definition at line 117 of file BeamBeamRep.cpp.

References Q.

const Vector3D & BeamBeamRep::getBunchDisplacement ( ) const

virtual

Get displacement.

Implements BeamBeam.

Definition at line 127 of file BeamBeamRep.cpp.

References delta.

const Matrix3D & BeamBeamRep::getBunchMoment ( ) const

virtual

Get moments.

Implements BeamBeam.

Definition at line 122 of file BeamBeamRep.cpp.

References sigma.

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 82 of file BeamBeamRep.cpp.

References ElementBase::getChannel(), getDisplacement(), getMoment(), setDisplacement(), and setMoment().

Here is the call graph for this function:

double BeamBeamRep::getDisplacement ( int  index ) const

private

Definition at line 184 of file BeamBeamRep.cpp.

References delta.

Referenced by getChannel().

NullField & BeamBeamRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 132 of file BeamBeamRep.cpp.

References field.

const NullField & BeamBeamRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 137 of file BeamBeamRep.cpp.

References field.

NullGeometry & BeamBeamRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 142 of file BeamBeamRep.cpp.

References geometry.

const NullGeometry & BeamBeamRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 146 of file BeamBeamRep.cpp.

References geometry.

ElementImage * BeamBeamRep::getImage ( ) const

virtual

Construct an image.

Reimplemented from ElementBase.

Definition at line 151 of file BeamBeamRep.cpp.

References ElementBase::getImage(), and AttributeSet::setAttribute().

Here is the call graph for this function:

double BeamBeamRep::getMoment ( int  index ) const

private

Definition at line 177 of file BeamBeamRep.cpp.

References sigma.

Referenced by getChannel().

void BeamBeamRep::operator= ( const BeamBeamRep &  )

private

void BeamBeamRep::setBunchCharge

(

double

charge

)

Set the bunch charge.

Definition at line 162 of file BeamBeamRep.cpp.

References Q.

void BeamBeamRep::setBunchDisplacement

(

const Vector3D &

disp

)

Set displacement.

Definition at line 172 of file BeamBeamRep.cpp.

References delta.

void BeamBeamRep::setBunchMoment

(

const Matrix3D &

moments

)

Set moments.

Definition at line 167 of file BeamBeamRep.cpp.

References sigma.

void BeamBeamRep::setDisplacement ( int  index, double  disp  )

private

Definition at line 196 of file BeamBeamRep.cpp.

References delta.

Referenced by getChannel().

void BeamBeamRep::setMoment ( int  index, double  moment  )

private

Definition at line 189 of file BeamBeamRep.cpp.

References sigma.

Referenced by getChannel().

Member Data Documentation

Vector3D BeamBeamRep::delta

private

Definition at line 146 of file BeamBeamRep.h.

Referenced by getBunchDisplacement(), getDisplacement(), setBunchDisplacement(), and setDisplacement().

NullField BeamBeamRep::field

private

Definition at line 136 of file BeamBeamRep.h.

Referenced by getField().

NullGeometry BeamBeamRep::geometry

private

Definition at line 139 of file BeamBeamRep.h.

Referenced by getGeometry().

double BeamBeamRep::Q

private

Definition at line 142 of file BeamBeamRep.h.

Referenced by getBunchCharge(), and setBunchCharge().

Matrix3D BeamBeamRep::sigma

private

Definition at line 149 of file BeamBeamRep.h.

Referenced by getBunchMoment(), getMoment(), setBunchMoment(), and setMoment().

---

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

• src/Classic/BeamlineCore/BeamBeamRep.h
• src/Classic/BeamlineCore/BeamBeamRep.cpp