#include <LaserRep.h>

Inheritance diagram for LaserRep:

Collaboration diagram for LaserRep:

Public Member Functions
	LaserRep (const std::string &name)

	LaserRep ()

	LaserRep (const LaserRep &)

	~LaserRep () override

ElementBase *	clone () const override
	Return clone.

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

NullField &	getField () override
	Return field.

const NullField &	getField () const override
	Return field.

StraightGeometry &	getGeometry () override
	Get geometry.

const StraightGeometry &	getGeometry () const override
	Get geometry.

void	accept (BeamlineVisitor &) const override
	Accept a beamline visitor through the laser-specific interface.

void	initialise (PartBunch_t *bunch, double &startField, double &endField) override
	Initialize the element for a tracking pass.

void	finalise () override
	Finalize the element after a tracking pass.

bool	bends () const override
	Return false because the element has straight reference geometry.

void	getFieldExtend (double &zBegin, double &zEnd) const override
	Get the longitudinal element extent in the current lattice traversal.

ElementType	getType () const override
	Return the OPALX element type identifier.

int	getRequiredNumberOfTimeSteps () const override
	Return the minimum number of time steps required by this passive element.

void	setWavelength (double wavelength)
	Set the laser wavelength in m.

double	getWavelength () const
	Get the laser wavelength in m.

void	setPulseEnergy (double pulseEnergy)
	Set the total pulse energy in J.

double	getPulseEnergy () const
	Get the total pulse energy in J.

void	setPulseLength (double pulseLength)
	Set the pulse duration in s.

double	getPulseLength () const
	Get the pulse duration in s.

void	setWaistX (double waistX)
	Set the horizontal waist in m.

double	getWaistX () const
	Get the horizontal waist in m.

void	setWaistY (double waistY)
	Set the vertical waist in m.

double	getWaistY () const
	Get the vertical waist in m.

void	setDirection (const Vector_t< double, 3 > &direction)
	Set the laboratory-frame laser propagation direction.

const Vector_t< double, 3 > &	getDirection () const
	Get the laboratory-frame laser propagation direction.

void	setStokes (const Vector_t< double, 3 > &stokes)
	Set the normalized Stokes polarization vector.

const Vector_t< double, 3 > &	getStokes () const
	Get the normalized Stokes polarization vector.

double	getPhotonEnergyGeV () const
	Convert the stored laser wavelength to a single-photon energy.

double	getLinearComptonInvariantX (double electronTotalEnergyGeV, const Vector_t< double, 3 > &beamDirection) const
	Compute the linear Compton invariant x for a given beam direction.

double	getLinearComptonForwardPhotonEnergyGeV (double electronTotalEnergyGeV, const Vector_t< double, 3 > &beamDirection) const
	Compute the forward scattered photon energy for linear Compton scattering.

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	apply (const std::shared_ptr< ParticleContainer_t > &pc)
	Apply to all particles. Kernel launch moved inside the function.

virtual bool	apply (const size_t &i, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B)
	Apply to particle i.

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)
	Apply to particle with position R and momentum P.

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)
	Apply to reference particle with position R and momemtum P.

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

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 std::string	getTypeString (ElementType type)

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

Protected Attributes
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
NullField	field_m

StraightGeometry	geometry_m

double	startField_m

double	wavelength_m

double	pulseEnergy_m

double	pulseLength_m

double	waistX_m

double	waistY_m

Vector_t< double, 3 >	direction_m

Vector_t< double, 3 >	stokes_m

std::string	elementID

AttributeSet	userAttribs

WakeFunction *	wake_m

BoundaryGeometry *	bgeometry_m

ParticleMatterInteractionHandler *	parmatint_m

bool	positionIsFixed

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

std::string	outputfn_m

bool	deleteOnTransverseExit_m = true


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 8 of file LaserRep.h.

Constructor & Destructor Documentation

◆ LaserRep() [1/3]

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

explicit

Definition at line 21 of file LaserRep.cpp.

◆ LaserRep() [2/3]

LaserRep::LaserRep ( )

Definition at line 17 of file LaserRep.cpp.

Referenced by clone().

◆ LaserRep() [3/3]

LaserRep::LaserRep ( const LaserRep & right )

Definition at line 19 of file LaserRep.cpp.

◆ ~LaserRep()

LaserRep::~LaserRep ( )

override

Definition at line 23 of file LaserRep.cpp.

Member Function Documentation

◆ accept()

void Laser::accept ( BeamlineVisitor & visitor ) const

overridevirtualinherited

Accept a beamline visitor through the laser-specific interface.

Implements ElementBase.

Definition at line 32 of file Laser.cpp.

References BeamlineVisitor::visitLaser().

Referenced by TEST().

Here is the call graph for this function:

◆ apply() [1/3]

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

virtualinherited

Apply to particle i.

Parameters

i	Particle index
t	Time
E	Electric Field
B	Magnetic Field

Returns: true if particle is out-of-bounds (lost), false otherwise

Reimplemented in Corrector, VerticalFFAMagnet, BendBase, ConstantEFieldCavity, Monitor, Multipole, MultipoleT, PluginElement, RFCavity, ScalingFFAMagnet, Solenoid, TravelingWave, VariableRFCavity, and Ring.

Definition at line 69 of file Component.cpp.

References gmsg.

◆ apply() [2/3]

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

virtualinherited

Apply to all particles. Kernel launch moved inside the function.

Apply functions apply the components electromagnetic field to the particles. They are called inside ParalleTracker::computeExternalFields()

Returns: true if particle is out-of-bounds (lost), false otherwise; true if particle is out-of-bounds (lost), false otherwise

Reimplemented in VerticalFFAMagnet, BendBase, ConstantEFieldCavity, Monitor, Multipole, MultipoleT, PluginElement, RFCavity, Ring, ScalingFFAMagnet, Solenoid, TravelingWave, and VariableRFCavity.

Definition at line 57 of file Component.cpp.

Referenced by RingSection::getFieldValue().

◆ apply() [3/3]

bool Component::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
	)

virtualinherited

Apply to particle with position R and momentum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns: true if particle is out-of-bounds (lost), false otherwise

Reimplemented in Corrector, VerticalFFAMagnet, BendBase, ConstantEFieldCavity, Monitor, Multipole, MultipoleT, PluginElement, RFCavity, Ring, ScalingFFAMagnet, Solenoid, TravelingWave, and VariableRFCavity.

Definition at line 94 of file Component.cpp.

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

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool Component::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
	)

virtualinherited

Apply to reference particle with position R and momemtum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns: true if particle is out-of-bounds (lost), false otherwise

Reimplemented in BendBase, ConstantEFieldCavity, Monitor, Multipole, PluginElement, RFCavity, Solenoid, TravelingWave, and VariableRFCavity.

Definition at line 114 of file Component.cpp.

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

Here is the call graph for this function:

◆ bends()

bool Laser::bends ( ) const

overridevirtualinherited

Return false because the element has straight reference geometry.

Implements Component.

Definition at line 42 of file Laser.cpp.

◆ 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 * LaserRep::clone ( ) const

overridevirtual

Return clone.

Implements ElementBase.

Definition at line 25 of file LaserRep.cpp.

References LaserRep().

Here is the call graph for this function:

◆ 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:

◆ finalise()

void Laser::finalise ( )

overridevirtualinherited

Finalize the element after a tracking pass.

Implements Component.

Definition at line 40 of file Laser.cpp.

◆ 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().

◆ 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 * LaserRep::getChannel	(	const std::string &	aKey,
		bool	create = `false`
	)

overridevirtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 27 of file LaserRep.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 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.

◆ getDirection()

const Vector_t< double, 3 > & Laser::getDirection ( ) const

inherited

Get the laboratory-frame laser propagation direction.

Definition at line 73 of file Laser.cpp.

References Laser::direction_m.

◆ 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 NullField & LaserRep::getField ( ) const

overridevirtual

Return field.

Implements Component.

Definition at line 39 of file LaserRep.cpp.

References field_m.

◆ getField() [2/2]

NullField & LaserRep::getField ( )

overridevirtual

Return field.

Implements Component.

Definition at line 37 of file LaserRep.cpp.

References field_m.

◆ getFieldExtend()

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

overridevirtualinherited

Get the longitudinal element extent in the current lattice traversal.

Implements Component.

Definition at line 44 of file Laser.cpp.

References ElementBase::getElementLength(), and Laser::startField_m.

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

◆ getGeometry() [1/2]

const StraightGeometry & LaserRep::getGeometry ( ) const

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 43 of file LaserRep.cpp.

References geometry_m.

◆ getGeometry() [2/2]

StraightGeometry & LaserRep::getGeometry ( )

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 41 of file LaserRep.cpp.

References geometry_m.

◆ getLinearComptonForwardPhotonEnergyGeV()

double Laser::getLinearComptonForwardPhotonEnergyGeV	(	double	electronTotalEnergyGeV,
		const Vector_t< double, 3 > &	beamDirection
	)		const

inherited

Compute the forward scattered photon energy for linear Compton scattering.

The helper uses the same CAIN-inspired sequence as the first OPALX benchmark: boost the laser photon into the electron rest frame, apply the Compton recoil, and boost the forward photon back to the laboratory frame.

Parameters

electronTotalEnergyGeV	Electron total energy in GeV.
beamDirection	Laboratory-frame unit direction of the incoming electron beam.

Returns: Forward scattered photon energy in GeV.

Exceptions

OpalException If the electron energy is below rest energy or if either direction vector is zero.

Definition at line 87 of file Laser.cpp.

References Laser::direction_m, Laser::getPhotonEnergyGeV(), and Physics::LinearCompton::labForwardPhotonEnergyGeV().

Here is the call graph for this function:

◆ getLinearComptonInvariantX()

double Laser::getLinearComptonInvariantX	(	double	electronTotalEnergyGeV,
		const Vector_t< double, 3 > &	beamDirection
	)		const

inherited

Compute the linear Compton invariant x for a given beam direction.

This follows the CAIN linear-Compton rest-frame mapping \(\omega_1 = \gamma \omega_L (1 - \beta \cos \alpha)\) and returns \(x = 2 \omega_1 / m_e\).

Parameters

electronTotalEnergyGeV	Electron total energy in GeV.
beamDirection	Laboratory-frame unit direction of the incoming electron beam.

Returns: Dimensionless linear Compton invariant \(x\).

Exceptions

OpalException If the electron energy is below rest energy or if either direction vector is zero.

Definition at line 81 of file Laser.cpp.

References Laser::direction_m, Laser::getPhotonEnergyGeV(), and Physics::LinearCompton::invariantX().

Here is the call graph for this function:

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

◆ getPhotonEnergyGeV()

double Laser::getPhotonEnergyGeV ( ) const

inherited

Convert the stored laser wavelength to a single-photon energy.

Returns: Laser photon energy in GeV.

Exceptions

OpalException If the stored wavelength is non-positive.

Definition at line 77 of file Laser.cpp.

References Physics::LinearCompton::photonEnergyFromWavelengthGeV(), and Laser::wavelength_m.

Referenced by Laser::getLinearComptonForwardPhotonEnergyGeV(), and Laser::getLinearComptonInvariantX().

Here is the call graph for this function:

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

◆ getPulseEnergy()

double Laser::getPulseEnergy ( ) const

inherited

Get the total pulse energy in J.

Definition at line 57 of file Laser.cpp.

References Laser::pulseEnergy_m.

◆ getPulseLength()

double Laser::getPulseLength ( ) const

inherited

Get the pulse duration in s.

Definition at line 61 of file Laser.cpp.

References Laser::pulseLength_m.

◆ getRequiredNumberOfTimeSteps()

int Laser::getRequiredNumberOfTimeSteps ( ) const

inlineoverridevirtualinherited

Return the minimum number of time steps required by this passive element.

Reimplemented from ElementBase.

Definition at line 157 of file Laser.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 609 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

◆ getStokes()

const Vector_t< double, 3 > & Laser::getStokes ( ) const

inherited

Get the normalized Stokes polarization vector.

Definition at line 93 of file Laser.cpp.

References Laser::stokes_m.

◆ 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 Laser::getType ( ) const

overridevirtualinherited

Return the OPALX element type identifier.

Reimplemented from Component.

Definition at line 49 of file Laser.cpp.

References LASER.

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

◆ getWaistX()

double Laser::getWaistX ( ) const

inherited

Get the horizontal waist in m.

Definition at line 65 of file Laser.cpp.

References Laser::waistX_m.

◆ getWaistY()

double Laser::getWaistY ( ) const

inherited

Get the vertical waist in m.

Definition at line 69 of file Laser.cpp.

References Laser::waistY_m.

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

◆ getWavelength()

double Laser::getWavelength ( ) const

inherited

Get the laser wavelength in m.

Definition at line 53 of file Laser.cpp.

References Laser::wavelength_m.

◆ 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 Laser::initialise	(	PartBunch_t *	bunch,
		double &	startField,
		double &	endField
	)

overridevirtualinherited

Initialize the element for a tracking pass.

Parameters

bunch	Referenced bunch.
startField	Element entrance position in the current lattice traversal.
endField	Filled with the element exit position.

Implements Component.

Definition at line 34 of file Laser.cpp.

References ElementBase::getElementLength(), Component::RefPartBunch_m, and Laser::startField_m.

Here is the call graph for this function:

◆ 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().

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

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

◆ setDirection()

void Laser::setDirection ( const Vector_t< double, 3 > & direction )

inherited

Set the laboratory-frame laser propagation direction.

Definition at line 71 of file Laser.cpp.

References Laser::direction_m.

◆ 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().

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

◆ 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:

◆ setPulseEnergy()

void Laser::setPulseEnergy ( double pulseEnergy )

inherited

Set the total pulse energy in J.

Definition at line 55 of file Laser.cpp.

References Laser::pulseEnergy_m.

◆ setPulseLength()

void Laser::setPulseLength ( double pulseLength )

inherited

Set the pulse duration in s.

Definition at line 59 of file Laser.cpp.

References Laser::pulseLength_m.

◆ 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().

◆ setStokes()

void Laser::setStokes ( const Vector_t< double, 3 > & stokes )

inherited

Set the normalized Stokes polarization vector.

Definition at line 75 of file Laser.cpp.

References Laser::stokes_m.

◆ setWaistX()

void Laser::setWaistX ( double waistX )

inherited

Set the horizontal waist in m.

Definition at line 63 of file Laser.cpp.

References Laser::waistX_m.

◆ setWaistY()

void Laser::setWaistY ( double waistY )

inherited

Set the vertical waist in m.

Definition at line 67 of file Laser.cpp.

References Laser::waistY_m.

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

◆ setWavelength()

void Laser::setWavelength ( double wavelength )

inherited

Set the laser wavelength in m.

Definition at line 51 of file Laser.cpp.

References Laser::wavelength_m.

◆ 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:

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

◆ 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().

◆ 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().

◆ direction_m

Vector_t<double, 3> Laser::direction_m

privateinherited

Definition at line 153 of file Laser.h.

Referenced by Laser::getDirection(), Laser::getLinearComptonForwardPhotonEnergyGeV(), Laser::getLinearComptonInvariantX(), and Laser::setDirection().

◆ 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().

◆ field_m

NullField LaserRep::field_m

private

Definition at line 25 of file LaserRep.h.

Referenced by getField(), and getField().

◆ geometry_m

StraightGeometry LaserRep::geometry_m

private

Definition at line 26 of file LaserRep.h.

Referenced by getGeometry(), and getGeometry().

◆ 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().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 464 of file ElementBase.h.

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

◆ pulseEnergy_m

double Laser::pulseEnergy_m

privateinherited

Definition at line 149 of file Laser.h.

Referenced by Laser::getPulseEnergy(), and Laser::setPulseEnergy().

◆ pulseLength_m

double Laser::pulseLength_m

privateinherited

Definition at line 150 of file Laser.h.

Referenced by Laser::getPulseLength(), and Laser::setPulseLength().

◆ 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().

◆ startField_m

double Laser::startField_m

privateinherited

Definition at line 147 of file Laser.h.

Referenced by Laser::getFieldExtend(), and Laser::initialise().

◆ stokes_m

Vector_t<double, 3> Laser::stokes_m

privateinherited

Definition at line 154 of file Laser.h.

Referenced by Laser::getStokes(), and Laser::setStokes().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 456 of file ElementBase.h.

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

◆ waistX_m

double Laser::waistX_m

privateinherited

Definition at line 151 of file Laser.h.

Referenced by Laser::getWaistX(), and Laser::setWaistX().

◆ waistY_m

double Laser::waistY_m

privateinherited

Definition at line 152 of file Laser.h.

Referenced by Laser::getWaistY(), and Laser::setWaistY().

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 458 of file ElementBase.h.

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

◆ wavelength_m

double Laser::wavelength_m

privateinherited

Definition at line 148 of file Laser.h.

Referenced by Laser::getPhotonEnergyGeV(), Laser::getWavelength(), and Laser::setWavelength().

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 Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LaserRep() [1/3]

◆ LaserRep() [2/3]

◆ LaserRep() [3/3]

◆ ~LaserRep()

Member Function Documentation

◆ accept()

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBodyPort()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDirection()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getEntryPort()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getExitPort()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldExtend()

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getLinearComptonForwardPhotonEnergyGeV()

◆ getLinearComptonInvariantX()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPhotonEnergyGeV()

◆ getPlacedElement()

◆ getPlacementGeometry()

◆ getPlacementMisalignment()

◆ getPlacementPose()

◆ getPlacementSupport()

◆ getPotential()

◆ getPulseEnergy()

◆ getPulseLength()

◆ getRequiredNumberOfTimeSteps()

◆ getRotationAboutZ()