CyclotronRep Class Reference

Representation for a cyclotron magnet system. More...

#include <CyclotronRep.h>

Inheritance diagram for CyclotronRep:

Collaboration diagram for CyclotronRep:

Public Member Functions
	CyclotronRep (const std::string &name)
	Constructor with given name. More...
	CyclotronRep ()
	CyclotronRep (const CyclotronRep &)
virtual	~CyclotronRep ()
virtual ElementBase *	clone () const
	Return clone. More...
virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel. More...
virtual ElementBase *	makeFieldWrapper ()
	Get the initial radius. More...
virtual double	getSlices () const
	Get number of slices. More...
virtual double	getStepsize () const
	Get stepsize. More...
virtual void	setSlices (double sl)
	Set number of slices. More...
virtual void	setStepsize (double ds)
	Set stepsize. More...
virtual void	setField (const BMultipoleField &field)
	Set field. More...
virtual BMultipoleField &	getField ()
	Get field. More...
virtual const BMultipoleField &	getField () const
	Get field. More...
virtual PlanarArcGeometry &	getGeometry ()
	Get geometry. More...
virtual const PlanarArcGeometry &	getGeometry () const
	Get geometry. More...
Public Member Functions inherited from Cyclotron
	Cyclotron (const std::string &name)
	Constructor with given name. More...
	Cyclotron ()
	Cyclotron (const Cyclotron &)
virtual	~Cyclotron ()
virtual void	accept (BeamlineVisitor &) const
	Apply visitor to Cyclotron. More...
void	setFieldMapFN (std::string fmapfn)
virtual std::string	getFieldMapFN () const
void	setRfFieldMapFN (std::vector< std::string > rffmapfn)
void	setRFFCoeffFN (std::vector< std::string > rff_coeff_fn)
void	setRFVCoeffFN (std::vector< std::string > rfv_coeff_fn)
int	getFieldFlag (const std::string &type) const
void	setType (std::string t)
const std::string &	getCyclotronType () const
virtual ElementBase::ElementType	getType () const
	Get element type std::string. More...
virtual void	getDimensions (double &zBegin, double &zEnd) const
unsigned int	getNumberOfTrimcoils () const
void	setCyclHarm (double h)
virtual double	getCyclHarm () const
void	setRfPhi (std::vector< double > f)
void	setRfFrequ (std::vector< double > f)
double	getRfFrequ () const
void	setSymmetry (double symmetry)
virtual double	getSymmetry () const
void	setRinit (double rinit)
virtual double	getRinit () const
void	setPRinit (double prinit)
virtual double	getPRinit () const
void	setPHIinit (double phiinit)
virtual double	getPHIinit () const
void	setZinit (double zinit)
virtual double	getZinit () const
void	setPZinit (double zinit)
virtual double	getPZinit () const
void	setBScale (double bs)
virtual double	getBScale () const
void	setEScale (std::vector< double > bs)
void	setTrimCoils (const std::vector< TrimCoil * > &trimcoils)
void	setSuperpose (std::vector< bool > flag)
void	setMinR (double r)
virtual double	getMinR () const
void	setMaxR (double r)
virtual double	getMaxR () const
void	setMinZ (double z)
virtual double	getMinZ () const
void	setMaxZ (double z)
virtual double	getMaxZ () const
void	setFMLowE (double e)
virtual double	getFMLowE () const
void	setFMHighE (double e)
virtual double	getFMHighE () const
void	setTrimCoilThreshold (double)
virtual double	getTrimCoilThreshold () const
void	setSpiralFlag (bool spiral_flag)
virtual bool	getSpiralFlag () const
virtual bool	apply (const size_t &id, 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 void	apply (const double &rad, const double &z, const double &tet_rad, double &br, double &bt, double &bz)
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
virtual void	initialise (PartBunchBase< double, 3 > *bunch, const int &fieldflag, const double &scaleFactor)
virtual void	finalise ()
virtual bool	bends () const
virtual double	getRmax () const
virtual double	getRmin () const
bool	interpolate (const double &rad, const double &tet_rad, double &br, double &bt, double &bz)
void	read (const int &fieldflag, const double &scaleFactor)
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	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 ElementImage *	getImage () const
	Construct an image. 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 *	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 CyclotronRep &)

Private Attributes
double	rInit
	The initial radius of the cyclotron. More...
double	pInit
	The initial momenta of the cyclotron. More...
double	phiInit
	The initial phase w.r.t. the rf of the cyclotron. More...
double	rfFrequ
	The rf of the cyclotron. More...
PlanarArcGeometry	geometry
	The cyclotron geometry. More...
BMultipoleField	field
	The field expansion. More...
double	slices
double	stepsize

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 Cyclotron
void	getdiffs ()
double	gutdf5d (double *f, double dx, const int kor, const int krl, const int lpr)
void	initR (double rmin, double dr, int nrad)
void	getFieldFromFile (const double &scaleFactor)
void	getFieldFromFile_Carbon (const double &scaleFactor)
void	getFieldFromFile_CYCIAE (const double &scaleFactor)
void	getFieldFromFile_AVFEQ (const double &scaleFactor)
void	getFieldFromFile_FFA (const double &scaleFactor)
void	getFieldFromFile_BandRF (const double &scaleFactor)
void	getFieldFromFile_Synchrocyclotron (const double &scaleFactor)
int	idx (int irad, int ktet)
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 Cyclotron
BfieldData	Bfield
BPositions	BP
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 for a cyclotron magnet system.

Definition at line 32 of file CyclotronRep.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 66 of file CyclotronRep.cpp.

References rInit.

CyclotronRep::CyclotronRep

(

)

Definition at line 50 of file CyclotronRep.cpp.

References rInit.

Referenced by clone().

CyclotronRep::CyclotronRep

(

const CyclotronRep &

rhs

)

Definition at line 58 of file CyclotronRep.cpp.

References rInit.

CyclotronRep::~CyclotronRep ( )

virtual

Definition at line 74 of file CyclotronRep.cpp.

Member Function Documentation

ElementBase * CyclotronRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 78 of file CyclotronRep.cpp.

References CyclotronRep().

Here is the call graph for this function:

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 83 of file CyclotronRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

BMultipoleField & CyclotronRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 130 of file CyclotronRep.cpp.

References field.

const BMultipoleField & CyclotronRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 134 of file CyclotronRep.cpp.

References field.

PlanarArcGeometry & CyclotronRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 122 of file CyclotronRep.cpp.

References geometry.

const PlanarArcGeometry & CyclotronRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 126 of file CyclotronRep.cpp.

References geometry.

double CyclotronRep::getSlices ( ) const

virtual

Get number of slices.

Implements Cyclotron.

Definition at line 94 of file CyclotronRep.cpp.

References slices.

double CyclotronRep::getStepsize ( ) const

virtual

Get stepsize.

Implements Cyclotron.

Definition at line 98 of file CyclotronRep.cpp.

References stepsize.

ElementBase * CyclotronRep::makeFieldWrapper ( )

virtual

Get the initial radius.

Set the initial radius Allow field errors.

Reimplemented from ElementBase.

Definition at line 142 of file CyclotronRep.cpp.

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

Here is the call graph for this function:

void CyclotronRep::operator= ( const CyclotronRep &  )

private

void CyclotronRep::setField ( const BMultipoleField &  field )

virtual

Set field.

Definition at line 138 of file CyclotronRep.cpp.

References field.

void CyclotronRep::setSlices ( double  sl )

virtual

Set number of slices.

Definition at line 102 of file CyclotronRep.cpp.

References slices.

void CyclotronRep::setStepsize ( double  ds )

virtual

Set stepsize.

Definition at line 106 of file CyclotronRep.cpp.

References stepsize.

Member Data Documentation

BMultipoleField CyclotronRep::field

private

The field expansion.

Definition at line 122 of file CyclotronRep.h.

Referenced by getField(), and setField().

PlanarArcGeometry CyclotronRep::geometry

private

The cyclotron geometry.

Definition at line 119 of file CyclotronRep.h.

Referenced by getGeometry().

double CyclotronRep::phiInit

private

The initial phase w.r.t. the rf of the cyclotron.

Definition at line 113 of file CyclotronRep.h.

double CyclotronRep::pInit

private

The initial momenta of the cyclotron.

Definition at line 110 of file CyclotronRep.h.

double CyclotronRep::rfFrequ

private

The rf of the cyclotron.

Definition at line 116 of file CyclotronRep.h.

double CyclotronRep::rInit

private

The initial radius of the cyclotron.

Definition at line 107 of file CyclotronRep.h.

Referenced by CyclotronRep().

double CyclotronRep::slices

private

Definition at line 125 of file CyclotronRep.h.

Referenced by getSlices(), and setSlices().

double CyclotronRep::stepsize

private

Definition at line 126 of file CyclotronRep.h.

Referenced by getStepsize(), and setStepsize().

---

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

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