#include <RFCavity.h>

Inheritance diagram for RFCavity:

Collaboration diagram for RFCavity:

Public Member Functions
	RFCavity (const std::string &name)
	Constructor with given name.
	RFCavity ()
	RFCavity (const RFCavity &)
virtual	~RFCavity ()
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to RFCavity.
virtual double	getAmplitude () const =0
	Get RF amplitude.
virtual double	getFrequency () const =0
	Get RF frequency.
void	setFrequency (double freq)
virtual double	getPhase () const =0
	Get RF phase.
void	dropFieldmaps ()
virtual void	setFieldMapFN (const std::string &fmapfn)
	Set the name of the field map.
virtual std::string	getFieldMapFN () const
virtual void	setAmplitudem (double vPeak)
virtual double	getAmplitudem () const
virtual void	setAmplitudeError (double vPeakError)
virtual double	getAmplitudeError () const
virtual void	setFrequencym (double freq)
virtual double	getFrequencym () const
virtual void	setPhasem (double phase)
virtual double	getPhasem () const
double	getPhasem (double t) const
virtual void	setPhaseError (double phaseError)
virtual double	getPhaseError () const
void	setCavityType (const std::string &type)
CavityType	getCavityType () const
std::string	getCavityTypeString () const
virtual void	setFast (bool fast)
virtual bool	getFast () const
virtual void	setAutophaseVeto (bool veto=true)
virtual bool	getAutophaseVeto () const
virtual double	getAutoPhaseEstimate (const double &E0, const double &t0, const double &q, const double &m)
virtual double	getAutoPhaseEstimateFallback (double E0, double t0, double q, double m)
virtual std::pair< double, double >	trackOnAxisParticle (const double &p0, const double &t0, const double &dt, const double &q, const double &mass, std::ofstream *out=nullptr)
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	initialise (PartBunchBase< double, 3 > *bunch, std::shared_ptr< AbstractTimeDependence > freq_atd, std::shared_ptr< AbstractTimeDependence > ampl_atd, std::shared_ptr< AbstractTimeDependence > phase_atd)
virtual void	finalise () override
virtual bool	bends () const override
virtual void	goOnline (const double &kineticEnergy) override
virtual void	goOffline () override
virtual void	setDesignEnergy (const double &ekin, bool changeable=true) override
virtual double	getDesignEnergy () const override
void	setRmin (double rmin)
virtual double	getRmin () const
void	setRmax (double rmax)
virtual double	getRmax () const
void	setAzimuth (double angle)
virtual double	getAzimuth () const
void	setPerpenDistance (double pdis)
virtual double	getPerpenDistance () const
void	setGapWidth (double gapwidth)
virtual double	getGapWidth () const
void	setPhi0 (double phi0)
virtual double	getPhi0 () const
virtual double	getCosAzimuth () const
virtual double	getSinAzimuth () const
virtual double	getCycFrequency () const
void	getMomentaKick (const double normalRadius, double momentum[], const double t, const double dtCorrt, const int PID, const double restMass, const int chargenumber)
	used in OPAL-cycl
double	spline (double z, double *za)
virtual ElementType	getType () const override
	Get element type std::string.
virtual void	getDimensions (double &zBegin, double &zEnd) const override
virtual bool	isInside (const Vector_t &r) const override
void	setAmplitudeModel (std::shared_ptr< AbstractTimeDependence > time_dep)
void	setAmplitudeModelName (std::string name)
std::string	getAmplitudeModelName ()
void	setPhaseModel (std::shared_ptr< AbstractTimeDependence > time_dep)
void	setPhaseModelName (std::string name)
std::string	getPhaseModelName ()
void	setFrequencyModel (std::shared_ptr< AbstractTimeDependence > time_dep)
void	setFrequencyModelName (std::string name)
std::string	getFrequencyModelName ()
virtual double	getElementLength () const override
	Get design length.
virtual void	getElementDimensions (double &begin, double &end) const override
virtual CoordinateSystemTrafo	getEdgeToBegin () const override
virtual CoordinateSystemTrafo	getEdgeToEnd () const override
virtual EMField &	getField ()=0
	Return field.
virtual const EMField &	getField () const =0
	Return field.
EVector	Efield (const Point3D &P) const
	Return the field in a point.
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point.
BVector	Bfield (const Point3D &P) const
	Return the field in a point.
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point.
virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)
virtual bool	Online ()
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch.
virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map.
void	setExitFaceSlope (const double &)
virtual const std::string &	getName () const
	Get element name.
virtual void	setName (const std::string &name)
	Set element name.
std::string	getTypeString () const
virtual BGeometryBase &	getGeometry ()=0
	Get geometry.
virtual const BGeometryBase &	getGeometry () const =0
	Get geometry.
virtual double	getArcLength () const
	Get arc length.
virtual void	setElementLength (double length)
	Set design length.
virtual double	getOrigin () const
	Get origin position.
virtual double	getEntrance () const
	Get entrance position.
virtual double	getExit () const
	Get exit position.
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform.
virtual Euclid3D	getTransform (double s) const
	Get transform.
virtual Euclid3D	getTotalTransform () const
	Get transform.
virtual Euclid3D	getEntranceFrame () const
	Get transform.
virtual Euclid3D	getExitFrame () const
	Get transform.
virtual Euclid3D	getEntrancePatch () const
	Get patch.
virtual Euclid3D	getExitPatch () const
	Get patch.
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value.
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute.
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute.
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute.
virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel.
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel.
virtual ElementBase *	clone () const =0
	Return clone.
virtual ElementBase *	copyStructure ()
	Make a structural copy.
bool	isSharable () const
	Test if the element can be shared.
virtual void	makeSharable ()
	Set sharable flag.
bool	update (const AttributeSet &)
	Update element.
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any
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
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.
double	getRotationAboutZ () const
virtual BoundingBox	getBoundingBoxInLabCoords () const
virtual int	getRequiredNumberOfTimeSteps () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.

void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.
double	getElementPosition () const
bool	isElementPositionSet () const

Static Public Member Functions
static std::string	getTypeString (ElementType type)

Protected Member Functions
bool	isInsideTransverse (const Vector_t &r) const

Protected Attributes
std::shared_ptr< AbstractTimeDependence >	phaseTD_m
std::string	phaseName_m
std::shared_ptr< AbstractTimeDependence >	amplitudeTD_m
std::string	amplitudeName_m
std::shared_ptr< AbstractTimeDependence >	frequencyTD_m
std::string	frequencyName_m
std::string	filename_m
double	scale_m
double	scaleError_m
double	phase_m
double	phaseError_m
double	frequency_m
bool	fast_m
bool	autophaseVeto_m
double	designEnergy_m
Fieldmap	fieldmap_m
double	startField_m
double	exit_face_slope_m
PartBunchBase< double, 3 > *	RefPartBunch_m
bool	online_m
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
static const std::vector< double >	defaultAperture_m

Private Member Functions
double	getdE (const int &i, const std::vector< double > &t, const double &dz, const double &phi, const double &frequency, const std::vector< double > &F) const
double	getdT (const int &i, const std::vector< double > &E, const double &dz, const double mass) const
double	getdA (const int &i, const std::vector< double > &t, const double &dz, const double &frequency, const std::vector< double > &F) const
double	getdB (const int &i, const std::vector< double > &t, const double &dz, const double &frequency, const std::vector< double > &F) const
void	operator= (const RFCavity &)

Private Attributes
double	endField_m
CavityType	type_m
double	rmin_m
double	rmax_m
double	angle_m
double	sinAngle_m
double	cosAngle_m
double	pdis_m
double	gapwidth_m
double	phi0_m
std::unique_ptr< double[]>	RNormal_m
std::unique_ptr< double[]>	VrNormal_m
std::unique_ptr< double[]>	DvDr_m
int	num_points_m
std::string	elementID
AttributeSet	userAttribs
WakeFunction *	wake_m
BoundaryGeometry *	bgeometry_m
ParticleMatterInteractionHandler *	parmatint_m
bool	positionIsFixed
std::queue< std::pair< double, double > >	actionRange_m
std::string	outputfn_m
bool	deleteOnTransverseExit_m = true
int	refCount

double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

Static Private Attributes
static const boost::bimap< CavityType, std::string >	bmCavityTypeString_s
static const std::map< ElementType, std::string >	elementTypeToString_s

Detailed Description

Definition at line 36 of file RFCavity.h.

Constructor & Destructor Documentation

◆ RFCavity() [1/3]

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

explicit

Constructor with given name.

Definition at line 84 of file RFCavity.cpp.

References amplitudeTD_m, angle_m, autophaseVeto_m, Component::Component(), cosAngle_m, designEnergy_m, DvDr_m, endField_m, fast_m, fieldmap_m, filename_m, frequency_m, frequencyTD_m, gapwidth_m, name, num_points_m, pdis_m, phase_m, phaseError_m, phaseTD_m, phi0_m, rmax_m, rmin_m, RNormal_m, scale_m, scaleError_m, sinAngle_m, startField_m, type_m, and VrNormal_m.

Referenced by operator=(), RFCavity(), RFCavity(), RFCavityRep::RFCavityRep(), RFCavityRep::RFCavityRep(), RFCavityRep::RFCavityRep(), TravelingWave::TravelingWave(), and TravelingWave::TravelingWave().

Here is the call graph for this function:

◆ RFCavity() [2/3]

RFCavity::RFCavity ( )

Definition at line 45 of file RFCavity.cpp.

References RFCavity().

Here is the call graph for this function:

◆ RFCavity() [3/3]

RFCavity::RFCavity ( const RFCavity & right )

Definition at line 49 of file RFCavity.cpp.

References amplitudeName_m, amplitudeTD_m, angle_m, autophaseVeto_m, Component::Component(), cosAngle_m, designEnergy_m, DvDr_m, endField_m, fast_m, fieldmap_m, filename_m, frequency_m, frequencyName_m, frequencyTD_m, gapwidth_m, num_points_m, pdis_m, phase_m, phaseError_m, phaseName_m, phaseTD_m, phi0_m, RFCavity(), rmax_m, rmin_m, RNormal_m, scale_m, scaleError_m, sinAngle_m, startField_m, type_m, and VrNormal_m.

Here is the call graph for this function:

◆ ~RFCavity()

RFCavity::~RFCavity ( )

virtual

Definition at line 116 of file RFCavity.cpp.

Member Function Documentation

◆ accept()

void RFCavity::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to RFCavity.

Implements ElementBase.

Reimplemented in TravelingWave.

Definition at line 119 of file RFCavity.cpp.

References BeamlineVisitor::visitRFCavity().

Here is the call graph for this function:

◆ addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

Referenced by Pointer< Object >::operator=(), Pointer< Object >::operator=(), and Pointer< Object >::unique().

◆ apply() [1/2]

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

overridevirtual

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 123 of file RFCavity.cpp.

References apply(), and Component::RefPartBunch_m.

Referenced by apply().

Here is the call graph for this function:

◆ apply() [2/2]

bool RFCavity::apply	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B )

overridevirtual

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 127 of file RFCavity.cpp.

References fieldmap_m, frequency_m, getElementLength(), ElementBase::getFlagDeleteOnTransverseExit(), phase_m, phaseError_m, scale_m, scaleError_m, and startField_m.

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool RFCavity::applyToReferenceParticle	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B )

overridevirtual

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 147 of file RFCavity.cpp.

References fieldmap_m, frequency_m, getElementLength(), phase_m, scale_m, and startField_m.

Referenced by trackOnAxisParticle().

Here is the call graph for this function:

◆ bends()

bool RFCavity::bends ( ) const

overridevirtual

Implements Component.

Reimplemented in TravelingWave.

Definition at line 250 of file RFCavity.cpp.

◆ Bfield() [1/2]

BVector Component::Bfield ( const Point3D & P ) const

inlineinherited

Return the field in a point.

Definition at line 202 of file Component.h.

References EMField::Bfield(), and getField().

Referenced by OutputPlane::getFieldsAtPoint().

Here is the call graph for this function:

◆ Bfield() [2/2]

BVector Component::Bfield	(	const Point3D &	P,
		double	t ) const

inlineinherited

Return the field in a point.

Definition at line 208 of file Component.h.

References EMField::Bfield(), and getField().

Here is the call graph for this function:

◆ clone()

virtual ElementBase * ElementBase::clone ( ) const

pure virtualinherited

Return clone.

Implemented in CCollimatorRep, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MarkerRep, MonitorRep, MultipoleRep, MultipoleT, Offset, OutputPlane, ProbeRep, RBend3D, RBendRep, RFCavityRep, Ring, SBend3D, SBendRep, ScalingFFAMagnet, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TBeamline< T >, TBeamline< FlaggedElmPtr >, TBeamline< SequenceMember >, TravelingWaveRep, UndulatorRep, VacuumRep, VariableRFCavity, VariableRFCavityFringeField, VerticalFFAMagnet, XCorrectorRep, and YCorrectorRep.

References ElementBase().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 244 of file ElementBase.cpp.

References ElementBase(), and isSharable().

Referenced by Sequence::copy(), Line::parse(), and SequenceParser::parseMember().

Here is the call graph for this function:

◆ dropFieldmaps()

void RFCavity::dropFieldmaps ( )

inline

Definition at line 344 of file RFCavity.h.

References fieldmap_m.

Referenced by OpalCavity::update().

◆ EBfield() [1/2]

EBVectors Component::EBfield ( const Point3D & P ) const

inlineinherited

Return the field in a point.

Definition at line 211 of file Component.h.

References EMField::EBfield(), and getField().

Here is the call graph for this function:

◆ EBfield() [2/2]

EBVectors Component::EBfield	(	const Point3D &	P,
		double	t ) const

inlineinherited

Return the field in a point.

Definition at line 214 of file Component.h.

References EMField::EBfield(), and getField().

Here is the call graph for this function:

◆ Efield() [1/2]

EVector Component::Efield ( const Point3D & P ) const

inlineinherited

Return the field in a point.

Definition at line 199 of file Component.h.

References EMField::Efield(), and getField().

Referenced by OutputPlane::getFieldsAtPoint().

Here is the call graph for this function:

◆ Efield() [2/2]

EVector Component::Efield	(	const Point3D &	P,
		double	t ) const

inlineinherited

Return the field in a point.

Definition at line 205 of file Component.h.

References EMField::Efield(), and getField().

Here is the call graph for this function:

◆ finalise()

void RFCavity::finalise ( )

overridevirtual

Implements Component.

Reimplemented in TravelingWave.

Definition at line 247 of file RFCavity.cpp.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 551 of file ElementBase.h.

References positionIsFixed.

Referenced by OpalElement::update(), OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ getAmplitude()

virtual double RFCavity::getAmplitude ( ) const

pure virtual

Get RF amplitude.

Implemented in RFCavityRep, TravelingWave, and TravelingWaveRep.

◆ getAmplitudeError()

double RFCavity::getAmplitudeError ( ) const

inlinevirtual

Definition at line 369 of file RFCavity.h.

References scaleError_m.

◆ getAmplitudem()

double RFCavity::getAmplitudem ( ) const

inlinevirtual

Definition at line 359 of file RFCavity.h.

References scale_m.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy().

◆ getAmplitudeModelName()

std::string RFCavity::getAmplitudeModelName ( )

inline

Definition at line 449 of file RFCavity.h.

References amplitudeName_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getAperture()

std::pair< ApertureType, std::vector< double > > ElementBase::getAperture ( ) const

inlineinherited

Definition at line 525 of file ElementBase.h.

References aperture_m.

Referenced by MeshGenerator::add(), and Offset::operator=().

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 411 of file ElementBase.h.

References BGeometryBase::getArcLength(), and getGeometry().

Referenced by TBeamline< T >::getTransform().

Here is the call graph for this function:

◆ getAttribute()

double ElementBase::getAttribute ( const std::string & aKey ) const

virtualinherited

Get attribute value.

Definition at line 187 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ getAutoPhaseEstimate()

double RFCavity::getAutoPhaseEstimate	(	const double &	E0,
		const double &	t0,
		const double &	q,
		const double &	m )

virtual

Reimplemented in TravelingWave.

Definition at line 545 of file RFCavity.cpp.

References a, begin(), Physics::c, Units::deg2rad, end(), endl(), fieldmap_m, frequency_m, getAutoPhaseEstimateFallback(), Util::getBetaGamma(), getdA(), getdB(), getdE(), getdT(), IpplInfo::Info, INFOMSG, level2(), Physics::pi, Units::rad2deg, scale_m, and Physics::two_pi.

Referenced by CavityAutophaser::guessCavityPhase().

Here is the call graph for this function:

◆ getAutoPhaseEstimateFallback()

double RFCavity::getAutoPhaseEstimateFallback	(	double	E0,
		double	t0,
		double	q,
		double	m )

virtual

Definition at line 503 of file RFCavity.cpp.

References endl(), Util::getBetaGamma(), Util::getKineticEnergy(), getPhasem(), IpplInfo::Info, INFOMSG, level2(), Physics::pi, Units::rad2deg, setPhasem(), trackOnAxisParticle(), and Physics::two_pi.

Referenced by getAutoPhaseEstimate().

Here is the call graph for this function:

◆ getAutophaseVeto()

bool RFCavity::getAutophaseVeto ( ) const

inlinevirtual

Definition at line 434 of file RFCavity.h.

References autophaseVeto_m.

Referenced by ParallelTTracker::autophaseCavities(), CavityAutophaser::getPhaseAtMaxEnergy(), CavityAutophaser::guessCavityPhase(), and CavityAutophaser::optimizeCavityPhase().

◆ getAzimuth()

double RFCavity::getAzimuth ( ) const

virtual

Definition at line 308 of file RFCavity.cpp.

References angle_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 475 of file ElementBase.h.

References bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Reimplemented in Bend2D.

Definition at line 313 of file ElementBase.cpp.

References csTrafoGlobal2Local_m, and getEdgeToBegin().

Here is the call graph for this function:

◆ getCavityType()

CavityType RFCavity::getCavityType ( ) const

inline

Definition at line 414 of file RFCavity.h.

References type_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getCavityTypeString()

std::string RFCavity::getCavityTypeString ( ) const

Definition at line 341 of file RFCavity.cpp.

References bmCavityTypeString_s, and type_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in CCollimatorRep, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MonitorRep, MultipoleRep, ProbeRep, RBendRep, RFCavityRep, SBendRep, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, XCorrectorRep, and YCorrectorRep.

Definition at line 228 of file ElementBase.cpp.

References userAttribs.

◆ getConstChannel()

const ConstChannel * ElementBase::getConstChannel ( const std::string & aKey ) const

virtualinherited

Construct a read-only channel.

Definition at line 233 of file ElementBase.cpp.

References ElementBase(), and getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

◆ getCosAzimuth()

double RFCavity::getCosAzimuth ( ) const

virtual

Definition at line 316 of file RFCavity.cpp.

References cosAngle_m.

Referenced by ParallelCyclotronTracker::checkGapCross(), and ParallelCyclotronTracker::execute().

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add(), ParallelTTracker::computeParticleMatterInteraction(), Monitor::driftToCorrectPositionAndSave(), OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ getCycFrequency()

double RFCavity::getCycFrequency ( ) const

virtual

Definition at line 359 of file RFCavity.cpp.

References frequency_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getdA()

double RFCavity::getdA	(	const int &	i,
		const std::vector< double > &	t,
		const double &	dz,
		const double &	frequency,
		const std::vector< double > &	F ) const

inlineprivate

Definition at line 310 of file RFCavity.h.

Referenced by getAutoPhaseEstimate().

◆ getdB()

double RFCavity::getdB	(	const int &	i,
		const std::vector< double > &	t,
		const double &	dz,
		const double &	frequency,
		const std::vector< double > &	F ) const

inlineprivate

Definition at line 322 of file RFCavity.h.

Referenced by getAutoPhaseEstimate().

◆ getdE()

double RFCavity::getdE	(	const int &	i,
		const std::vector< double > &	t,
		const double &	dz,
		const double &	phi,
		const double &	frequency,
		const std::vector< double > &	F ) const

inlineprivate

Definition at line 270 of file RFCavity.h.

Referenced by getAutoPhaseEstimate().

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

References ElementBase::ElementBase().

Here is the call graph for this function:

◆ getDesignEnergy()

double RFCavity::getDesignEnergy ( ) const

inlineoverridevirtual

Reimplemented from Component.

Definition at line 339 of file RFCavity.h.

References designEnergy_m.

Referenced by OrbitThreader::getMaxDesignEnergy(), and CavityAutophaser::getPhaseAtMaxEnergy().

◆ getDimensions()

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

overridevirtual

Implements Component.

Reimplemented in TravelingWave.

Definition at line 493 of file RFCavity.cpp.

References endField_m, and startField_m.

◆ getdT()

double RFCavity::getdT	(	const int &	i,
		const std::vector< double > &	E,
		const double &	dz,
		const double	mass ) const

inlineprivate

Definition at line 282 of file RFCavity.h.

References Physics::c.

Referenced by getAutoPhaseEstimate().

◆ getEdgeToBegin()

CoordinateSystemTrafo RFCavity::getEdgeToBegin ( ) const

inlineoverridevirtual

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 484 of file RFCavity.h.

References startField_m.

◆ getEdgeToEnd()

CoordinateSystemTrafo RFCavity::getEdgeToEnd ( ) const

inlineoverridevirtual

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 491 of file RFCavity.h.

References getElementLength(), and startField_m.

Here is the call graph for this function:

◆ getElementDimensions()

void RFCavity::getElementDimensions	(	double &	begin,
		double &	end ) const

overridevirtual

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 743 of file RFCavity.cpp.

References begin(), end(), and fieldmap_m.

Here is the call graph for this function:

◆ getElementLength()

double RFCavity::getElementLength ( ) const

overridevirtual

Get design length.

Reimplemented from ElementBase.

Definition at line 732 of file RFCavity.cpp.

References end(), fieldmap_m, and ElementBase::getElementLength().

Referenced by apply(), TravelingWave::apply(), applyToReferenceParticle(), TravelingWave::applyToReferenceParticle(), TravelingWave::getDimensions(), getEdgeToEnd(), TravelingWave::getEdgeToEnd(), TravelingWave::getElementDimensions(), and trackOnAxisParticle().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 589 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 427 of file ElementBase.h.

References BGeometryBase::getEntrance(), and getGeometry().

Here is the call graph for this function:

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 447 of file ElementBase.h.

References BGeometryBase::getEntranceFrame(), and getGeometry().

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 455 of file ElementBase.h.

References BGeometryBase::getEntrancePatch(), and getGeometry().

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 431 of file ElementBase.h.

References BGeometryBase::getExit(), and getGeometry().

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 451 of file ElementBase.h.

References BGeometryBase::getExitFrame(), and getGeometry().

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 459 of file ElementBase.h.

References BGeometryBase::getExitPatch(), and getGeometry().

Here is the call graph for this function:

◆ getFast()

bool RFCavity::getFast ( ) const

inlinevirtual

Definition at line 424 of file RFCavity.h.

References fast_m.

◆ getField() [1/2]

virtual const EMField & Component::getField ( ) const

pure virtualinherited

◆ getField() [2/2]

virtual EMField & Component::getField ( )

pure virtualinherited

Return field.

Implemented in CCollimatorRep, Corrector, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MarkerRep, MonitorRep, Multipole, MultipoleRep, MultipoleT, Offset, OutputPlane, ProbeRep, RBend3D, RBend, RBendRep, RFCavityRep, Ring, SBend3D, SBend, SBendRep, ScalingFFAMagnet, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, VariableRFCavity, and VerticalFFAMagnet.

Referenced by Bfield(), Bfield(), EBfield(), EBfield(), Efield(), and Efield().

◆ getFieldMapFN()

std::string RFCavity::getFieldMapFN ( ) const

virtual

Definition at line 345 of file RFCavity.cpp.

References filename_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 614 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by Bend2D::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), Solenoid::apply(), TravelingWave::apply(), and FlexibleCollimator::isStopped().

◆ getFrequency()

virtual double RFCavity::getFrequency ( ) const

pure virtual

Get RF frequency.

Implemented in RFCavityRep, TravelingWave, and TravelingWaveRep.

◆ getFrequencym()

double RFCavity::getFrequencym ( ) const

inlinevirtual

Definition at line 384 of file RFCavity.h.

References frequency_m.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy(), and CavityAutophaser::optimizeCavityPhase().

◆ getFrequencyModelName()

std::string RFCavity::getFrequencyModelName ( )

inline

Definition at line 479 of file RFCavity.h.

References frequencyName_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getGapWidth()

double RFCavity::getGapWidth ( ) const

virtual

Definition at line 324 of file RFCavity.cpp.

References gapwidth_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getGeometry() [1/2]

virtual const BGeometryBase & ElementBase::getGeometry ( ) const

pure virtualinherited

◆ getGeometry() [2/2]

virtual BGeometryBase & ElementBase::getGeometry ( )

pure virtualinherited

Get geometry.

Implemented in CCollimatorRep, Corrector, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MarkerRep, Monitor, MonitorRep, Multipole, MultipoleRep, MultipoleT, Offset, OutputPlane, ProbeRep, RBend3D, RBend, RBendRep, RFCavityRep, Ring, SBend3D, SBend, SBendRep, ScalingFFAMagnet, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TBeamline< T >, TBeamline< FlaggedElmPtr >, TBeamline< SequenceMember >, TravelingWaveRep, UndulatorRep, VacuumRep, VariableRFCavity, and VerticalFFAMagnet.

Referenced by Ring::appendElement(), getArcLength(), getElementLength(), getEntrance(), getEntranceFrame(), getEntrancePatch(), getExit(), getExitFrame(), getExitPatch(), getOrigin(), getTotalTransform(), getTransform(), getTransform(), and setElementLength().

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 541 of file ElementBase.h.

References misalignment_m.

◆ getMisalignment() [2/2]

void ElementBase::getMisalignment	(	double &	x,
		double &	y,
		double &	s ) const

inherited

Referenced by ParallelTTracker::computeParticleMatterInteraction().

◆ getMomentaKick()

void RFCavity::getMomentaKick	(	const double	normalRadius,
		double	momentum[],
		const double	t,
		const double	dtCorrt,
		const int	PID,
		const double	restMass,
		const int	chargenumber )

used in OPAL-cycl

Is called from OPAL-cycl and can handle time dependent frequency, amplitude and phase

At the moment (test) only the frequency is time dependent

B field effects

Definition at line 373 of file RFCavity.cpp.

References Physics::c, cosAngle_m, endl(), Units::eV2MeV, frequency_m, frequencyTD_m, gapwidth_m, ElementBase::getName(), gmsg, Units::MVpm2Vpm, IpplInfo::myNode(), phi0_m, Units::rad2deg, rmax_m, rmin_m, scale_m, sinAngle_m, spline(), and Physics::two_pi.

Referenced by ParallelCyclotronTracker::RFkick().

Here is the call graph for this function:

◆ getName()

const std::string & ElementBase::getName ( ) const

virtualinherited

Get element name.

Definition at line 162 of file ElementBase.cpp.

References elementID.

Referenced by Ring::appendElement(), Cyclotron::apply(), Ring::apply(), Bend2D::calculateRefTrajectory(), OutputPlane::checkOne(), Vacuum::checkPressure(), TBeamline< T >::clone(), TBeamline< T >::copyStructure(), Stripper::doCheck(), CCollimator::doFinalise(), Stripper::doFinalise(), OutputPlane::doGoOffline(), Probe::doGoOffline(), PlaceRep::enter(), Cyclotron::finalise(), Degrader::finalise(), FlexibleCollimator::finalise(), Vacuum::finalise(), PyOpal::Field::getElementName(), getElementPosition(), RFCavity::getMomentaKick(), Bend2D::getOutline(), getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Ring::initialise(), Solenoid::initialise(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalWake::initWakefunction(), PlaceRep::leave(), Offset::Offset(), operator<<(), Offset::operator=(), VariableRFCavity::operator=(), operator==(), Line::parse(), Sequence::print(), Vacuum::print(), Bend2D::readFieldMap(), PyOpal::PyLine_< TBeamline< FlaggedElmPtr > >::registerObject(), Ring::Ring(), ClassicField::SortAsc(), Component::trackBunch(), Component::trackMap(), RBend3D::trackRefParticleThrough(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), Sequence::updateList(), ParallelTTracker::updateRFElement(), ParallelCyclotronTracker::visitCCollimator(), Replacer::visitFlaggedElmPtr(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitStripper(), and ParallelTTracker::writePhaseSpace().

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 423 of file ElementBase.h.

References getGeometry(), and BGeometryBase::getOrigin().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 177 of file ElementBase.cpp.

References getName(), and outputfn_m.

Referenced by Probe::doInitialise(), Cyclotron::initialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), Monitor::initialise(), PluginElement::initialise(), and Source::initialise().

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 483 of file ElementBase.h.

References parmatint_m.

Referenced by Degrader::applyToReferenceParticle(), CCollimator::doInitialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), and Vacuum::initialise().

◆ getPerpenDistance()

double RFCavity::getPerpenDistance ( ) const

virtual

Definition at line 320 of file RFCavity.cpp.

References pdis_m.

Referenced by ParallelCyclotronTracker::checkGapCross(), ParallelCyclotronTracker::execute(), ParallelCyclotronTracker::RFkick(), and ParallelCyclotronTracker::visitRFCavity().

◆ getPhase()

virtual double RFCavity::getPhase ( ) const

pure virtual

Get RF phase.

Implemented in RFCavityRep, TravelingWave, and TravelingWaveRep.

References begin(), end(), and name.

Here is the call graph for this function:

◆ getPhaseError()

double RFCavity::getPhaseError ( ) const

inlinevirtual

Definition at line 409 of file RFCavity.h.

References phaseError_m.

◆ getPhasem() [1/2]

double RFCavity::getPhasem ( ) const

inlinevirtual

Definition at line 394 of file RFCavity.h.

References phase_m.

Referenced by getAutoPhaseEstimateFallback(), CavityAutophaser::getPhaseAtMaxEnergy(), CavityAutophaser::guessCavityPhase(), CavityAutophaser::optimizeCavityPhase(), and CavityAutophaser::track().

◆ getPhasem() [2/2]

double RFCavity::getPhasem ( double t ) const

inline

Definition at line 399 of file RFCavity.h.

References frequency_m, and phase_m.

◆ getPhaseModelName()

std::string RFCavity::getPhaseModelName ( )

inline

Definition at line 464 of file RFCavity.h.

References phaseName_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getPhi0()

double RFCavity::getPhi0 ( ) const

virtual

Definition at line 328 of file RFCavity.cpp.

References phi0_m.

Referenced by ParallelCyclotronTracker::visitRFCavity().

◆ getPotential()

virtual bool Component::getPotential	(	const Vector_t &	,
		const double &	,
		Vector_t &	,
		double &	)

inlinevirtualinherited

Calculate the four-potential at some position relative to the component

Parameters

R	position in the local coordinate system of the component
t	time
A	filled with the calculated magnetic vector potential
phi	filled with the calculated electric potential Note that any existing values in A and phi may be overwritten by this method.

Returns: true if particle is outside the field map, else false Default for component is to return false and make no change to A and phi

Definition at line 130 of file Component.h.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, Monitor, Source, and Stripper.

Definition at line 603 of file ElementBase.h.

◆ getRmax()

double RFCavity::getRmax ( ) const

virtual

Definition at line 299 of file RFCavity.cpp.

References rmax_m, and rmin_m.

Referenced by ParallelCyclotronTracker::RFkick(), and ParallelCyclotronTracker::visitRFCavity().

◆ getRmin()

double RFCavity::getRmin ( ) const

virtual

Definition at line 290 of file RFCavity.cpp.

References rmin_m.

Referenced by ParallelCyclotronTracker::RFkick(), and ParallelCyclotronTracker::visitRFCavity().

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalBeamline::compute3DLattice(), and Bend2D::setFieldCalcParam().

◆ getSinAzimuth()

double RFCavity::getSinAzimuth ( ) const

virtual

Definition at line 312 of file RFCavity.cpp.

References sinAngle_m.

Referenced by ParallelCyclotronTracker::checkGapCross(), and ParallelCyclotronTracker::execute().

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 439 of file ElementBase.h.

References getGeometry(), and BGeometryBase::getTotalTransform().

Here is the call graph for this function:

◆ getTransform() [1/2]

Euclid3D ElementBase::getTransform	(	double	fromS,
		double	toS ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 435 of file ElementBase.h.

References getGeometry(), and BGeometryBase::getTransform().

Referenced by TBeamline< T >::getTransform().

Here is the call graph for this function:

◆ getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double s ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 443 of file ElementBase.h.

References getGeometry(), and BGeometryBase::getTransform().

Here is the call graph for this function:

◆ getType()

ElementType RFCavity::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 499 of file RFCavity.cpp.

References RFCAVITY.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 579 of file ElementBase.h.

References getType(), and getTypeString().

Referenced by ParallelCyclotronTracker::execute(), getTypeString(), and OpalBeamline::visit().

Here is the call graph for this function:

◆ getTypeString() [2/2]

std::string ElementBase::getTypeString ( ElementType type )

staticinherited

Definition at line 240 of file ElementBase.cpp.

References elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 467 of file ElementBase.h.

References wake_m.

◆ goOffline()

void RFCavity::goOffline ( )

overridevirtual

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 260 of file RFCavity.cpp.

References filename_m, _Fieldmap::freeMap(), and Component::online_m.

Here is the call graph for this function:

◆ goOnline()

void RFCavity::goOnline ( const double & kineticEnergy )

overridevirtual

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 254 of file RFCavity.cpp.

References filename_m, Component::online_m, and _Fieldmap::readMap().

Here is the call graph for this function:

◆ hasAttribute()

bool ElementBase::hasAttribute ( const std::string & aKey ) const

virtualinherited

Test for existence of an attribute.

Definition at line 200 of file ElementBase.cpp.

References getConstChannel().

Referenced by ParallelCyclotronTracker::visitSolenoid().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 479 of file ElementBase.h.

References bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 487 of file ElementBase.h.

References parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 471 of file ElementBase.h.

References wake_m.

◆ initialise() [1/2]

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

overridevirtual

Implements Component.

Reimplemented in TravelingWave.

Definition at line 167 of file RFCavity.cpp.

References endField_m, endl(), ERRORMSG, fast_m, fieldmap_m, filename_m, frequency_m, _Fieldmap::getFieldmap(), ElementBase::getName(), gmsg, Units::Hz2MHz, level2(), IpplInfo::myNode(), Component::RefPartBunch_m, ElementBase::setElementLength(), startField_m, Physics::two_pi, and _Fieldmap::typeset_msg().

Referenced by TravelingWave::initialise(), and ParallelCyclotronTracker::visitRFCavity().

Here is the call graph for this function:

◆ initialise() [2/2]

void RFCavity::initialise	(	PartBunchBase< double, 3 > *	bunch,
		std::shared_ptr< AbstractTimeDependence >	freq_atd,
		std::shared_ptr< AbstractTimeDependence >	ampl_atd,
		std::shared_ptr< AbstractTimeDependence >	phase_atd )

virtual

set the time dependent models

Definition at line 207 of file RFCavity.cpp.

References angle_m, cosAngle_m, DvDr_m, endl(), filename_m, frequencyName_m, gmsg, num_points_m, Component::RefPartBunch_m, RNormal_m, setAmplitudeModel(), setFrequencyModel(), setPhaseModel(), sinAngle_m, and VrNormal_m.

Here is the call graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 598 of file ElementBase.h.

References elemedgeSet_m.

◆ isInside()

bool RFCavity::isInside ( const Vector_t & r ) const

overridevirtual

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 724 of file RFCavity.cpp.

References fieldmap_m, and ElementBase::isInsideTransverse().

Here is the call graph for this function:

◆ isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t & r ) const

protectedinherited

Definition at line 287 of file ElementBase.cpp.

References aperture_m.

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Undulator::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), isInside(), Monitor::isInside(), Multipole::isInside(), RFCavity::isInside(), Solenoid::isInside(), TravelingWave::isInside(), and FlexibleCollimator::isStopped().

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 556 of file ElementBase.h.

References positionIsFixed.

Referenced by OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 463 of file ElementBase.h.

References shareFlag.

Referenced by copyStructure(), TBeamline< T >::copyStructure(), and Sequence::updateList().

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References refCount.

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 253 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 91 of file Component.cpp.

References online_m.

◆ operator=()

void RFCavity::operator= ( const RFCavity & )

private

References RFCavity().

Here is the call graph for this function:

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 546 of file ElementBase.h.

References positionIsFixed.

Referenced by OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ removeAttribute()

void ElementBase::removeAttribute ( const std::string & aKey )

virtualinherited

Remove an existing attribute.

Definition at line 212 of file ElementBase.cpp.

References userAttribs.

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

◆ setActionRange()

void ElementBase::setActionRange ( const std::queue< std::pair< double, double > > & range )

inlineinherited

Definition at line 561 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

◆ setAmplitudeError()

void RFCavity::setAmplitudeError ( double vPeakError )

inlinevirtual

Definition at line 364 of file RFCavity.h.

References scaleError_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setAmplitudem()

void RFCavity::setAmplitudem ( double vPeak )

inlinevirtual

Definition at line 354 of file RFCavity.h.

References scale_m.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy(), OpalCavity::update(), and OpalTravelingWave::update().

◆ setAmplitudeModel()

void RFCavity::setAmplitudeModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

inline

Definition at line 439 of file RFCavity.h.

References amplitudeTD_m.

Referenced by initialise().

◆ setAmplitudeModelName()

void RFCavity::setAmplitudeModelName ( std::string name )

inline

Definition at line 444 of file RFCavity.h.

References amplitudeName_m, and name.

Referenced by OpalCavity::update().

◆ setAperture()

void ElementBase::setAperture	(	const ApertureType &	type,
		const std::vector< double > &	args )

inlineinherited

Definition at line 519 of file ElementBase.h.

References aperture_m.

Referenced by Component::Component(), Offset::operator=(), OpalElement::update(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), and OpalSlit::update().

◆ setAttribute()

void ElementBase::setAttribute	(	const std::string &	aKey,
		double	val )

virtualinherited

Set value of an attribute.

Definition at line 217 of file ElementBase.cpp.

References getChannel(), and Channel::isSettable().

Referenced by TBeamline< FlaggedElmPtr >::getChannel(), and OpalElement::updateUnknown().

Here is the call graph for this function:

◆ setAutophaseVeto()

void RFCavity::setAutophaseVeto ( bool veto = true )

inlinevirtual

Definition at line 429 of file RFCavity.h.

References autophaseVeto_m.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy(), OpalCavity::update(), OpalTravelingWave::update(), and ParallelTTracker::updateRFElement().

◆ setAzimuth()

void RFCavity::setAzimuth ( double angle )

Definition at line 274 of file RFCavity.cpp.

References angle_m.

Referenced by OpalCavity::update().

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 270 of file ElementBase.cpp.

References bgeometry_m.

Referenced by OpalCavity::update(), OpalCyclotron::update(), and OpalDrift::update().

◆ setCavityType()

void RFCavity::setCavityType ( const std::string & type )

Definition at line 332 of file RFCavity.cpp.

References bmCavityTypeString_s, name, SW, and type_m.

Referenced by OpalCavity::update().

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 491 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

Referenced by OpalElement::update(), OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

◆ setDesignEnergy()

void RFCavity::setDesignEnergy	(	const double &	ekin,
		bool	changeable = true )

inlineoverridevirtual

Reimplemented from Component.

Definition at line 334 of file RFCavity.h.

References designEnergy_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT.

Definition at line 419 of file ElementBase.h.

References getGeometry(), and BGeometryBase::setElementLength().

Referenced by Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), MultipoleT::setElementLength(), SequenceMember::setLength(), OpalCavity::update(), OpalCCollimator::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalOctupole::update(), OpalPepperPot::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), and OpalVKicker::update().

Here is the call graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 583 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References exit_face_slope_m.

◆ setFast()

void RFCavity::setFast ( bool fast )

inlinevirtual

Definition at line 419 of file RFCavity.h.

References fast_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setFieldMapFN()

void RFCavity::setFieldMapFN ( const std::string & fmapfn )

inlinevirtual

Set the name of the field map.

Definition at line 349 of file RFCavity.h.

References filename_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFrequency()

void RFCavity::setFrequency ( double freq )

inline

Definition at line 374 of file RFCavity.h.

References frequency_m.

◆ setFrequencym()

void RFCavity::setFrequencym ( double freq )

inlinevirtual

Definition at line 379 of file RFCavity.h.

References frequency_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setFrequencyModel()

void RFCavity::setFrequencyModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

inline

Definition at line 469 of file RFCavity.h.

References frequencyTD_m.

Referenced by initialise().

◆ setFrequencyModelName()

void RFCavity::setFrequencyModelName ( std::string name )

inline

Definition at line 474 of file RFCavity.h.

References frequencyName_m, and name.

Referenced by OpalCavity::update().

◆ setGapWidth()

void RFCavity::setGapWidth ( double gapwidth )

Definition at line 282 of file RFCavity.cpp.

References gapwidth_m.

Referenced by OpalCavity::update().

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 536 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

◆ setName()

void ElementBase::setName ( const std::string & name )

virtualinherited

Set element name.

Definition at line 167 of file ElementBase.cpp.

References elementID, and name.

Referenced by Sequence::insertDrifts(), Offset::operator=(), and VariableRFCavity::operator=().

◆ setOutputFN()

void ElementBase::setOutputFN ( std::string fn )

inherited

Set output filename.

Definition at line 172 of file ElementBase.cpp.

References outputfn_m.

Referenced by OpalCCollimator::update(), OpalCyclotron::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalMonitor::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalProbe::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSlit::update(), OpalSource::update(), and OpalStripper::update().

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 274 of file ElementBase.cpp.

References parmatint_m.

Referenced by OpalCCollimator::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRBend::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), and OpalVacuum::update().

◆ setPerpenDistance()

void RFCavity::setPerpenDistance ( double pdis )

Definition at line 278 of file RFCavity.cpp.

References pdis_m.

Referenced by OpalCavity::update().

◆ setPhaseError()

void RFCavity::setPhaseError ( double phaseError )

inlinevirtual

Definition at line 404 of file RFCavity.h.

References phaseError_m.

Referenced by OpalCavity::update(), and OpalTravelingWave::update().

◆ setPhasem()

void RFCavity::setPhasem ( double phase )

inlinevirtual

Reimplemented in TravelingWave.

Definition at line 389 of file RFCavity.h.

References phase_m.

Referenced by getAutoPhaseEstimateFallback(), CavityAutophaser::getPhaseAtMaxEnergy(), CavityAutophaser::track(), OpalCavity::update(), and ParallelTTracker::updateRFElement().

◆ setPhaseModel()

void RFCavity::setPhaseModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

inline

Definition at line 454 of file RFCavity.h.

References phaseTD_m.

Referenced by initialise().

◆ setPhaseModelName()

void RFCavity::setPhaseModelName ( std::string name )

inline

Definition at line 459 of file RFCavity.h.

References name, and phaseName_m.

Referenced by OpalCavity::update().

◆ setPhi0()

void RFCavity::setPhi0 ( double phi0 )

Definition at line 286 of file RFCavity.cpp.

References phi0_m.

Referenced by OpalCavity::update().

◆ setRmax()

void RFCavity::setRmax ( double rmax )

Definition at line 270 of file RFCavity.cpp.

References rmax_m.

Referenced by OpalCavity::update().

◆ setRmin()

void RFCavity::setRmin ( double rmin )

Definition at line 266 of file RFCavity.cpp.

References rmin_m.

Referenced by OpalCavity::update().

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 569 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 266 of file ElementBase.cpp.

References wake_m.

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), OpalSeptum::update(), and OpalTravelingWave::update().

◆ spline()

double RFCavity::spline	(	double	z,
		double *	za )

Definition at line 433 of file RFCavity.cpp.

References DvDr_m, num_points_m, RNormal_m, and VrNormal_m.

Referenced by getMomentaKick().

◆ trackBunch()

void Component::trackBunch	(	PartBunchBase< double, 3 > *	bunch,
		const PartData &	,
		bool	revBeam,
		bool	revTrack ) const

virtualinherited

Track particle bunch.

Definition at line 71 of file Component.cpp.

References ElementBase::getName().

Referenced by Tracker::visitComponent().

Here is the call graph for this function:

◆ trackMap()

void Component::trackMap	(	FVps< double, 6 > &	map,
		const PartData &	,
		bool	revBeam,
		bool	revTrack ) const

virtualinherited

Track a map.

Definition at line 77 of file Component.cpp.

References ElementBase::getName().

Here is the call graph for this function:

◆ trackOnAxisParticle()

std::pair< double, double > RFCavity::trackOnAxisParticle	(	const double &	p0,
		const double &	t0,
		const double &	dt,
		const double &	q,
		const double &	mass,
		std::ofstream *	out = nullptr )

virtual

Definition at line 675 of file RFCavity.cpp.

References applyToReferenceParticle(), Physics::c, dot(), getElementLength(), Util::getGamma(), Util::getKineticEnergy(), BorisPusher::kick(), BorisPusher::push(), Component::RefPartBunch_m, and startField_m.

Referenced by getAutoPhaseEstimateFallback(), and CavityAutophaser::track().

Here is the call graph for this function:

◆ update()

bool ElementBase::update ( const AttributeSet & set )

inherited

Update element.

Definition at line 258 of file ElementBase.cpp.

Referenced by Monitor::driftToCorrectPositionAndSave().

Member Data Documentation

◆ actionRange_m

std::queue<std::pair<double, double> > ElementBase::actionRange_m

privateinherited

Definition at line 399 of file ElementBase.h.

Referenced by setActionRange().

◆ amplitudeName_m

std::string RFCavity::amplitudeName_m

protected

Definition at line 200 of file RFCavity.h.

Referenced by getAmplitudeModelName(), RFCavity(), and setAmplitudeModelName().

◆ amplitudeTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::amplitudeTD_m

protected

Definition at line 199 of file RFCavity.h.

Referenced by RFCavity(), RFCavity(), and setAmplitudeModel().

◆ angle_m

double RFCavity::angle_m

private

Definition at line 229 of file RFCavity.h.

Referenced by getAzimuth(), initialise(), RFCavity(), RFCavity(), and setAzimuth().

◆ aperture_m

std::pair<ApertureType, std::vector<double> > ElementBase::aperture_m

protectedinherited

Definition at line 369 of file ElementBase.h.

Referenced by ElementBase(), getAperture(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), isInsideTransverse(), setAperture(), Bend2D::setFieldCalcParam(), Bend2D::setupBendGeometry(), and Bend2D::setupFringeWidths().

◆ autophaseVeto_m

bool RFCavity::autophaseVeto_m

protected

Definition at line 213 of file RFCavity.h.

Referenced by getAutophaseVeto(), RFCavity(), RFCavity(), and setAutophaseVeto().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

Referenced by ElementBase(), getBoundaryGeometry(), hasBoundaryGeometry(), and setBoundaryGeometry().

◆ bmCavityTypeString_s

const boost::bimap< CavityType, std::string > RFCavity::bmCavityTypeString_s

staticprivate

Initial value:

=
    boost::assign::list_of<const boost::bimap<CavityType, std::string>::relation>
        (CavityType::SW,   "STANDING")
        (CavityType::SGSW, "SINGLEGAP")

Definition at line 225 of file RFCavity.h.

Referenced by getCavityTypeString(), and setCavityType().

◆ cosAngle_m

double RFCavity::cosAngle_m

private

Definition at line 231 of file RFCavity.h.

Referenced by getCosAzimuth(), getMomentaKick(), initialise(), RFCavity(), and RFCavity().

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 366 of file ElementBase.h.

Referenced by Monitor::applyToReferenceParticle(), ElementBase(), Bend2D::getBoundingBoxInLabCoords(), getBoundingBoxInLabCoords(), getCSTrafoGlobal2Local(), and setCSTrafoGlobal2Local().

◆ defaultAperture_m

const std::vector< double > Component::defaultAperture_m

staticprotectedinherited

Initial value:

=

std::vector<double>({1e6, 1e6, 1.0})

Definition at line 187 of file Component.h.

Referenced by Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 403 of file ElementBase.h.

Referenced by ElementBase(), getFlagDeleteOnTransverseExit(), and setFlagDeleteOnTransverseExit().

◆ designEnergy_m

double RFCavity::designEnergy_m

protected

Definition at line 215 of file RFCavity.h.

Referenced by getDesignEnergy(), RFCavity(), RFCavity(), and setDesignEnergy().

◆ DvDr_m

std::unique_ptr<double[]> RFCavity::DvDr_m

private

Definition at line 238 of file RFCavity.h.

Referenced by initialise(), RFCavity(), RFCavity(), and spline().

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 397 of file ElementBase.h.

Referenced by ElementBase(), getElementPosition(), isElementPositionSet(), and setElementPosition().

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 371 of file ElementBase.h.

Referenced by ElementBase(), Bend2D::getEffectiveCenter(), Bend2D::initialise(), Bend2D::print(), setActionRange(), and Bend2D::setupBendGeometry().

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 381 of file ElementBase.h.

Referenced by ElementBase(), getName(), and setName().

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 396 of file ElementBase.h.

Referenced by ElementBase(), getElementPosition(), and setElementPosition().

◆ elementTypeToString_s

const std::map< ElementType, std::string > ElementBase::elementTypeToString_s

staticprivateinherited

Definition at line 71 of file ElementBase.h.

Referenced by getTypeString().

◆ endField_m

double RFCavity::endField_m

private

Definition at line 221 of file RFCavity.h.

Referenced by getDimensions(), initialise(), RFCavity(), and RFCavity().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 189 of file Component.h.

Referenced by Component(), Component(), and setExitFaceSlope().

◆ fast_m

bool RFCavity::fast_m

protected

Definition at line 212 of file RFCavity.h.

Referenced by getFast(), initialise(), RFCavity(), RFCavity(), and setFast().

◆ fieldmap_m

Fieldmap RFCavity::fieldmap_m

protected

Definition at line 217 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), applyToReferenceParticle(), TravelingWave::applyToReferenceParticle(), dropFieldmaps(), getAutoPhaseEstimate(), TravelingWave::getAutoPhaseEstimate(), getElementDimensions(), getElementLength(), initialise(), isInside(), RFCavity(), and RFCavity().

◆ filename_m

std::string RFCavity::filename_m

protected

The name of the inputfile

Definition at line 204 of file RFCavity.h.

Referenced by getFieldMapFN(), goOffline(), TravelingWave::goOffline(), goOnline(), TravelingWave::goOnline(), initialise(), initialise(), RFCavity(), RFCavity(), and setFieldMapFN().

◆ frequency_m

double RFCavity::frequency_m

protected

Read in frequency of time varying field(Hz)

Definition at line 210 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), applyToReferenceParticle(), TravelingWave::applyToReferenceParticle(), getAutoPhaseEstimate(), TravelingWave::getAutoPhaseEstimate(), getCycFrequency(), TravelingWave::getdA(), TravelingWave::getdB(), TravelingWave::getdE(), getFrequencym(), getMomentaKick(), getPhasem(), initialise(), RFCavity(), RFCavity(), setFrequency(), and setFrequencym().

◆ frequencyName_m

std::string RFCavity::frequencyName_m

protected

Definition at line 202 of file RFCavity.h.

Referenced by getFrequencyModelName(), initialise(), RFCavity(), and setFrequencyModelName().

◆ frequencyTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::frequencyTD_m

protected

Definition at line 201 of file RFCavity.h.

Referenced by getMomentaKick(), RFCavity(), RFCavity(), and setFrequencyModel().

◆ gapwidth_m

double RFCavity::gapwidth_m

private

Definition at line 233 of file RFCavity.h.

Referenced by getGapWidth(), getMomentaKick(), RFCavity(), RFCavity(), and setGapWidth().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 367 of file ElementBase.h.

Referenced by ElementBase(), getMisalignment(), and setMisalignment().

◆ num_points_m

int RFCavity::num_points_m

private

Definition at line 239 of file RFCavity.h.

Referenced by initialise(), RFCavity(), RFCavity(), and spline().

◆ online_m

bool Component::online_m

protectedinherited

Definition at line 192 of file Component.h.

Referenced by Monitor::apply(), Source::apply(), Component(), Component(), Probe::doGoOffline(), Bend2D::finalise(), Cyclotron::finalise(), FlexibleCollimator::finalise(), Multipole::finalise(), PluginElement::finalise(), Ring::finalise(), Vacuum::finalise(), goOffline(), Degrader::goOffline(), FlexibleCollimator::goOffline(), PluginElement::goOffline(), RBend3D::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Source::goOffline(), Vacuum::goOffline(), Bend2D::goOnline(), CCollimator::goOnline(), goOnline(), Corrector::goOnline(), Degrader::goOnline(), FlexibleCollimator::goOnline(), Monitor::goOnline(), RBend3D::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), Source::goOnline(), TravelingWave::goOnline(), Vacuum::goOnline(), Cyclotron::initialise(), Multipole::initialise(), Ring::initialise(), Septum::initialise(), Online(), Degrader::~Degrader(), FlexibleCollimator::~FlexibleCollimator(), and Vacuum::~Vacuum().

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 401 of file ElementBase.h.

Referenced by ElementBase(), getOutputFN(), and setOutputFN().

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 392 of file ElementBase.h.

Referenced by ElementBase(), getParticleMatterInteraction(), hasParticleMatterInteraction(), and setParticleMatterInteraction().

◆ pdis_m

double RFCavity::pdis_m

private

Definition at line 232 of file RFCavity.h.

Referenced by getPerpenDistance(), RFCavity(), RFCavity(), and setPerpenDistance().

◆ phase_m

double RFCavity::phase_m

protected

phase shift of time varying field (rad)

Definition at line 208 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), applyToReferenceParticle(), TravelingWave::applyToReferenceParticle(), TravelingWave::getAutoPhaseEstimate(), getPhasem(), getPhasem(), TravelingWave::initialise(), RFCavity(), RFCavity(), setPhasem(), and TravelingWave::setPhasem().

◆ phaseError_m

double RFCavity::phaseError_m

protected

phase shift error (rad)

Definition at line 209 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), getPhaseError(), RFCavity(), RFCavity(), and setPhaseError().

◆ phaseName_m

std::string RFCavity::phaseName_m

protected

Definition at line 198 of file RFCavity.h.

Referenced by getPhaseModelName(), RFCavity(), and setPhaseModelName().

◆ phaseTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::phaseTD_m

protected

Definition at line 197 of file RFCavity.h.

Referenced by RFCavity(), RFCavity(), and setPhaseModel().

◆ phi0_m

double RFCavity::phi0_m

private

Definition at line 234 of file RFCavity.h.

Referenced by getMomentaKick(), getPhi0(), RFCavity(), RFCavity(), and setPhi0().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

Referenced by ElementBase(), fixPosition(), isPositioned(), releasePosition(), and setCSTrafoGlobal2Local().

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().

◆ RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

Referenced by Bend2D::apply(), Corrector::apply(), Corrector::apply(), Cyclotron::apply(), Degrader::apply(), FlexibleCollimator::apply(), Monitor::apply(), Multipole::apply(), MultipoleT::apply(), RBend3D::apply(), RFCavity::apply(), SBend3D::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), Source::apply(), TravelingWave::apply(), Undulator::apply(), VariableRFCavity::apply(), VariableRFCavityFringeField::apply(), VerticalFFAMagnet::apply(), Degrader::applyToReferenceParticle(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Component(), Component(), Monitor::driftToCorrectPositionAndSave(), MultipoleT::finalise(), Offset::finalise(), SBend3D::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), VerticalFFAMagnet::finalise(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), Corrector::goOnline(), Degrader::goOnline(), Corrector::initialise(), Cyclotron::initialise(), Cyclotron::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), Offset::initialise(), PluginElement::initialise(), RBend3D::initialise(), RFCavity::initialise(), RFCavity::initialise(), SBend3D::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), Source::initialise(), TravelingWave::initialise(), Undulator::initialise(), Vacuum::initialise(), VariableRFCavity::initialise(), VerticalFFAMagnet::initialise(), VariableRFCavity::initNull(), Multipole::isFocusing(), MultipoleT::MultipoleT(), CCollimator::print(), FlexibleCollimator::print(), SBend3D::SBend3D(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), Bend2D::setupPusher(), RFCavity::trackOnAxisParticle(), RBend3D::trackRefParticleThrough(), Vacuum::updateParticleAttributes(), and VerticalFFAMagnet::VerticalFFAMagnet().

◆ rmax_m

double RFCavity::rmax_m

private

Definition at line 228 of file RFCavity.h.

Referenced by getMomentaKick(), getRmax(), RFCavity(), RFCavity(), and setRmax().

◆ rmin_m

double RFCavity::rmin_m

private

Definition at line 227 of file RFCavity.h.

Referenced by getMomentaKick(), getRmax(), getRmin(), RFCavity(), RFCavity(), and setRmin().

◆ RNormal_m

std::unique_ptr<double[]> RFCavity::RNormal_m

private

Definition at line 236 of file RFCavity.h.

Referenced by initialise(), RFCavity(), RFCavity(), and spline().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 373 of file ElementBase.h.

Referenced by ElementBase(), Bend2D::findIdealBendParameters(), getRotationAboutZ(), RBend3D::initialise(), Bend2D::print(), and setRotationAboutZ().

◆ scale_m

double RFCavity::scale_m

protected

scale multiplier

Definition at line 206 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), applyToReferenceParticle(), TravelingWave::applyToReferenceParticle(), getAmplitudem(), getAutoPhaseEstimate(), TravelingWave::getAutoPhaseEstimate(), getMomentaKick(), TravelingWave::initialise(), RFCavity(), RFCavity(), and setAmplitudem().

◆ scaleError_m

double RFCavity::scaleError_m

protected

additive scale error

Definition at line 207 of file RFCavity.h.

Referenced by apply(), TravelingWave::apply(), getAmplitudeError(), TravelingWave::initialise(), RFCavity(), RFCavity(), and setAmplitudeError().

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 364 of file ElementBase.h.

Referenced by Beamline::Beamline(), Beamline::Beamline(), Beamline::Beamline(), ElementBase(), isSharable(), makeSharable(), and TBeamline< T >::makeSharable().

◆ sinAngle_m

double RFCavity::sinAngle_m

private

Definition at line 230 of file RFCavity.h.

Referenced by getMomentaKick(), getSinAzimuth(), initialise(), RFCavity(), and RFCavity().

◆ startField_m

double RFCavity::startField_m

protected

starting point of field(m)

Definition at line 218 of file RFCavity.h.

Referenced by apply(), applyToReferenceParticle(), getDimensions(), getEdgeToBegin(), getEdgeToEnd(), initialise(), TravelingWave::initialise(), RFCavity(), RFCavity(), and trackOnAxisParticle().

◆ type_m

CavityType RFCavity::type_m

private

Definition at line 223 of file RFCavity.h.

Referenced by getCavityType(), getCavityTypeString(), RFCavity(), RFCavity(), and setCavityType().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

Referenced by ElementBase(), getChannel(), and removeAttribute().

◆ VrNormal_m

std::unique_ptr<double[]> RFCavity::VrNormal_m

private

Definition at line 237 of file RFCavity.h.

Referenced by initialise(), RFCavity(), RFCavity(), and spline().

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

Referenced by ElementBase(), getWake(), hasWake(), and setWake().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RFCavity() [1/3]

◆ RFCavity() [2/3]

◆ RFCavity() [3/3]

◆ ~RFCavity()

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ clone()

◆ copyStructure()

◆ dropFieldmaps()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAmplitude()

◆ getAmplitudeError()

◆ getAmplitudem()

◆ getAmplitudeModelName()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getAutoPhaseEstimate()

◆ getAutoPhaseEstimateFallback()

◆ getAutophaseVeto()

◆ getAzimuth()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getCavityType()

◆ getCavityTypeString()

◆ getChannel()

◆ getConstChannel()

◆ getCosAzimuth()

◆ getCSTrafoGlobal2Local()

◆ getCycFrequency()

◆ getdA()

◆ getdB()

◆ getdE()

◆ getDesign()

◆ getDesignEnergy()

◆ getDimensions()

◆ getdT()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getFast()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldMapFN()

◆ getFlagDeleteOnTransverseExit()

◆ getFrequency()

◆ getFrequencym()

◆ getFrequencyModelName()

◆ getGapWidth()

◆ getGeometry() [1/2]