#include <RFCavityRep.h>

Inheritance diagram for RFCavityRep:

Collaboration diagram for RFCavityRep:

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

	RFCavityRep ()

	RFCavityRep (const RFCavityRep &)

virtual	~RFCavityRep ()

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

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

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

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

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

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

virtual double	getAmplitude () const
	Get amplitude. More...

virtual double	getFrequency () const
	Get frequency. More...

virtual double	getPhase () const
	Get phase. More...

virtual void	setAmplitude (double V)
	Set amplitude. More...

virtual void	setFrequency (double f)
	Set frequency. More...

virtual void	setPhase (double phi)
	Set phase. More...

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

void	dropFieldmaps ()

virtual void	setFieldMapFN (const std::string &fmapfn)
	Set the name of the field map. More...

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< double, 3 > &E, Vector_t< double, 3 > &B) override

virtual bool	apply (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override

virtual bool	applyToReferenceParticle (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override

virtual void	initialise (PartBunch_t *bunch, double &startField, double &endField) override

virtual void	initialise (PartBunch_t *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 More...

double	spline (double z, double *za)

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

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

virtual bool	isInside (const Vector_t< double, 3 > &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. More...

virtual void	getElementDimensions (double &begin, double &end) const override

virtual CoordinateSystemTrafo	getEdgeToBegin () const override

virtual CoordinateSystemTrafo	getEdgeToEnd () const override

EVector	Efield (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) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...

virtual bool	getPotential (const Vector_t< double, 3 > &, const double &, Vector_t< double, 3 > &, double &)
	Calculate the four-potential at some position relative to the component. More...

virtual bool	Online ()

virtual const ElementBase &	getDesign () const
	Return design element. More...

virtual void	trackBunch (PartBunch_t *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 &)

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 void	setElementLength (double length)
	Set design length. More...

virtual double	getOrigin () const
	Get origin position. More...

virtual double	getEntrance () const
	Get entrance position. More...

virtual double	getExit () const
	Get exit position. More...

virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...

virtual Euclid3D	getTransform (double s) const
	Get transform. More...

virtual Euclid3D	getTotalTransform () const
	Get transform. More...

virtual Euclid3D	getEntranceFrame () const
	Get transform. More...

virtual Euclid3D	getExitFrame () const
	Get transform. More...

virtual Euclid3D	getEntrancePatch () const
	Get patch. More...

virtual Euclid3D	getExitPatch () const
	Get patch. More...

virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...

virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...

virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...

virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...

virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...

virtual ElementBase *	copyStructure ()
	Make a structural copy. More...

bool	isSharable () const
	Test if the element can be shared. More...

virtual void	makeSharable ()
	Set sharable flag. More...

bool	update (const AttributeSet &)
	Update element. More...

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
	attach a boundary geometry field to the element More...

virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...

virtual bool	hasBoundaryGeometry () const

virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...

virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

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

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

void	setOutputFN (std::string fn)
	Set output filename. More...

std::string	getOutputFN () const
	Get output filename. More...

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...


void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...

double	getElementPosition () const

bool	isElementPositionSet () const

Static Public Member Functions
static void	setIgnore (bool ignore=false)
	Set ignore switch. More...

static std::string	getTypeString (ElementType type)

Protected Member Functions
bool	isInsideTransverse (const Vector_t< double, 3 > &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
	The name of the inputfile. More...

double	scale_m
	scale multiplier More...

double	scaleError_m
	additive scale error More...

double	phase_m
	phase shift of time varying field (rad) More...

double	phaseError_m
	phase shift error (rad) More...

double	frequency_m
	Read in frequency of time varying field(Hz) More...

bool	fast_m

bool	autophaseVeto_m

double	designEnergy_m

Fieldmap *	fieldmap_m

double	startField_m
	starting point of field(m) More...

double	exit_face_slope_m

PartBunch_t *	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 = std::vector<double>({1e6, 1e6, 1.0})

Private Member Functions
void	operator= (const RFCavityRep &)

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

Private Attributes
StraightGeometry	geometry
	The cavity's geometry. More...

AcceleratingField	field
	The cavity's field. More...

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
	The name of the outputfile. More...

bool	deleteOnTransverseExit_m = true

int	refCount


double	elementPosition_m
	ELEMEDGE attribute. More...

bool	elemedgeSet_m

Static Private Attributes
static bool	ignoreCavities = false
	Cavities are ignored (amplitude = 0) when this switch is set. More...

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

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

Detailed Description

Definition at line 26 of file RFCavityRep.h.

Constructor & Destructor Documentation

◆ RFCavityRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 68 of file RFCavityRep.cpp.

◆ RFCavityRep() [2/3]

RFCavityRep::RFCavityRep ( )

Definition at line 57 of file RFCavityRep.cpp.

Referenced by clone().

◆ RFCavityRep() [3/3]

RFCavityRep::RFCavityRep ( const RFCavityRep & right )

Definition at line 62 of file RFCavityRep.cpp.

◆ ~RFCavityRep()

RFCavityRep::~RFCavityRep ( )

virtual

Definition at line 73 of file RFCavityRep.cpp.

Member Function Documentation

◆ accept()

void RFCavity::accept ( BeamlineVisitor & visitor ) const

overridevirtualinherited

Apply visitor to RFCavity.

Implements ElementBase.

Reimplemented in TravelingWave.

Definition at line 116 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 RCObject::refCount.

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

◆ apply() [1/2]

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

overridevirtualinherited

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 120 of file RFCavity.cpp.

References RFCavity::apply(), PartBunch< PLayout, T, Dim >::getParticleContainer(), and Component::RefPartBunch_m.

Referenced by RFCavity::apply().

Here is the call graph for this function:

◆ apply() [2/2]

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

overridevirtualinherited

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 132 of file RFCavity.cpp.

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

Here is the call graph for this function:

◆ applyToReferenceParticle()

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

overridevirtualinherited

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 148 of file RFCavity.cpp.

References RFCavity::fieldmap_m, RFCavity::frequency_m, RFCavity::getElementLength(), Fieldmap::getFieldstrength(), RFCavity::phase_m, RFCavity::scale_m, and RFCavity::startField_m.

Referenced by RFCavity::trackOnAxisParticle().

Here is the call graph for this function:

◆ bends()

bool RFCavity::bends ( ) const

overridevirtualinherited

Implements Component.

Reimplemented in TravelingWave.

Definition at line 246 of file RFCavity.cpp.

◆ Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 196 of file Component.h.

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

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 204 of file Component.h.

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

Here is the call graph for this function:

◆ clone()

ElementBase * RFCavityRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 77 of file RFCavityRep.cpp.

References RFCavityRep().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 204 of file ElementBase.cpp.

References ElementBase::clone(), and ElementBase::isSharable().

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

Here is the call graph for this function:

◆ dropFieldmaps()

void RFCavity::dropFieldmaps ( )

inlineinherited

Definition at line 308 of file RFCavity.h.

References RFCavity::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 208 of file Component.h.

References EMField::EBfield(), and Component::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 212 of file Component.h.

References EMField::EBfield(), and Component::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 192 of file Component.h.

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

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 200 of file Component.h.

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

Here is the call graph for this function:

◆ finalise()

void RFCavity::finalise ( )

overridevirtualinherited

Implements Component.

Reimplemented in TravelingWave.

Definition at line 243 of file RFCavity.cpp.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 521 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalElement::update().

◆ getAmplitude()

double RFCavityRep::getAmplitude ( ) const

virtual

Get amplitude.

Implements RFCavity.

Definition at line 111 of file RFCavityRep.cpp.

References field, ConstEzField::getEz(), and ignoreCavities.

Here is the call graph for this function:

◆ getAmplitudeError()

double RFCavity::getAmplitudeError ( ) const

inlinevirtualinherited

Definition at line 328 of file RFCavity.h.

References RFCavity::scaleError_m.

◆ getAmplitudem()

double RFCavity::getAmplitudem ( ) const

inlinevirtualinherited

Definition at line 320 of file RFCavity.h.

References RFCavity::scale_m.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy().

◆ getAmplitudeModelName()

std::string RFCavity::getAmplitudeModelName ( )

inlineinherited

Definition at line 392 of file RFCavity.h.

References RFCavity::amplitudeName_m.

◆ getAperture()

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

inlineinherited

Definition at line 500 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 392 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getArcLength(), and 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 153 of file ElementBase.cpp.

References ElementBase::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
	)

virtualinherited

Reimplemented in TravelingWave.

Definition at line 530 of file RFCavity.cpp.

References begin(), Physics::c, Units::deg2rad, end(), endl(), RFCavity::fieldmap_m, first(), RFCavity::frequency_m, RFCavity::getAutoPhaseEstimateFallback(), Util::getBetaGamma(), RFCavity::getdA(), RFCavity::getdB(), RFCavity::getdE(), RFCavity::getdT(), Fieldmap::getOnaxisEz(), ippl::Info, matheval::detail::math::isnan(), level2(), Physics::pi, Units::rad2deg, RFCavity::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
	)

virtualinherited

Definition at line 489 of file RFCavity.cpp.

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

Referenced by RFCavity::getAutoPhaseEstimate().

Here is the call graph for this function:

◆ getAutophaseVeto()

bool RFCavity::getAutophaseVeto ( ) const

inlinevirtualinherited

Definition at line 380 of file RFCavity.h.

References RFCavity::autophaseVeto_m.

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

◆ getAzimuth()

double RFCavity::getAzimuth ( ) const

virtualinherited

Definition at line 294 of file RFCavity.cpp.

References RFCavity::angle_m.

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 456 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 272 of file ElementBase.cpp.

References ElementBase::aperture_m, ElementBase::csTrafoGlobal2Local_m, BoundingBox::getBoundingBox(), ElementBase::getEdgeToBegin(), ElementBase::getEdgeToEnd(), and CoordinateSystemTrafo::transformFrom().

Here is the call graph for this function:

◆ getCavityType()

CavityType RFCavity::getCavityType ( ) const

inlineinherited

Definition at line 364 of file RFCavity.h.

References RFCavity::type_m.

◆ getCavityTypeString()

std::string RFCavity::getCavityTypeString ( ) const

inherited

Definition at line 327 of file RFCavity.cpp.

References RFCavity::bmCavityTypeString_s, and RFCavity::type_m.

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 82 of file RFCavityRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 194 of file ElementBase.cpp.

References ElementBase::getChannel().

Referenced by ElementBase::getAttribute(), and ElementBase::hasAttribute().

Here is the call graph for this function:

◆ getCosAzimuth()

double RFCavity::getCosAzimuth ( ) const

virtualinherited

Definition at line 302 of file RFCavity.cpp.

References RFCavity::cosAngle_m.

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 479 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add().

◆ getCycFrequency()

double RFCavity::getCycFrequency ( ) const

virtualinherited

Definition at line 346 of file RFCavity.cpp.

References RFCavity::frequency_m.

◆ getdA()

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

inlineprivateinherited

Definition at line 280 of file RFCavity.h.

Referenced by RFCavity::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

inlineprivateinherited

Definition at line 290 of file RFCavity.h.

Referenced by RFCavity::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

inlineprivateinherited

Definition at line 243 of file RFCavity.h.

Referenced by RFCavity::getAutoPhaseEstimate().

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 52 of file Component.cpp.

◆ getDesignEnergy()

double RFCavity::getDesignEnergy ( ) const

inlineoverridevirtualinherited

Reimplemented from Component.

Definition at line 304 of file RFCavity.h.

References RFCavity::designEnergy_m.

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

◆ getDimensions()

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

overridevirtualinherited

Implements Component.

Reimplemented in TravelingWave.

Definition at line 480 of file RFCavity.cpp.

References RFCavity::endField_m, and RFCavity::startField_m.

◆ getdT()

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

inlineprivateinherited

Definition at line 254 of file RFCavity.h.

References Physics::c.

Referenced by RFCavity::getAutoPhaseEstimate().

◆ getEdgeToBegin()

CoordinateSystemTrafo RFCavity::getEdgeToBegin ( ) const

inlineoverridevirtualinherited

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 420 of file RFCavity.h.

References RFCavity::startField_m.

◆ getEdgeToEnd()

CoordinateSystemTrafo RFCavity::getEdgeToEnd ( ) const

inlineoverridevirtualinherited

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 425 of file RFCavity.h.

References RFCavity::getElementLength(), and RFCavity::startField_m.

Here is the call graph for this function:

◆ getElementDimensions()

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

overridevirtualinherited

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 732 of file RFCavity.cpp.

References begin(), end(), RFCavity::fieldmap_m, and Fieldmap::getFieldDimensions().

Here is the call graph for this function:

◆ getElementLength()

double RFCavity::getElementLength ( ) const

overridevirtualinherited

Get design length.

Reimplemented from ElementBase.

Definition at line 721 of file RFCavity.cpp.

References Physics::e, end(), RFCavity::fieldmap_m, ElementBase::getElementLength(), and Fieldmap::getFieldDimensions().

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

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 553 of file ElementBase.h.

References ElementBase::elemedgeSet_m, ElementBase::elementPosition_m, and ElementBase::getName().

Here is the call graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 408 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntrance().

Here is the call graph for this function:

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 428 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 436 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 412 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExit().

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 432 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 440 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getFast()

bool RFCavity::getFast ( ) const

inlinevirtualinherited

Definition at line 372 of file RFCavity.h.

References RFCavity::fast_m.

◆ getField() [1/2]

AcceleratingField & RFCavityRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 93 of file RFCavityRep.cpp.

References field.

◆ getField() [2/2]

const AcceleratingField & RFCavityRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 97 of file RFCavityRep.cpp.

References field.

◆ getFieldMapFN()

std::string RFCavity::getFieldMapFN ( ) const

virtualinherited

Definition at line 331 of file RFCavity.cpp.

References RFCavity::filename_m.

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by Multipole::apply(), Corrector::apply(), MultipoleTBase::apply(), MultipoleT::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

◆ getFrequency()

double RFCavityRep::getFrequency ( ) const

virtual

Get frequency.

Implements RFCavity.

Definition at line 116 of file RFCavityRep.cpp.

References field, and OscillatingField< Field >::getFrequency().

Here is the call graph for this function:

◆ getFrequencym()

double RFCavity::getFrequencym ( ) const

inlinevirtualinherited

Definition at line 340 of file RFCavity.h.

References RFCavity::frequency_m.

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

◆ getFrequencyModelName()

std::string RFCavity::getFrequencyModelName ( )

inlineinherited

Definition at line 416 of file RFCavity.h.

References RFCavity::frequencyName_m.

◆ getGapWidth()

double RFCavity::getGapWidth ( ) const

virtualinherited

Definition at line 310 of file RFCavity.cpp.

References RFCavity::gapwidth_m.

◆ getGeometry() [1/2]

StraightGeometry & RFCavityRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 102 of file RFCavityRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & RFCavityRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 106 of file RFCavityRep.cpp.

References geometry.

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 513 of file ElementBase.h.

References ElementBase::misalignment_m.

◆ getMisalignment() [2/2]

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

inherited

◆ getMomentaKick()

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

inherited

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 360 of file RFCavity.cpp.

References Physics::c, ippl::Comm, RFCavity::cosAngle_m, Units::deg2rad, endl(), Units::eV2MeV, RFCavity::frequency_m, RFCavity::frequencyTD_m, RFCavity::gapwidth_m, ElementBase::getName(), gmsg, Units::mm2m, Units::MVpm2Vpm, Units::ns2s, RFCavity::phi0_m, Units::rad2deg, RFCavity::rmax_m, RFCavity::rmin_m, RFCavity::scale_m, RFCavity::sinAngle_m, RFCavity::spline(), and Physics::two_pi.

Here is the call graph for this function:

◆ getName()

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

virtualinherited

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 404 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 144 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 464 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ getPerpenDistance()

double RFCavity::getPerpenDistance ( ) const

virtualinherited

Definition at line 306 of file RFCavity.cpp.

References RFCavity::pdis_m.

◆ getPhase()

double RFCavityRep::getPhase ( ) const

virtual

Get phase.

Implements RFCavity.

Definition at line 121 of file RFCavityRep.cpp.

References field, and OscillatingField< Field >::getPhase().

Here is the call graph for this function:

◆ getPhaseError()

double RFCavity::getPhaseError ( ) const

inlinevirtualinherited

Definition at line 360 of file RFCavity.h.

References RFCavity::phaseError_m.

◆ getPhasem() [1/2]

double RFCavity::getPhasem ( ) const

inlinevirtualinherited

Definition at line 348 of file RFCavity.h.

References RFCavity::phase_m.

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

◆ getPhasem() [2/2]

double RFCavity::getPhasem ( double t ) const

inlineinherited

Definition at line 352 of file RFCavity.h.

References RFCavity::frequency_m, and RFCavity::phase_m.

◆ getPhaseModelName()

std::string RFCavity::getPhaseModelName ( )

inlineinherited

Definition at line 404 of file RFCavity.h.

References RFCavity::phaseName_m.

◆ getPhi0()

double RFCavity::getPhi0 ( ) const

virtualinherited

Definition at line 314 of file RFCavity.cpp.

References RFCavity::phi0_m.

◆ getPotential()

virtual bool Component::getPotential	(	const Vector_t< double, 3 > &	,
		const double &	,
		Vector_t< double, 3 > &	,
		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 122 of file Component.h.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, and Monitor.

Definition at line 566 of file ElementBase.h.

◆ getRmax()

double RFCavity::getRmax ( ) const

virtualinherited

Definition at line 290 of file RFCavity.cpp.

References RFCavity::rmax_m.

◆ getRmin()

double RFCavity::getRmin ( ) const

virtualinherited

Definition at line 286 of file RFCavity.cpp.

References RFCavity::rmin_m.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 540 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

◆ getSinAzimuth()

double RFCavity::getSinAzimuth ( ) const

virtualinherited

Definition at line 298 of file RFCavity.cpp.

References RFCavity::sinAngle_m.

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 420 of file ElementBase.h.

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

Referenced by BeamlineGeometry::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 >.

Definition at line 416 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTransform(), and 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 >.

Definition at line 424 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getType()

ElementType RFCavity::getType ( ) const

overridevirtualinherited

Get element type std::string.

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 485 of file RFCavity.cpp.

References RFCAVITY.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 544 of file ElementBase.h.

References ElementBase::getType(), and ElementBase::getTypeString().

Referenced by ElementBase::getTypeString().

Here is the call graph for this function:

◆ getTypeString() [2/2]

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

staticinherited

Definition at line 200 of file ElementBase.cpp.

References ElementBase::elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 448 of file ElementBase.h.

References ElementBase::wake_m.

◆ goOffline()

void RFCavity::goOffline ( )

overridevirtualinherited

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 256 of file RFCavity.cpp.

References RFCavity::filename_m, Fieldmap::freeMap(), and Component::online_m.

Here is the call graph for this function:

◆ goOnline()

void RFCavity::goOnline ( const double & kineticEnergy )

overridevirtualinherited

Reimplemented from Component.

Reimplemented in TravelingWave.

Definition at line 250 of file RFCavity.cpp.

References RFCavity::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 165 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 460 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 468 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 452 of file ElementBase.h.

References ElementBase::wake_m.

◆ initialise() [1/2]

void RFCavity::initialise	(	PartBunch_t *	bunch,
		double &	startField,
		double &	endField
	)

overridevirtualinherited

Implements Component.

Reimplemented in TravelingWave.

Definition at line 164 of file RFCavity.cpp.

References ippl::Comm, RFCavity::endField_m, endl(), ippl::Error, RFCavity::fast_m, RFCavity::fieldmap_m, RFCavity::filename_m, RFCavity::frequency_m, Fieldmap::getFieldDimensions(), Fieldmap::getFieldmap(), Fieldmap::getFrequency(), Fieldmap::getInfo(), ElementBase::getName(), gmsg, Units::Hz2MHz, level2(), Component::RefPartBunch_m, ElementBase::setElementLength(), RFCavity::startField_m, Physics::two_pi, and Fieldmap::typeset_msg().

Referenced by TravelingWave::initialise().

Here is the call graph for this function:

◆ initialise() [2/2]

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

virtualinherited

set the time dependent models

Reimplemented in TravelingWave.

Definition at line 204 of file RFCavity.cpp.

References RFCavity::angle_m, RFCavity::cosAngle_m, Units::deg2rad, RFCavity::DvDr_m, endl(), RFCavity::filename_m, RFCavity::frequencyName_m, PartBunch< PLayout, T, Dim >::getQ(), gmsg, RFCavity::num_points_m, Component::RefPartBunch_m, RFCavity::RNormal_m, RFCavity::setAmplitudeModel(), RFCavity::setFrequencyModel(), RFCavity::setPhaseModel(), RFCavity::sinAngle_m, and RFCavity::VrNormal_m.

Here is the call graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 562 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

◆ isInside()

bool RFCavity::isInside ( const Vector_t< double, 3 > & r ) const

overridevirtualinherited

Reimplemented from ElementBase.

Reimplemented in TravelingWave.

Definition at line 713 of file RFCavity.cpp.

References RFCavity::fieldmap_m, Fieldmap::isInside(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

◆ isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t< double, 3 > & r ) const

protectedinherited

Definition at line 245 of file ElementBase.cpp.

References ElementBase::aperture_m, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, ElementBase::getEdgeToBegin(), ElementBase::getElementLength(), RECTANGULAR, and CoordinateSystemTrafo::transformTo().

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

Here is the call graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 525 of file ElementBase.h.

References ElementBase::positionIsFixed.

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 444 of file ElementBase.h.

References ElementBase::shareFlag.

Referenced by ElementBase::copyStructure(), and Sequence::updateList().

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 212 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 72 of file Component.cpp.

References Component::online_m.

◆ operator=()

void RFCavityRep::operator= ( const RFCavityRep & )

private

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 517 of file ElementBase.h.

References ElementBase::positionIsFixed.

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 176 of file ElementBase.cpp.

References AttributeSet::removeAttribute(), and ElementBase::userAttribs.

Here is the call graph for this function:

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ setActionRange()

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

inlineinherited

Definition at line 529 of file ElementBase.h.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

◆ setAmplitude()

void RFCavityRep::setAmplitude ( double V )

virtual

Set amplitude.

Definition at line 126 of file RFCavityRep.cpp.

References field, and ConstEzField::setEz().

Referenced by OpalCavity::update().

Here is the call graph for this function:

◆ setAmplitudeError()

void RFCavity::setAmplitudeError ( double vPeakError )

inlinevirtualinherited

Definition at line 324 of file RFCavity.h.

References RFCavity::scaleError_m.

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

◆ setAmplitudem()

void RFCavity::setAmplitudem ( double vPeak )

inlinevirtualinherited

Definition at line 316 of file RFCavity.h.

References RFCavity::scale_m.

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

◆ setAmplitudeModel()

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

inlineinherited

Definition at line 384 of file RFCavity.h.

References RFCavity::amplitudeTD_m.

Referenced by RFCavity::initialise().

◆ setAmplitudeModelName()

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

inlineinherited

Definition at line 388 of file RFCavity.h.

References RFCavity::amplitudeName_m.

Referenced by OpalCavity::update().

◆ setAperture()

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

inlineinherited

Definition at line 495 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by Component::Component(), Offset::operator=(), and OpalElement::update().

◆ setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 180 of file ElementBase.cpp.

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

Referenced by ElementBase::update(), and OpalElement::updateUnknown().

Here is the call graph for this function:

◆ setAutophaseVeto()

void RFCavity::setAutophaseVeto ( bool veto = true )

inlinevirtualinherited

Definition at line 376 of file RFCavity.h.

References RFCavity::autophaseVeto_m.

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

◆ setAzimuth()

void RFCavity::setAzimuth ( double angle )

inherited

Definition at line 270 of file RFCavity.cpp.

References RFCavity::angle_m.

Referenced by OpalCavity::update().

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 228 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

◆ setCavityType()

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

inherited

Definition at line 318 of file RFCavity.cpp.

References RFCavity::bmCavityTypeString_s, SW, and RFCavity::type_m.

Referenced by OpalCavity::update().

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 472 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m, and ElementBase::positionIsFixed.

Referenced by OpalElement::update().

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 236 of file ElementBase.cpp.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

◆ setDesignEnergy()

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

inlineoverridevirtualinherited

Reimplemented from Component.

Definition at line 300 of file RFCavity.h.

References RFCavity::designEnergy_m.

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

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Definition at line 400 of file ElementBase.h.

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

Referenced by RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), SequenceMember::setLength(), OpalCavity::update(), OpalMonitor::update(), OpalMultipoleT::update(), OpalProbe::update(), OpalSolenoid::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 548 of file ElementBase.h.

References ElementBase::elemedgeSet_m, and ElementBase::elementPosition_m.

Referenced by OpalElement::update().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 224 of file Component.h.

References Component::exit_face_slope_m.

◆ setFast()

void RFCavity::setFast ( bool fast )

inlinevirtualinherited

Definition at line 368 of file RFCavity.h.

References RFCavity::fast_m.

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

◆ setFieldMapFN()

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

inlinevirtualinherited

Set the name of the field map.

Definition at line 312 of file RFCavity.h.

References RFCavity::filename_m.

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

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 570 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFrequency()

void RFCavityRep::setFrequency ( double f )

virtual

Set frequency.

Definition at line 131 of file RFCavityRep.cpp.

References field, and OscillatingField< Field >::setFrequency().

Referenced by OpalCavity::update().

Here is the call graph for this function:

◆ setFrequencym()

void RFCavity::setFrequencym ( double freq )

inlinevirtualinherited

Definition at line 336 of file RFCavity.h.

References RFCavity::frequency_m.

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

◆ setFrequencyModel()

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

inlineinherited

Definition at line 408 of file RFCavity.h.

References RFCavity::frequencyTD_m.

Referenced by RFCavity::initialise().

◆ setFrequencyModelName()

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

inlineinherited

Definition at line 412 of file RFCavity.h.

References RFCavity::frequencyName_m.

Referenced by OpalCavity::update().

◆ setGapWidth()

void RFCavity::setGapWidth ( double gapwidth )

inherited

Definition at line 278 of file RFCavity.cpp.

References RFCavity::gapwidth_m.

Referenced by OpalCavity::update().

◆ setIgnore()

void RFCavityRep::setIgnore ( bool ignore = false )

static

Set ignore switch.

Definition at line 140 of file RFCavityRep.cpp.

References ignoreCavities.

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 509 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by OpalElement::update().

◆ setName()

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

virtualinherited

Set element name.

Definition at line 136 of file ElementBase.cpp.

References ElementBase::elementID.

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

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 140 of file ElementBase.cpp.

References ElementBase::outputfn_m.

Referenced by OpalMonitor::update(), and OpalProbe::update().

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 232 of file ElementBase.cpp.

References ElementBase::parmatint_m.

◆ setPerpenDistance()

void RFCavity::setPerpenDistance ( double pdis )

inherited

Definition at line 274 of file RFCavity.cpp.

References RFCavity::pdis_m.

Referenced by OpalCavity::update().

◆ setPhase()

void RFCavityRep::setPhase ( double phi )

virtual

Set phase.

Definition at line 136 of file RFCavityRep.cpp.

References field, and OscillatingField< Field >::setPhase().

Referenced by OpalCavity::update().

Here is the call graph for this function:

◆ setPhaseError()

void RFCavity::setPhaseError ( double phaseError )

inlinevirtualinherited

Definition at line 356 of file RFCavity.h.

References RFCavity::phaseError_m.

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

◆ setPhasem()

void RFCavity::setPhasem ( double phase )

inlinevirtualinherited

Reimplemented in TravelingWave.

Definition at line 344 of file RFCavity.h.

References RFCavity::phase_m.

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

◆ setPhaseModel()

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

inlineinherited

Definition at line 396 of file RFCavity.h.

References RFCavity::phaseTD_m.

Referenced by RFCavity::initialise().

◆ setPhaseModelName()

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

inlineinherited

Definition at line 400 of file RFCavity.h.

References RFCavity::phaseName_m.

Referenced by OpalCavity::update().

◆ setPhi0()

void RFCavity::setPhi0 ( double phi0 )

inherited

Definition at line 282 of file RFCavity.cpp.

References RFCavity::phi0_m.

Referenced by OpalCavity::update().

◆ setRmax()

void RFCavity::setRmax ( double rmax )

inherited

Definition at line 266 of file RFCavity.cpp.

References RFCavity::rmax_m.

Referenced by OpalCavity::update().

◆ setRmin()

void RFCavity::setRmin ( double rmin )

inherited

Definition at line 262 of file RFCavity.cpp.

References RFCavity::rmin_m.

Referenced by OpalCavity::update().

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 536 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 224 of file ElementBase.cpp.

References ElementBase::wake_m.

◆ spline()

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

inherited

Definition at line 421 of file RFCavity.cpp.

References RFCavity::DvDr_m, RFCavity::num_points_m, RFCavity::RNormal_m, and RFCavity::VrNormal_m.

Referenced by RFCavity::getMomentaKick().

◆ trackBunch()

void Component::trackBunch	(	PartBunch_t *	bunch,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

virtualinherited

Track particle bunch.

Definition at line 56 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 60 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`
	)

virtualinherited

Definition at line 665 of file RFCavity.cpp.

References RFCavity::applyToReferenceParticle(), Physics::c, dot(), endl(), RFCavity::getElementLength(), Util::getGamma(), Util::getKineticEnergy(), PartBunch< PLayout, T, Dim >::getReference(), BorisPusher::kick(), BorisPusher::push(), Component::RefPartBunch_m, and RFCavity::startField_m.

Referenced by RFCavity::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 216 of file ElementBase.cpp.

References AttributeSet::begin(), AttributeSet::end(), and ElementBase::setAttribute().

Here is the call graph for this function:

Member Data Documentation

◆ actionRange_m

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

privateinherited

Definition at line 382 of file ElementBase.h.

Referenced by ElementBase::setActionRange(), and ElementBase::setCurrentSCoordinate().

◆ amplitudeName_m

std::string RFCavity::amplitudeName_m

protectedinherited

Definition at line 183 of file RFCavity.h.

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

◆ amplitudeTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::amplitudeTD_m

protectedinherited

Definition at line 182 of file RFCavity.h.

Referenced by RFCavity::setAmplitudeModel().

◆ angle_m

double RFCavity::angle_m

privateinherited

Definition at line 212 of file RFCavity.h.

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

◆ aperture_m

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

protectedinherited

Definition at line 353 of file ElementBase.h.

Referenced by ElementBase::getAperture(), ElementBase::getBoundingBoxInLabCoords(), ElementBase::isInsideTransverse(), and ElementBase::setAperture().

◆ autophaseVeto_m

bool RFCavity::autophaseVeto_m

protectedinherited

Definition at line 196 of file RFCavity.h.

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 373 of file ElementBase.h.

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

◆ bmCavityTypeString_s

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

staticprivateinherited

Initial value:

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

Definition at line 208 of file RFCavity.h.

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

◆ cosAngle_m

double RFCavity::cosAngle_m

privateinherited

Definition at line 214 of file RFCavity.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 350 of file ElementBase.h.

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

◆ defaultAperture_m

const std::vector< double > Component::defaultAperture_m = std::vector<double>({1e6, 1e6, 1.0})

staticprotectedinherited

Definition at line 181 of file Component.h.

Referenced by Component::Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ designEnergy_m

double RFCavity::designEnergy_m

protectedinherited

Definition at line 198 of file RFCavity.h.

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

◆ DvDr_m

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

privateinherited

Definition at line 221 of file RFCavity.h.

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

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 380 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 355 of file ElementBase.h.

Referenced by ElementBase::setActionRange(), and ElementBase::setCurrentSCoordinate().

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 364 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 379 of file ElementBase.h.

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

◆ elementTypeToString_s

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

staticprivateinherited

Initial value:

= {
    {ElementType::ANY, "Any"},
    {ElementType::BEAMLINE, "Beamline"},
    {ElementType::DRIFT, "Drift"},
    {ElementType::MARKER, "Marker"},
    {ElementType::MULTIPOLE, "Multipole"},
    {ElementType::RFCAVITY, "RFCavity"},
    {ElementType::TRAVELINGWAVE, "TravelingWave"},
    {ElementType::SBEND, "SBEND"},
    {ElementType::RBEND, "RBEND"},
    {ElementType::RBEND3D, "RBEND3D"},
    {ElementType::RING, "Ring"},
    {ElementType::SOURCE, "SOURCE"},
    {ElementType::SOLENOID, "SOLENOID"},
    {ElementType::PROBE, "Probe"},
    {ElementType::VACUUM, "Vacuum"}}

Definition at line 366 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

◆ endField_m

double RFCavity::endField_m

privateinherited

Definition at line 204 of file RFCavity.h.

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

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 183 of file Component.h.

Referenced by Component::setExitFaceSlope().

◆ fast_m

bool RFCavity::fast_m

protectedinherited

Definition at line 195 of file RFCavity.h.

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

◆ field

AcceleratingField RFCavityRep::field

private

The cavity's field.

Definition at line 102 of file RFCavityRep.h.

Referenced by getAmplitude(), getField(), getFrequency(), getPhase(), setAmplitude(), setFrequency(), and setPhase().

◆ fieldmap_m

Fieldmap* RFCavity::fieldmap_m

protectedinherited

Definition at line 200 of file RFCavity.h.

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

◆ filename_m

std::string RFCavity::filename_m

protectedinherited

The name of the inputfile.

Definition at line 187 of file RFCavity.h.

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

◆ frequency_m

double RFCavity::frequency_m

protectedinherited

Read in frequency of time varying field(Hz)

Definition at line 193 of file RFCavity.h.

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

◆ frequencyName_m

std::string RFCavity::frequencyName_m

protectedinherited

Definition at line 185 of file RFCavity.h.

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

◆ frequencyTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::frequencyTD_m

protectedinherited

Definition at line 184 of file RFCavity.h.

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

◆ gapwidth_m

double RFCavity::gapwidth_m

privateinherited

Definition at line 216 of file RFCavity.h.

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

◆ geometry

StraightGeometry RFCavityRep::geometry

private

The cavity's geometry.

Definition at line 99 of file RFCavityRep.h.

Referenced by getGeometry().

◆ ignoreCavities

bool RFCavityRep::ignoreCavities = false

staticprivate

Cavities are ignored (amplitude = 0) when this switch is set.

Definition at line 105 of file RFCavityRep.h.

Referenced by getAmplitude(), and setIgnore().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 351 of file ElementBase.h.

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

◆ num_points_m

int RFCavity::num_points_m

privateinherited

Definition at line 222 of file RFCavity.h.

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

◆ online_m

bool Component::online_m

protectedinherited

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile.

Definition at line 384 of file ElementBase.h.

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

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 375 of file ElementBase.h.

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

◆ pdis_m

double RFCavity::pdis_m

privateinherited

Definition at line 215 of file RFCavity.h.

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

◆ phase_m

double RFCavity::phase_m

protectedinherited

phase shift of time varying field (rad)

Definition at line 191 of file RFCavity.h.

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

◆ phaseError_m

double RFCavity::phaseError_m

protectedinherited

phase shift error (rad)

Definition at line 192 of file RFCavity.h.

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

◆ phaseName_m

std::string RFCavity::phaseName_m

protectedinherited

Definition at line 181 of file RFCavity.h.

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

◆ phaseTD_m

std::shared_ptr<AbstractTimeDependence> RFCavity::phaseTD_m

protectedinherited

Definition at line 180 of file RFCavity.h.

Referenced by RFCavity::setPhaseModel().

◆ phi0_m

double RFCavity::phi0_m

privateinherited

Definition at line 217 of file RFCavity.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 377 of file ElementBase.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ RefPartBunch_m

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 185 of file Component.h.

Referenced by Corrector::apply(), MultipoleTBase::apply(), VerticalFFAMagnet::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), Ring::apply(), MultipoleTBase::finalise(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), Offset::finalise(), ScalingFFAMagnet::finalise(), Corrector::goOnline(), PluginElement::initialise(), Corrector::initialise(), VerticalFFAMagnet::initialise(), Drift::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleTCurvedConstRadius::initialise(), MultipoleTCurvedVarRadius::initialise(), MultipoleTStraight::initialise(), Offset::initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::initialise(), Multipole::isFocusing(), MultipoleT::MultipoleT(), MultipoleTBase::MultipoleTBase(), MultipoleTCurvedConstRadius::MultipoleTCurvedConstRadius(), MultipoleTCurvedVarRadius::MultipoleTCurvedVarRadius(), MultipoleTStraight::MultipoleTStraight(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), RFCavity::trackOnAxisParticle(), and VerticalFFAMagnet::VerticalFFAMagnet().

◆ rmax_m

double RFCavity::rmax_m

privateinherited

Definition at line 211 of file RFCavity.h.

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

◆ rmin_m

double RFCavity::rmin_m

privateinherited

Definition at line 210 of file RFCavity.h.

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

◆ RNormal_m

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

privateinherited

Definition at line 219 of file RFCavity.h.

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

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 357 of file ElementBase.h.

Referenced by ElementBase::getRotationAboutZ(), and ElementBase::setRotationAboutZ().

◆ scale_m

double RFCavity::scale_m

protectedinherited

scale multiplier

Definition at line 189 of file RFCavity.h.

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

◆ scaleError_m

double RFCavity::scaleError_m

protectedinherited

additive scale error

Definition at line 190 of file RFCavity.h.

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

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 348 of file ElementBase.h.

Referenced by Beamline::Beamline(), ElementBase::isSharable(), and ElementBase::makeSharable().

◆ sinAngle_m

double RFCavity::sinAngle_m

privateinherited

Definition at line 213 of file RFCavity.h.

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

◆ startField_m

double RFCavity::startField_m

protectedinherited

starting point of field(m)

Definition at line 201 of file RFCavity.h.

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

◆ type_m

CavityType RFCavity::type_m

privateinherited

Definition at line 206 of file RFCavity.h.

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 369 of file ElementBase.h.

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

◆ VrNormal_m

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

privateinherited

Definition at line 220 of file RFCavity.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 371 of file ElementBase.h.

Referenced by ElementBase::getWake(), ElementBase::hasWake(), and ElementBase::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

◆ RFCavityRep() [1/3]

◆ RFCavityRep() [2/3]

◆ RFCavityRep() [3/3]

◆ ~RFCavityRep()

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]