#include <SolenoidRep.h>

Inheritance diagram for SolenoidRep:

[legend]

Collaboration diagram for SolenoidRep:

[legend]

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

	SolenoidRep ()

	SolenoidRep (const SolenoidRep &)

virtual	~SolenoidRep ()

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

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

virtual ConstBzField &	getField ()
	Get field. More...

virtual const ConstBzField &	getField () const
	Get field. More...

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

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

virtual double	getBz () const
	Get field. More...

virtual void	setBz (double Bz)
	Set field. More...

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

	Solenoid ()

	Solenoid (const Solenoid &)

virtual	~Solenoid ()

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

virtual double	getBz () const =0
	Get solenoid field Bz in Teslas. More...

void	setKS (double ks)

void	setDKS (double ks)

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override

virtual bool	apply (const Vector_t &R, const Vector_t &P, 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	finalise () override

virtual bool	bends () const override

virtual void	goOnline (const double &kineticEnergy) override

virtual void	goOffline () override

void	setFieldMapFN (std::string fn)

void	setFast (bool fast)

bool	getFast () const

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

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

virtual CoordinateSystemTrafo	getEdgeToBegin () const override

virtual CoordinateSystemTrafo	getEdgeToEnd () const override

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 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 &, const double &, Vector_t &, double &)

virtual double	getDesignEnergy () const

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

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

virtual void	finalise ()=0

virtual bool	bends () const =0

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

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

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

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

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

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	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 SolenoidRep &)

Private Attributes
StraightGeometry	geometry
	The solenoid geometry. More...

ConstBzField	field
	The solenoid field. More...

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 26 of file SolenoidRep.h.

Constructor & Destructor Documentation

◆ SolenoidRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 58 of file SolenoidRep.cpp.

◆ SolenoidRep() [2/3]

SolenoidRep::SolenoidRep ( )

Definition at line 44 of file SolenoidRep.cpp.

Referenced by clone().

◆ SolenoidRep() [3/3]

SolenoidRep::SolenoidRep ( const SolenoidRep & right )

Definition at line 51 of file SolenoidRep.cpp.

◆ ~SolenoidRep()

SolenoidRep::~SolenoidRep ( )

virtual

Definition at line 63 of file SolenoidRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * SolenoidRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 67 of file SolenoidRep.cpp.

References SolenoidRep().

Here is the call graph for this function:

◆ getBz()

double SolenoidRep::getBz ( ) const

virtual

Get field.

Implements Solenoid.

Definition at line 101 of file SolenoidRep.cpp.

References field, and ConstBzField::getBz().

Here is the call graph for this function:

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 72 of file SolenoidRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getField() [1/2]

ConstBzField & SolenoidRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 83 of file SolenoidRep.cpp.

References field.

◆ getField() [2/2]

const ConstBzField & SolenoidRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 87 of file SolenoidRep.cpp.

References field.

◆ getGeometry() [1/2]

StraightGeometry & SolenoidRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 92 of file SolenoidRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & SolenoidRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 96 of file SolenoidRep.cpp.

References geometry.

◆ operator=()

void SolenoidRep::operator= ( const SolenoidRep & )

private

◆ setBz()

void SolenoidRep::setBz ( double Bz )

virtual

Set field.

Definition at line 106 of file SolenoidRep.cpp.

References field, and ConstBzField::setBz().

Referenced by OpalSolenoid::update().

Here is the call graph for this function:

Member Data Documentation

◆ field

ConstBzField SolenoidRep::field

private

The solenoid field.

Definition at line 80 of file SolenoidRep.h.

Referenced by getBz(), getField(), and setBz().

◆ geometry

StraightGeometry SolenoidRep::geometry

private

The solenoid geometry.

Definition at line 77 of file SolenoidRep.h.

Referenced by getGeometry().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SolenoidRep() [1/3]

◆ SolenoidRep() [2/3]

◆ SolenoidRep() [3/3]

◆ ~SolenoidRep()

Member Function Documentation

◆ clone()

◆ getBz()

◆ getChannel()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ operator=()

◆ setBz()

Member Data Documentation

◆ field

◆ geometry