#include <UndulatorRep.h>

Inheritance diagram for UndulatorRep:

[legend]

Collaboration diagram for UndulatorRep:

[legend]

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

	UndulatorRep ()

	UndulatorRep (const UndulatorRep &)

virtual	~UndulatorRep ()

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

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

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

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

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

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

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

	Undulator ()

	Undulator (const Undulator &right)

virtual	~Undulator ()

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

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

void	apply (PartBunchBase< double, 3 > *itsBunch, CoordinateSystemTrafo const &refToLocalCSTrafo)

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

void	setK (double k)

double	getK () const

void	setLambda (double lambda)

double	getLambda () const

void	setNumPeriods (unsigned int np)

unsigned int	getNumPeriods () const

void	setAngle (double theta)

double	getAngle () const

void	setFilename (const std::string &fname)

const std::string &	getFilename () const

void	setMeshLength (const std::vector< double > &ml)

std::vector< double >	getMeshLength () const

void	setMeshResolution (const std::vector< double > &mr)

std::vector< double >	getMeshResolution () const

void	setTruncationOrder (unsigned int trunOrder)

unsigned int	getTruncationOrder () const

void	setTotalTime (double tt)

double	getTotalTime () const

void	setDtBunch (double dtb)

double	getDtBunch () const

void	setHasBeenSimulated (bool hbs)

bool	getHasBeenSimulated () 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 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	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...

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< ElementBase::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	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 UndulatorRep &)

Private Attributes
NullField	field
	The zero magnetic field. More...

StraightGeometry	geometry
	The geometry. More...

Additional Inherited Members
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR , ELLIPTICAL , CONIC_RECTANGULAR , CONIC_ELLIPTICAL }

enum	ElementType { BEAMLINE , CCOLLIMATOR , CORRECTOR , CYCLOTRON , DEGRADER , DRIFT , FLEXIBLECOLLIMATOR , MARKER , MONITOR , MPSPLITINTEGRATOR , MULTIPOLE , MULTIPOLET , OFFSET , PROBE , RBEND , RBEND3D , RFCAVITY , RING , SBEND3D , SBEND , SEPTUM , SOLENOID , SOURCE , STRIPPER , TRAVELINGWAVE , UNDULATOR , VACUUM , 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) 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 29 of file UndulatorRep.h.

Constructor & Destructor Documentation

◆ UndulatorRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 43 of file UndulatorRep.cpp.

◆ UndulatorRep() [2/3]

UndulatorRep::UndulatorRep ( )

Definition at line 37 of file UndulatorRep.cpp.

Referenced by clone().

◆ UndulatorRep() [3/3]

UndulatorRep::UndulatorRep ( const UndulatorRep & right )

Definition at line 40 of file UndulatorRep.cpp.

◆ ~UndulatorRep()

UndulatorRep::~UndulatorRep ( )

virtual

Definition at line 46 of file UndulatorRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * UndulatorRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 49 of file UndulatorRep.cpp.

References UndulatorRep().

Here is the call graph for this function:

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 53 of file UndulatorRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getField() [1/2]

NullField & UndulatorRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 63 of file UndulatorRep.cpp.

References field.

◆ getField() [2/2]

const NullField & UndulatorRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 67 of file UndulatorRep.cpp.

References field.

◆ getGeometry() [1/2]

StraightGeometry & UndulatorRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 71 of file UndulatorRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & UndulatorRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 75 of file UndulatorRep.cpp.

References geometry.

◆ operator=()

void UndulatorRep::operator= ( const UndulatorRep & )

private

Member Data Documentation

◆ field

NullField UndulatorRep::field

private

The zero magnetic field.

Definition at line 69 of file UndulatorRep.h.

Referenced by getField().

◆ geometry

StraightGeometry UndulatorRep::geometry

private

The geometry.

Definition at line 72 of file UndulatorRep.h.

Referenced by getGeometry().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UndulatorRep() [1/3]

◆ UndulatorRep() [2/3]

◆ UndulatorRep() [3/3]

◆ ~UndulatorRep()

Member Function Documentation

◆ clone()

◆ getChannel()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ operator=()

Member Data Documentation

◆ field

◆ geometry