Inheritance diagram for TestVariableRFCavity:

Collaboration diagram for TestVariableRFCavity:

Classes
class	TestableFieldSolverCmd

Public Member Functions
	TestVariableRFCavity ()

void	execute () override
	Execute the algorithm on the attached beam line.

void	visitBeamline (const Beamline &) override
	Apply the algorithm to a beam line.

void	visitComponent (const Component &) override
	Apply the algorithm to an arbitrary component.

void	visitConstantEFieldCavity (const ConstantEFieldCavity &) override
	Apply the algorithm to a constant E-field cavity element.

void	visitDrift (const Drift &) override
	Apply the algorithm to a drift space.

void	visitFlaggedElmPtr (const FlaggedElmPtr &) override
	Apply the algorithm to a FlaggedElmPtr.

void	visitLaser (const Laser &) override
	Apply the algorithm to a laser element.

void	visitMarker (const Marker &) override
	Apply the algorithm to a marker.

void	visitMonitor (const Monitor &) override
	Apply the algorithm to a beam position monitor.

void	visitMultipole (const Multipole &) override
	Apply the algorithm to a multipole.

void	visitMultipoleT (const MultipoleT &) override
	Apply the algorithm to an arbitrary multipole.

void	visitRBend (const RBend &) override
	Apply the algorithm to a rectangular bend.

void	visitRFCavity (const RFCavity &) override
	Apply the algorithm to a RF cavity.

void	visitScalingFFAMagnet (const ScalingFFAMagnet &) override

void	visitRing (const Ring &) override
	Apply the algorithm to a Ring element.

void	visitSBend (const SBend &) override
	Apply the algorithm to a sector bend.

void	visitSolenoid (const Solenoid &) override
	Apply the algorithm to a Solenoid element.

void	visitTravelingWave (const TravelingWave &) override
	Apply the algorithm to a traveling wave.

void	visitVerticalFFAMagnet (const VerticalFFAMagnet &) override
	Apply the algorithm to a vertical FFA magnet.

void	visitProbe (const Probe &) override
	Apply the algorithm to a Probe.

void	visitVariableRFCavity (const VariableRFCavity &) override
	Apply the algorithm to a variable RF cavity.

std::shared_ptr< PartBunch_t >	makeBunch (const size_t numParticles)

void	accept (BeamlineVisitor &) const override

ElementBase *	clone () const override

bool	apply (const std::shared_ptr< ParticleContainer_t > &pc) override

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

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

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

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

void	finalise () override

bool	bends () const override

void	getFieldExtend (double &zBegin, double &zEnd) const override

virtual double	getAmplitude (const double time) const

virtual double	getFrequency (const double time) const

virtual double	getPhase (const double time) const

virtual double	getHeight () const

virtual double	getWidth () const

virtual double	getLength () const

virtual void	setHeight (const double fullHeight)

virtual void	setWidth (const double fullWidth)

virtual void	setLength (double length)

virtual std::shared_ptr< AbstractTimeDependence >	getAmplitudeModel () const

virtual std::shared_ptr< AbstractTimeDependence >	getPhaseModel () const

virtual std::shared_ptr< AbstractTimeDependence >	getFrequencyModel () const

virtual void	setAmplitudeModel (std::shared_ptr< AbstractTimeDependence > amplitude_td)

virtual void	setPhaseModel (std::shared_ptr< AbstractTimeDependence > phase_td)

virtual void	setFrequencyModel (std::shared_ptr< AbstractTimeDependence > frequency_td)

virtual void	setAmplitudeName (const std::string &amplitude)

virtual void	setPhaseName (const std::string &phase)

virtual void	setFrequencyName (const std::string &frequency)

StraightGeometry &	getGeometry () override

const StraightGeometry &	getGeometry () const override

void	initialiseTimeDependencies () const

EMField &	getField () override
	Not implemented.

const EMField &	getField () const override
	Not implemented.

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< double, 3 > &, const double &, Vector_t< double, 3 > &, double &)
	Calculate the four-potential at some position relative to the component.

virtual double	getDesignEnergy () const

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

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

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

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

virtual void	trackBunch (PartBunch_t &bunch, const PartData &, bool revBeam, bool revTrack) const
	Track a borrowed particle bunch through a non-standard component.

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 double	getArcLength () const
	Get arc length.

virtual double	getElementLength () const
	Get design length.

virtual void	setElementLength (double length)
	Set design length.

virtual void	getElementDimensions (double &begin, double &end) const
	Return the nominal body extent of the element.

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

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

virtual Port	getEntryPort () const
	Return the entrance port of the canonical local chart.

virtual Port	getBodyPort () const
	Return the body port of the canonical local chart.

virtual Port	getExitPort () const
	Return the exit port of the canonical local chart.

PlacementPose	getPlacementPose () const
	Return the nominal rigid placement transform of the element.

void	setPlacementPose (const PlacementPose &pose)
	Set the nominal rigid placement transform of the element.

Misalignment	getPlacementMisalignment () const
	Return the local nominal-to-actual correction stored for the element.

ElementGeometry	getPlacementGeometry () const
	Return the bridge geometry ports assembled from legacy edge state.

SupportPlacement	getPlacementSupport () const
	Return the support-frame bridge object. The default is the body frame.

PlacedElement	getPlacedElement () const
	Return a placed-element view assembled from the current bridge objects.

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

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

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

void	setMisalignment (const CoordinateSystemTrafo &cst)

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

CoordinateSystemTrafo	getMisalignment () const

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

void	setCurrentSCoordinate (double s)

void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame.

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


void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.

double	getElementPosition () const

bool	isElementPositionSet () const

Static Public Member Functions
static void	SetUpTestSuite ()

static void	TearDownTestSuite ()

static void	testGetSet (VariableRFCavity &cav1, std::shared_ptr< AbstractTimeDependence >(VariableRFCavity::getMethod)() const, void(VariableRFCavity::setMethod)(std::shared_ptr< AbstractTimeDependence >))

static void	testNull (const VariableRFCavity &cav1)

static std::string	getTypeString (ElementType type)

Public Attributes
std::shared_ptr< FieldSolverCmd >	fsCmdBase_m

std::shared_ptr< DataSink >	dataSink_m

Protected Member Functions
void	initNull ()

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

Static Protected Member Functions
static KOKKOS_INLINE_FUNCTION bool	computeField (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, double E0, double integralF, double phi, double halfWidth, double halfHeight, double length)

Protected Attributes
std::shared_ptr< AbstractTimeDependence >	phaseTD_m

std::shared_ptr< AbstractTimeDependence >	amplitudeTD_m

std::shared_ptr< AbstractTimeDependence >	frequencyTD_m

std::string	phaseName_m

std::string	amplitudeName_m

std::string	frequencyName_m

double	halfWidth_m

double	halfHeight_m

double	length_m

StraightGeometry	geometry
	The cavity's geometry.

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


double	elementPosition_m
	ELEMEDGE attribute.

bool	elemedgeSet_m

Static Private Attributes
static const std::map< ElementType, std::string >	elementTypeToString_s

Detailed Description

Definition at line 29 of file TestVariableRFCavity.cpp.

Constructor & Destructor Documentation

◆ TestVariableRFCavity()

TestVariableRFCavity::TestVariableRFCavity ( )

inline

Definition at line 31 of file TestVariableRFCavity.cpp.

Member Function Documentation

◆ accept()

void VariableRFCavity::accept ( BeamlineVisitor & visitor ) const

overridevirtualinherited

Apply visitor to RFCavity.

The RF cavity finds the "time dependence" models by doing a string lookup against a list held by AbstractTimeDependence at accept time.

Implements ElementBase.

Definition at line 171 of file VariableRFCavity.cpp.

References VariableRFCavity::initialiseTimeDependencies(), and BeamlineVisitor::visitVariableRFCavity().

Referenced by TEST_F().

Here is the call graph for this function:

◆ apply() [1/3]

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

overridevirtualinherited

Calculate the field at the position of the i^th particle

Parameters

i	indexes the particle whose field we need
t	the time at which the field is calculated
E	return value with electric field strength
B	return value with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from Component.

Definition at line 113 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m, VariableRFCavity::computeField(), VariableRFCavity::frequencyTD_m, ElementBase::getElementLength(), VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, Units::MHz2Hz, Units::MVpm2Vpm, VariableRFCavity::phaseTD_m, and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ apply() [2/3]

bool VariableRFCavity::apply ( const std::shared_ptr< ParticleContainer_t > & pc )

overridevirtualinherited

Calculate the field for all particles

Reimplemented from Component.

Definition at line 136 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m, VariableRFCavity::computeField(), VariableRFCavity::frequencyTD_m, ElementBase::getElementLength(), PartBunch< T, Dim >::getT(), VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, Units::MHz2Hz, Units::MVpm2Vpm, VariableRFCavity::phaseTD_m, and Component::RefPartBunch_m.

Referenced by VariableRFCavity::applyToReferenceParticle(), TEST_F(), and TEST_F().

Here is the call graph for this function:

◆ apply() [3/3]

bool VariableRFCavity::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

Calculate the field at a given position

Parameters

R	the position at which the field is calculated
P	the momentum (not used)
t	the time at which the field is calculated
E	return value; filled with electric field strength
B	return value; filled with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from Component.

Definition at line 127 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m, VariableRFCavity::computeField(), VariableRFCavity::frequencyTD_m, ElementBase::getElementLength(), VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, Units::MHz2Hz, Units::MVpm2Vpm, and VariableRFCavity::phaseTD_m.

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool VariableRFCavity::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

Calculate the field at a given position. This is identical to "apply".

Parameters

R	the position at which the field is calculated
P	the momentum (not used)
t	the time at which the field is calculated
E	return value; filled with electric field strength
B	return value; filled with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from Component.

Definition at line 156 of file VariableRFCavity.cpp.

References VariableRFCavity::apply().

Here is the call graph for this function:

◆ bends()

bool VariableRFCavity::bends ( ) const

inlineoverridevirtualinherited

Returns: false (cavity does not bend the trajectory)

Implements Component.

Definition at line 121 of file VariableRFCavity.h.

Referenced by TEST_F().

◆ Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 234 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 240 of file Component.h.

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

Here is the call graph for this function:

◆ clone()

ElementBase * VariableRFCavity::clone ( ) const

overridevirtualinherited

Inheritable deepcopy method

Implements ElementBase.

Definition at line 169 of file VariableRFCavity.cpp.

References VariableRFCavity::VariableRFCavity().

Referenced by TEST_F().

Here is the call graph for this function:

◆ computeField()

KOKKOS_INLINE_FUNCTION bool VariableRFCavity::computeField	(	const Vector_t< double, 3 > &	R,
		Vector_t< double, 3 > &	E,
		double	E0,
		double	integralF,
		double	phi,
		double	halfWidth,
		double	halfHeight,
		double	length
	)

staticprotectedinherited

Definition at line 241 of file VariableRFCavity.h.

References Physics::two_pi.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), and VariableRFCavity::apply().

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 194 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:

◆ EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 244 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 246 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 232 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 236 of file Component.h.

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

Here is the call graph for this function:

◆ execute()

void TestVariableRFCavity::execute ( )

inlineoverridevirtual

Execute the algorithm on the attached beam line.

Implements BeamlineVisitor.

Definition at line 53 of file TestVariableRFCavity.cpp.

◆ finalise()

void VariableRFCavity::finalise ( )

overridevirtualinherited

Finalise following tracking

Just sets RefPartBunch_m to nullptr

Implements Component.

Definition at line 167 of file VariableRFCavity.cpp.

References Component::RefPartBunch_m.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 597 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ getAmplitude()

virtual double VariableRFCavity::getAmplitude ( const double time ) const

inlinevirtualinherited

Get the amplitude at a given time

Parameters

time	the time at which the amplitude is calculated

Returns: the RF field gradient.

Definition at line 140 of file VariableRFCavity.h.

References VariableRFCavity::amplitudeTD_m.

Referenced by TEST_F().

◆ getAmplitudeModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getAmplitudeModel ( ) const

virtualinherited

Returns: shared_ptr to the amplitude (field gradient) time dependence

Definition at line 74 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m.

Referenced by TEST_F(), TEST_F(), and testNull().

◆ getAperture()

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

inlineinherited

Definition at line 582 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by MeshGenerator::add(), Solenoid::getSupportEnvelope(), and MeshGenerator::getTransverseSupport().

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 479 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 147 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ getBodyPort()

Port ElementBase::getBodyPort ( ) const

inlinevirtualinherited

Return the body port of the canonical local chart.

The body port \(p_{i,\mathrm{body}}\) is the identity port of the element's canonical local chart. Its rigid transform is therefore the identity element of \(SE(3)\) in the first redesign stage.

Definition at line 547 of file ElementBase.h.

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 513 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 264 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:

◆ getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in LaserRep, RBendRep, SBendRep, DriftRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, and ConstantEFieldCavityRep.

Definition at line 182 of file ElementBase.cpp.

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

Referenced by LaserRep::getChannel(), RBendRep::getChannel(), SBendRep::getChannel(), DriftRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RFCavityRep::getChannel(), SolenoidRep::getChannel(), TravelingWaveRep::getChannel(), ConstantEFieldCavityRep::getChannel(), ElementBase::getConstChannel(), and ElementBase::setAttribute().

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 186 of file ElementBase.cpp.

References ElementBase::getChannel().

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

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 529 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

Referenced by Monitor::driftToCorrectPositionAndSave(), ElementBase::getPlacementPose(), OpalRBend::update(), and OpalSBend::update().

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 33 of file Component.cpp.

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in BendBase, and RFCavity.

Definition at line 254 of file Component.h.

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 533 of file ElementBase.h.

Referenced by ElementBase::getBoundingBoxInLabCoords(), ElementBase::getEntryPort(), and ElementBase::isInsideTransverse().

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 538 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by ElementBase::getBoundingBoxInLabCoords(), and ElementBase::getExitPort().

Here is the call graph for this function:

◆ getElementDimensions()

virtual void ElementBase::getElementDimensions	(	double &	begin,
		double &	end
	)		const

inlinevirtualinherited

Return the nominal body extent of the element.

The first placement redesign stage distinguishes between the nominal body extent and the field-support extent. The body extent is the canonical longitudinal interval of the placed hardware, \([z_\mathrm{body}^{\mathrm{begin}}, z_\mathrm{body}^{\mathrm{end}}]\), and therefore drives ports, placement, and visualization. By default it coincides with the geometry length \([0, L]\) in the local chart.

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 178 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

Reimplemented in MarkerRep, TBeamline< T >, and RFCavity.

Definition at line 481 of file ElementBase.h.

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

Referenced by MeshGenerator::add(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::apply(), Corrector::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::applyToReferenceParticle(), ConstantEFieldCavity::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::getFieldExtend(), BendBase::getFieldExtend(), ConstantEFieldCavity::getFieldExtend(), Drift::getFieldExtend(), Laser::getFieldExtend(), Multipole::getFieldExtend(), MultipoleT::getFieldExtend(), VariableRFCavity::getFieldExtend(), BendBase::getLength(), Corrector::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Multipole::initialise(), ElementBase::isInside(), BendBase::isInside(), Monitor::isInside(), Multipole::isInside(), ElementBase::isInsideTransverse(), and TEST_F().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 618 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 487 of file ElementBase.h.

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

Referenced by BendBase::getDesignPath(), and 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 499 of file ElementBase.h.

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

Referenced by BendBase::getChordLength(), BendBase::getEdgeToBegin(), and BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 503 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntryPort()

Port ElementBase::getEntryPort ( ) const

inlinevirtualinherited

Return the entrance port of the canonical local chart.

In the placement-note language, this is the marked entrance port \(p_{i,\mathrm{entry}}\) of element \(i\). For straight elements in the bridge stage, the body-to-entry transform is taken from the legacy getEdgeToBegin() result.

Definition at line 545 of file ElementBase.h.

References ElementBase::getEdgeToBegin().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 489 of file ElementBase.h.

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

Referenced by BendBase::getDesignPath(), and 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 501 of file ElementBase.h.

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

Referenced by BendBase::getChordLength(), BendBase::getEdgeToEnd(), and BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 505 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExitPort()

Port ElementBase::getExitPort ( ) const

inlinevirtualinherited

Return the exit port of the canonical local chart.

In the placement-note language, this is the marked exit port \(p_{i,\mathrm{exit}}\). For straight elements in the bridge stage, the body-to-exit transform is taken from the legacy getEdgeToEnd() result.

Definition at line 549 of file ElementBase.h.

References ElementBase::getEdgeToEnd().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

◆ getField() [1/2]

const EMField & VariableRFCavity::getField ( ) const

overridevirtualinherited

Not implemented.

Implements Component.

Definition at line 108 of file VariableRFCavity.cpp.

◆ getField() [2/2]

EMField & VariableRFCavity::getField ( )

overridevirtualinherited

Not implemented.

Implements Component.

Definition at line 104 of file VariableRFCavity.cpp.

Referenced by TEST_F().

◆ getFieldExtend()

void VariableRFCavity::getFieldExtend	(	double &	zBegin,
		double &	zEnd
	)		const

inlineoverridevirtualinherited

Return the longitudinal field-support extent.

For a VariableRFCavity the field support coincides with the nominal body extent, i.e. the interval latexmath:[z \in [0, L)] in the local element frame.

Implements Component.

Definition at line 129 of file VariableRFCavity.h.

References ElementBase::getElementLength().

Referenced by TEST_F().

Here is the call graph for this function:

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 634 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Corrector::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

◆ getFrequency()

virtual double VariableRFCavity::getFrequency ( const double time ) const

inlinevirtualinherited

Get the frequency at a given time

Parameters

time	the time at which the frequency is calculated

Returns: the RF cavity frequency.

Definition at line 148 of file VariableRFCavity.h.

References VariableRFCavity::frequencyTD_m.

Referenced by TEST_F().

◆ getFrequencyModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getFrequencyModel ( ) const

virtualinherited

Returns: shared_ptr to the frequency

Definition at line 82 of file VariableRFCavity.cpp.

References VariableRFCavity::frequencyTD_m.

Referenced by TEST_F(), TEST_F(), and testNull().

◆ getGeometry() [1/2]

const StraightGeometry & VariableRFCavity::getGeometry ( ) const

overridevirtualinherited

Returns: the cavity geometry

Implements ElementBase.

Definition at line 102 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry.

◆ getGeometry() [2/2]

StraightGeometry & VariableRFCavity::getGeometry ( )

overridevirtualinherited

Set the cavity geometry

Implements ElementBase.

Definition at line 100 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry.

Referenced by TEST_F().

◆ getHeight()

virtual double VariableRFCavity::getHeight ( ) const

inlinevirtualinherited

Returns: the full height of the cavity

Definition at line 159 of file VariableRFCavity.h.

References VariableRFCavity::halfHeight_m.

Referenced by TEST_F().

◆ getLength()

virtual double VariableRFCavity::getLength ( ) const

inlinevirtualinherited

Returns: the length of the cavity

Definition at line 163 of file VariableRFCavity.h.

References VariableRFCavity::length_m.

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and testNull().

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 593 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by ElementBase::getPlacementMisalignment().

◆ getMisalignment() [2/2]

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

inherited

◆ getName()

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

virtualinherited

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 485 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 138 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 517 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ getPhase()

virtual double VariableRFCavity::getPhase ( const double time ) const

inlinevirtualinherited

Get the phase at a given time

Parameters

time	the time at which the phase is calculated

Returns: the RF cavity phase.

Definition at line 156 of file VariableRFCavity.h.

References VariableRFCavity::phaseTD_m.

Referenced by TEST_F().

◆ getPhaseModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getPhaseModel ( ) const

virtualinherited

Returns: shared_ptr to the phase time dependence

Definition at line 78 of file VariableRFCavity.cpp.

References VariableRFCavity::phaseTD_m.

Referenced by TEST_F(), TEST_F(), and testNull().

◆ getPlacedElement()

PlacedElement ElementBase::getPlacedElement ( ) const

inlineinherited

Return a placed-element view assembled from the current bridge objects.

Definition at line 571 of file ElementBase.h.

References ElementBase::getPlacementGeometry(), ElementBase::getPlacementMisalignment(), ElementBase::getPlacementPose(), and ElementBase::getPlacementSupport().

Referenced by MeshGenerator::add(), and TEST_F().

Here is the call graph for this function:

◆ getPlacementGeometry()

ElementGeometry ElementBase::getPlacementGeometry ( ) const

inlineinherited

Return the bridge geometry ports assembled from legacy edge state.

The first redesign stage defines a minimal explicit port contract with three named body-relative ports: \(p_{i,\mathrm{entry}}\), \(p_{i,\mathrm{body}}\), \(p_{i,\mathrm{exit}}\). The default bridge preserves current OPALX behavior by deriving those ports from getEntryPort(), getBodyPort(), and getExitPort(), whose straight-element implementations are backed by the legacy getEdgeToBegin() and getEdgeToEnd() methods.

Definition at line 563 of file ElementBase.h.

References ElementBase::getBodyPort(), ElementBase::getEntryPort(), and ElementBase::getExitPort().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

◆ getPlacementMisalignment()

Misalignment ElementBase::getPlacementMisalignment ( ) const

inlineinherited

Return the local nominal-to-actual correction stored for the element.

Definition at line 559 of file ElementBase.h.

References ElementBase::getMisalignment().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

◆ getPlacementPose()

PlacementPose ElementBase::getPlacementPose ( ) const

inlineinherited

Return the nominal rigid placement transform of the element.

This is the bridge from the legacy stored CoordinateSystemTrafo to the new placement vocabulary. It preserves current nominal placement semantics and does not apply misalignment.

Definition at line 551 of file ElementBase.h.

References ElementBase::getCSTrafoGlobal2Local().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

◆ getPlacementSupport()

SupportPlacement ElementBase::getPlacementSupport ( ) const

inlineinherited

Return the support-frame bridge object. The default is the body frame.

Definition at line 567 of file ElementBase.h.

Referenced by ElementBase::getPlacedElement().

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

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in BendBase, Drift, Laser, Marker, and Monitor.

Definition at line 628 of file ElementBase.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 609 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 495 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 491 of file ElementBase.h.

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

Referenced by BendBase::getDesignPath(), BeamlineGeometry::getTransform(), TBeamline< T >::getTransform(), and BeamlineGeometry::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 497 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getType()

ElementType Component::getType ( ) const

virtualinherited

Get element type std::string.

Implements ElementBase.

Reimplemented in Corrector, ConstantEFieldCavity, Drift, Laser, Marker, Monitor, Multipole, Probe, RBend, RFCavity, SBend, Solenoid, and TravelingWave.

Definition at line 49 of file Component.cpp.

References ANY.

Referenced by ParallelTracker::visitComponent().

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 611 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 192 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 509 of file ElementBase.h.

References ElementBase::wake_m.

◆ getWidth()

virtual double VariableRFCavity::getWidth ( ) const

inlinevirtualinherited

Returns: the full width of the cavity

Definition at line 161 of file VariableRFCavity.h.

References VariableRFCavity::halfWidth_m.

Referenced by TEST_F().

◆ goOffline()

void Component::goOffline ( )

virtualinherited

Reimplemented in PluginElement, Monitor, RFCavity, Solenoid, and TravelingWave.

Definition at line 45 of file Component.cpp.

References Component::online_m.

◆ goOnline()

void Component::goOnline ( const double & kineticEnergy )

virtualinherited

Reimplemented in Corrector, Monitor, RFCavity, Solenoid, and TravelingWave.

Definition at line 43 of file Component.cpp.

References Component::online_m.

Referenced by PluginElement::initialise().

◆ hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 159 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 515 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 521 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 511 of file ElementBase.h.

References ElementBase::wake_m.

◆ initialise()

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

overridevirtualinherited

Initialise ready for tracking

Just sets RefPartBunch_m

Implements Component.

Definition at line 162 of file VariableRFCavity.cpp.

References Component::RefPartBunch_m.

◆ initialiseTimeDependencies()

void VariableRFCavity::initialiseTimeDependencies ( ) const

inherited

Lookup the time dependencies and update.

Throws if the named time dependencies can't be found. Also throws if the width or height is < 1 nm

Definition at line 176 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeName_m, VariableRFCavity::amplitudeTD_m, VariableRFCavity::frequencyName_m, VariableRFCavity::frequencyTD_m, AbstractTimeDependence::getTimeDependence(), VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, VariableRFCavity::phaseName_m, and VariableRFCavity::phaseTD_m.

Referenced by VariableRFCavity::accept().

Here is the call graph for this function:

◆ initNull()

void VariableRFCavity::initNull ( )

protectedinherited

Definition at line 64 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeName_m, VariableRFCavity::frequencyName_m, VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, VariableRFCavity::length_m, VariableRFCavity::phaseName_m, and Component::RefPartBunch_m.

Referenced by VariableRFCavity::VariableRFCavity(), VariableRFCavity::VariableRFCavity(), and VariableRFCavity::VariableRFCavity().

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 626 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

◆ isInside()

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

inlinevirtualinherited

Reimplemented in BendBase, Monitor, Multipole, RFCavity, Solenoid, and TravelingWave.

Definition at line 586 of file ElementBase.h.

References ElementBase::getElementLength(), and ElementBase::isInsideTransverse().

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

◆ isInsideTransverse()

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

protectedinherited

Definition at line 233 of file ElementBase.cpp.

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

Referenced by BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Component::apply(), Corrector::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Component::applyToReferenceParticle(), BendBase::applyToReferenceParticle(), ConstantEFieldCavity::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), ElementBase::isInside(), BendBase::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 599 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 507 of file ElementBase.h.

References ElementBase::shareFlag.

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

◆ makeBunch()

std::shared_ptr< PartBunch_t > TestVariableRFCavity::makeBunch ( const size_t numParticles )

inline

Definition at line 97 of file TestVariableRFCavity.cpp.

References dataSink_m, Beam::find(), and fsCmdBase_m.

Here is the call graph for this function:

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 202 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 47 of file Component.cpp.

References Component::online_m.

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 595 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 170 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ setActionRange()

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

inlineinherited

Definition at line 601 of file ElementBase.h.

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

◆ setAmplitudeModel()

void VariableRFCavity::setAmplitudeModel ( std::shared_ptr< AbstractTimeDependence > amplitude_td )

virtualinherited

Set the amplitude (field gradient) time dependence

Definition at line 86 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m.

Referenced by VariableRFCavity::operator=(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ setAmplitudeName()

virtual void VariableRFCavity::setAmplitudeName ( const std::string & amplitude )

inlinevirtualinherited

Set the amplitude time dependence name

The name is used to find the amplitude model at accept time

Definition at line 189 of file VariableRFCavity.h.

References VariableRFCavity::amplitudeName_m.

Referenced by TEST_F().

◆ setAperture()

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

inlineinherited

Definition at line 577 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 172 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 216 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 523 of file ElementBase.h.

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

Referenced by ElementBase::setPlacementPose(), TEST_F(), OpalElement::update(), OpalRBend::update(), and OpalSBend::update().

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 224 of file ElementBase.cpp.

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

◆ setDesignEnergy()

void Component::setDesignEnergy	(	const double &	energy,
		bool	changeable = `true`
	)

inlinevirtualinherited

Reimplemented in Corrector, RFCavity, and BendBase.

Definition at line 252 of file Component.h.

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT, and ConstantEFieldCavityRep.

Definition at line 483 of file ElementBase.h.

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

Referenced by MultipoleT::setElementLength(), SequenceMember::setLength(), BendBase::setLength(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), OpalCavity::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::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 613 of file ElementBase.h.

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

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and OpalElement::update().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 250 of file Component.h.

References Component::exit_face_slope_m.

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 630 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFrequencyModel()

void VariableRFCavity::setFrequencyModel ( std::shared_ptr< AbstractTimeDependence > frequency_td )

virtualinherited

Set the frequency time dependence

Definition at line 95 of file VariableRFCavity.cpp.

References VariableRFCavity::frequencyTD_m.

Referenced by VariableRFCavity::operator=(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ setFrequencyName()

virtual void VariableRFCavity::setFrequencyName ( const std::string & frequency )

inlinevirtualinherited

Set the frequency time dependence name

The name is used to find the frequency model at accept time

Definition at line 201 of file VariableRFCavity.h.

References VariableRFCavity::frequencyName_m.

Referenced by TEST_F().

◆ setHeight()

virtual void VariableRFCavity::setHeight ( const double fullHeight )

inlinevirtualinherited

Set the full height of the cavity

Definition at line 165 of file VariableRFCavity.h.

References VariableRFCavity::halfHeight_m.

Referenced by TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ setLength()

void VariableRFCavity::setLength ( double length )

virtualinherited

Set the length of the cavity

Definition at line 192 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry, VariableRFCavity::length_m, and StraightGeometry::setElementLength().

Referenced by VariableRFCavity::operator=(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 591 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by TEST_F(), and OpalElement::update().

◆ setName()

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

virtualinherited

Set element name.

Definition at line 134 of file ElementBase.cpp.

References ElementBase::elementID.

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

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 136 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 220 of file ElementBase.cpp.

References ElementBase::parmatint_m.

◆ setPhaseModel()

void VariableRFCavity::setPhaseModel ( std::shared_ptr< AbstractTimeDependence > phase_td )

virtualinherited

Set the phase time dependence

Definition at line 91 of file VariableRFCavity.cpp.

References VariableRFCavity::phaseTD_m.

Referenced by VariableRFCavity::operator=(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ setPhaseName()

virtual void VariableRFCavity::setPhaseName ( const std::string & phase )

inlinevirtualinherited

Set the phase time dependence name

The name is used to find the phase model at accept time

Definition at line 195 of file VariableRFCavity.h.

References VariableRFCavity::phaseName_m.

Referenced by TEST_F().

◆ setPlacementPose()

void ElementBase::setPlacementPose ( const PlacementPose & pose )

inlineinherited

Set the nominal rigid placement transform of the element.

This bridge setter preserves the existing storage model by delegating to setCSTrafoGlobal2Local().

Definition at line 555 of file ElementBase.h.

References PlacementPose::getParentToNominal(), and ElementBase::setCSTrafoGlobal2Local().

Here is the call graph for this function:

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 607 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

◆ SetUpTestSuite()

static void TestVariableRFCavity::SetUpTestSuite ( )

inlinestatic

Definition at line 33 of file TestVariableRFCavity.cpp.

References Options::enableHDF5, OpalData::getInstance(), gmsg, and OpalData::storeInputFn().

Here is the call graph for this function:

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 212 of file ElementBase.cpp.

References ElementBase::wake_m.

◆ setWidth()

virtual void VariableRFCavity::setWidth ( const double fullWidth )

inlinevirtualinherited

Set the full width of the cavity

Definition at line 167 of file VariableRFCavity.h.

References VariableRFCavity::halfWidth_m.

Referenced by TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ TearDownTestSuite()

static void TestVariableRFCavity::TearDownTestSuite ( )

inlinestatic

Definition at line 46 of file TestVariableRFCavity.cpp.

References gmsg.

◆ testGetSet()

static void TestVariableRFCavity::testGetSet	(	VariableRFCavity &	cav1,
		std::shared_ptr< AbstractTimeDependence >(VariableRFCavity::*)() const	getMethod,
		void(VariableRFCavity::*)(std::shared_ptr< AbstractTimeDependence >)	setMethod
	)

inlinestatic

Definition at line 121 of file TestVariableRFCavity.cpp.

◆ testNull()

static void TestVariableRFCavity::testNull ( const VariableRFCavity & cav1 )

inlinestatic

Definition at line 139 of file TestVariableRFCavity.cpp.

References VariableRFCavity::getAmplitudeModel(), VariableRFCavity::getFrequencyModel(), VariableRFCavity::getLength(), and VariableRFCavity::getPhaseModel().

Here is the call graph for this function:

◆ trackBunch()

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

virtualinherited

Track a borrowed particle bunch through a non-standard component.

The default implementation throws a LogicalError.

Parameters

bunch Particle bunch to track. The component does not take ownership.

Definition at line 35 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 39 of file Component.cpp.

References ElementBase::getName().

Here is the call graph for this function:

◆ update()

bool ElementBase::update ( const AttributeSet & set )

inherited

Update element.

Definition at line 204 of file ElementBase.cpp.

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

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

◆ visitBeamline()

void TestVariableRFCavity::visitBeamline ( const Beamline & )

inlineoverridevirtual

Apply the algorithm to a beam line.

Implements BeamlineVisitor.

Definition at line 54 of file TestVariableRFCavity.cpp.

◆ visitComponent()

void TestVariableRFCavity::visitComponent ( const Component & )

inlineoverridevirtual

Apply the algorithm to an arbitrary component.

Implements BeamlineVisitor.

Definition at line 55 of file TestVariableRFCavity.cpp.

◆ visitConstantEFieldCavity()

void TestVariableRFCavity::visitConstantEFieldCavity ( const ConstantEFieldCavity & )

inlineoverridevirtual

Apply the algorithm to a constant E-field cavity element.

Implements BeamlineVisitor.

Definition at line 56 of file TestVariableRFCavity.cpp.

◆ visitDrift()

void TestVariableRFCavity::visitDrift ( const Drift & )

inlineoverridevirtual

Apply the algorithm to a drift space.

Implements BeamlineVisitor.

Definition at line 57 of file TestVariableRFCavity.cpp.

◆ visitFlaggedElmPtr()

void TestVariableRFCavity::visitFlaggedElmPtr ( const FlaggedElmPtr & )

inlineoverridevirtual

Apply the algorithm to a FlaggedElmPtr.

Implements BeamlineVisitor.

Definition at line 58 of file TestVariableRFCavity.cpp.

◆ visitLaser()

void TestVariableRFCavity::visitLaser ( const Laser & )

inlineoverridevirtual

Apply the algorithm to a laser element.

Implements BeamlineVisitor.

Definition at line 59 of file TestVariableRFCavity.cpp.

◆ visitMarker()

void TestVariableRFCavity::visitMarker ( const Marker & )

inlineoverridevirtual

Apply the algorithm to a marker.

Implements BeamlineVisitor.

Definition at line 60 of file TestVariableRFCavity.cpp.

◆ visitMonitor()

void TestVariableRFCavity::visitMonitor ( const Monitor & )

inlineoverridevirtual

Apply the algorithm to a beam position monitor.

Implements BeamlineVisitor.

Definition at line 61 of file TestVariableRFCavity.cpp.

◆ visitMultipole()

void TestVariableRFCavity::visitMultipole ( const Multipole & )

inlineoverridevirtual

Apply the algorithm to a multipole.

Implements BeamlineVisitor.

Definition at line 62 of file TestVariableRFCavity.cpp.

◆ visitMultipoleT()

void TestVariableRFCavity::visitMultipoleT ( const MultipoleT & )

inlineoverridevirtual

Apply the algorithm to an arbitrary multipole.

Implements BeamlineVisitor.

Definition at line 63 of file TestVariableRFCavity.cpp.

◆ visitProbe()

void TestVariableRFCavity::visitProbe ( const Probe & )

inlineoverridevirtual

Apply the algorithm to a Probe.

Implements BeamlineVisitor.

Definition at line 72 of file TestVariableRFCavity.cpp.

◆ visitRBend()

void TestVariableRFCavity::visitRBend ( const RBend & )

inlineoverridevirtual

Apply the algorithm to a rectangular bend.

Implements BeamlineVisitor.

Definition at line 64 of file TestVariableRFCavity.cpp.

◆ visitRFCavity()

void TestVariableRFCavity::visitRFCavity ( const RFCavity & )

inlineoverridevirtual

Apply the algorithm to a RF cavity.

Implements BeamlineVisitor.

Definition at line 65 of file TestVariableRFCavity.cpp.

◆ visitRing()

void TestVariableRFCavity::visitRing ( const Ring & )

inlineoverridevirtual

Apply the algorithm to a Ring element.

Implements BeamlineVisitor.

Definition at line 67 of file TestVariableRFCavity.cpp.

◆ visitSBend()

void TestVariableRFCavity::visitSBend ( const SBend & )

inlineoverridevirtual

Apply the algorithm to a sector bend.

Implements BeamlineVisitor.

Definition at line 68 of file TestVariableRFCavity.cpp.

◆ visitScalingFFAMagnet()

void TestVariableRFCavity::visitScalingFFAMagnet ( const ScalingFFAMagnet & )

inlineoverridevirtual

Implements BeamlineVisitor.

Definition at line 66 of file TestVariableRFCavity.cpp.

◆ visitSolenoid()

void TestVariableRFCavity::visitSolenoid ( const Solenoid & )

inlineoverridevirtual

Apply the algorithm to a Solenoid element.

Implements BeamlineVisitor.

Definition at line 69 of file TestVariableRFCavity.cpp.

◆ visitTravelingWave()

void TestVariableRFCavity::visitTravelingWave ( const TravelingWave & )

inlineoverridevirtual

Apply the algorithm to a traveling wave.

Implements BeamlineVisitor.

Definition at line 70 of file TestVariableRFCavity.cpp.

◆ visitVariableRFCavity()

void TestVariableRFCavity::visitVariableRFCavity ( const VariableRFCavity & )

inlineoverridevirtual

Apply the algorithm to a variable RF cavity.

Implements BeamlineVisitor.

Definition at line 73 of file TestVariableRFCavity.cpp.

◆ visitVerticalFFAMagnet()

void TestVariableRFCavity::visitVerticalFFAMagnet ( const VerticalFFAMagnet & )

inlineoverridevirtual

Apply the algorithm to a vertical FFA magnet.

Implements BeamlineVisitor.

Definition at line 71 of file TestVariableRFCavity.cpp.

Member Data Documentation

◆ actionRange_m

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

privateinherited

Definition at line 469 of file ElementBase.h.

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

◆ amplitudeName_m

std::string VariableRFCavity::amplitudeName_m

protectedinherited

Definition at line 226 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setAmplitudeName().

◆ amplitudeTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::amplitudeTD_m

mutableprotectedinherited

Definition at line 223 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::getAmplitude(), VariableRFCavity::getAmplitudeModel(), VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::operator=(), and VariableRFCavity::setAmplitudeModel().

◆ aperture_m

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

protectedinherited

Definition at line 440 of file ElementBase.h.

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 460 of file ElementBase.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 437 of file ElementBase.h.

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

◆ dataSink_m

std::shared_ptr<DataSink> TestVariableRFCavity::dataSink_m

Definition at line 95 of file TestVariableRFCavity.cpp.

Referenced by makeBunch().

◆ defaultAperture_m

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

staticprotectedinherited

Definition at line 221 of file Component.h.

Referenced by Component::Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 473 of file ElementBase.h.

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

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 467 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 442 of file ElementBase.h.

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

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 451 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 466 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::LASER, "Laser"},
        {ElementType::MARKER, "Marker"},
        {ElementType::MONITOR, "Monitor"},
        {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"},
        {ElementType::CONSTANTEFIELDCAVITY, "ConstantEFieldCavity"}}

Definition at line 73 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 222 of file Component.h.

Referenced by Component::setExitFaceSlope().

◆ frequencyName_m

std::string VariableRFCavity::frequencyName_m

protectedinherited

Definition at line 227 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setFrequencyName().

◆ frequencyTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::frequencyTD_m

mutableprotectedinherited

Definition at line 224 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::getFrequency(), VariableRFCavity::getFrequencyModel(), VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::operator=(), and VariableRFCavity::setFrequencyModel().

◆ fsCmdBase_m

std::shared_ptr<FieldSolverCmd> TestVariableRFCavity::fsCmdBase_m

Definition at line 94 of file TestVariableRFCavity.cpp.

Referenced by makeBunch().

◆ geometry

StraightGeometry VariableRFCavity::geometry

protectedinherited

The cavity's geometry.

Definition at line 233 of file VariableRFCavity.h.

Referenced by VariableRFCavity::getGeometry(), VariableRFCavity::getGeometry(), and VariableRFCavity::setLength().

◆ halfHeight_m

double VariableRFCavity::halfHeight_m

protectedinherited

Definition at line 229 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::getHeight(), VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setHeight().

◆ halfWidth_m

double VariableRFCavity::halfWidth_m

protectedinherited

Definition at line 228 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::getWidth(), VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setWidth().

◆ length_m

double VariableRFCavity::length_m

protectedinherited

Definition at line 230 of file VariableRFCavity.h.

Referenced by VariableRFCavity::getLength(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setLength().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 438 of file ElementBase.h.

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

◆ online_m

bool Component::online_m

protectedinherited

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 471 of file ElementBase.h.

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

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 462 of file ElementBase.h.

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

◆ phaseName_m

std::string VariableRFCavity::phaseName_m

protectedinherited

Definition at line 225 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setPhaseName().

◆ phaseTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::phaseTD_m

mutableprotectedinherited

Definition at line 222 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::apply(), VariableRFCavity::getPhase(), VariableRFCavity::getPhaseModel(), VariableRFCavity::initialiseTimeDependencies(), VariableRFCavity::operator=(), and VariableRFCavity::setPhaseModel().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 464 of file ElementBase.h.

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

◆ RefPartBunch_m

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 225 of file Component.h.

Referenced by Corrector::apply(), VerticalFFAMagnet::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Monitor::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Ring::apply(), Monitor::apply(), MultipoleT::apply(), RFCavity::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Corrector::apply(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Monitor::driftToCorrectPositionAndSave(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), Corrector::goOnline(), PluginElement::initialise(), Corrector::initialise(), VerticalFFAMagnet::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::initialise(), VariableRFCavity::initialise(), RFCavity::initialise(), VariableRFCavity::initNull(), Multipole::isFocusing(), MultipoleT::MultipoleT(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), RFCavity::trackOnAxisParticle(), and VerticalFFAMagnet::VerticalFFAMagnet().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 444 of file ElementBase.h.

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

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 435 of file ElementBase.h.

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 456 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 458 of file ElementBase.h.

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

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

TestVariableRFCavity.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TestVariableRFCavity()

Member Function Documentation

◆ accept()

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ clone()

◆ computeField()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ execute()

◆ finalise()

◆ fixPosition()

◆ getAmplitude()

◆ getAmplitudeModel()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBodyPort()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getEntryPort()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getExitPort()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldExtend()

◆ getFlagDeleteOnTransverseExit()

◆ getFrequency()

◆ getFrequencyModel()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getHeight()

◆ getLength()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPhase()

◆ getPhaseModel()

◆ getPlacedElement()

◆ getPlacementGeometry()

◆ getPlacementMisalignment()

◆ getPlacementPose()