Interface for solenoids. More...

#include <RBend3D.h>

Inheritance diagram for RBend3D:

[legend]

Collaboration diagram for RBend3D:

[legend]

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

	RBend3D ()

	RBend3D (const RBend3D &)

virtual	~RBend3D ()

ElementBase *	clone () const override

BGeometryBase &	getGeometry () override

const BGeometryBase &	getGeometry () const override

EMField &	getField () override

const EMField &	getField () const override

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

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override

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

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

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override

virtual void	finalise () override

virtual void	goOnline (const double &kineticEnergy) override

virtual void	goOffline () override

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

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

virtual bool	isInside (const Vector_t &r) const override

MeshData	getSurfaceMesh () const

virtual double	getExitAngle () const override

Public Member Functions inherited from BendBase
	BendBase ()

	BendBase (const BendBase &)

	BendBase (const std::string &)

virtual bool	bends () const
	Indicates that element bends the beam. More...

double	getChordLength () const

virtual void	setBendAngle (double angle)

double	getBendAngle () const

virtual void	setEntranceAngle (double entranceAngle)

double	getEntranceAngle () const

virtual double	getExitAngle () const =0

void	setFullGap (double)

double	getFullGap () const

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

double	getDesignEnergy () const

std::vector< Vector_t >	getDesignPath () const

void	setFieldAmplitude (double k0, double k0s)

double	getFieldAmplitude () const

void	setFieldMapFN (std::string fileName)

std::string	getFieldMapFN () const

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

	Component ()

	Component (const Component &right)

virtual	~Component ()

virtual EMField &	getField ()=0
	Return field. More...

virtual const EMField &	getField () const =0
	Return field. More...

EVector	Efield (const Point3D &P) const
	Return the field in a point. More...

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

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

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

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

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

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

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

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

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

virtual double	getDesignEnergy () const

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

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0

virtual void	finalise ()=0

virtual bool	bends () const =0

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

virtual void	getDimensions (double &zBegin, double &zEnd) const =0

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

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

virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...

virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...

void	setExitFaceSlope (const double &)

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

	ElementBase ()

	ElementBase (const ElementBase &)

virtual	~ElementBase ()

virtual const std::string &	getName () const
	Get element name. More...

virtual void	setName (const std::string &name)
	Set element name. More...

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

std::string	getTypeString () const

virtual BGeometryBase &	getGeometry ()=0
	Get geometry. More...

virtual const BGeometryBase &	getGeometry () const =0
	Get geometry. More...

virtual double	getArcLength () const
	Get arc length. More...

virtual double	getElementLength () const
	Get design length. More...

virtual void	setElementLength (double length)
	Set design length. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	accept (BeamlineVisitor &visitor) const =0
	Apply visitor. More...

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

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

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

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

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

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)

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

virtual bool	hasBoundaryGeometry () const

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

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

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

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

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

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

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

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

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

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

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

double	getElementPosition () const

bool	isElementPositionSet () const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

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

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

Private Member Functions
double	trackRefParticleThrough (double dt, bool print=false)

void	operator= (const RBend3D &)

Private Attributes
double	fieldAmplitudeError_m

double	startField_m

double	lengthField_m

StraightGeometry	geometry_m

BMultipoleField	dummyField_m

Additional Inherited Members
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

Protected Member Functions inherited from BendBase
double	calcDesignRadius (double fieldAmplitude) const
	Calculate design radius from design energy and field amplitude. More...

double	calcFieldAmplitude (double radius) const
	Calculate field amplitude from design energy and radius. More...

double	calcBendAngle (double chordLength, double radius) const
	Calculate bend angle from chord length and design radius. More...

double	calcDesignRadius (double chordLength, double angle) const
	Calculate design radius from chord length and bend angle. More...

double	calcGamma () const
	Calculate gamma from design energy. More...

double	calcBetaGamma () const
	Calculate beta*gamma from design energy. More...

Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r) const

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from BendBase
double	chordLength_m

double	angle_m
	Bend angle. More...

double	entranceAngle_m

Fieldmap *	fieldmap_m
	Magnet field map. More...

const bool	fast_m = false
	Flag to turn on fast field calculation. More...

double	gap_m
	Full vertical gap of the magnets. More...

double	designEnergy_m
	Bend design energy (eV). More...

bool	designEnergyChangeable_m

std::vector< Vector_t >	refTrajMap_m
	Map of reference particle trajectory. More...

double	fieldAmplitudeX_m

double	fieldAmplitudeY_m

double	fieldAmplitude_m
	Field amplitude. More...

std::string	fileName_m

Protected Attributes inherited from Component
double	exit_face_slope_m

PartBunchBase< double, 3 > *	RefPartBunch_m

bool	online_m

Protected Attributes inherited from ElementBase
bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

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

double	elementEdge_m

double	rotationZAxis_m

Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Interface for solenoids.

Definition at line 39 of file RBend3D.h.

Constructor & Destructor Documentation

◆ RBend3D() [1/3]

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

explicit

Constructor with given name.

Definition at line 51 of file RBend3D.cpp.

◆ RBend3D() [2/3]

RBend3D::RBend3D ( )

Definition at line 36 of file RBend3D.cpp.

Referenced by clone().

◆ RBend3D() [3/3]

RBend3D::RBend3D ( const RBend3D & right )

Definition at line 41 of file RBend3D.cpp.

◆ ~RBend3D()

RBend3D::~RBend3D ( )

virtual

Definition at line 61 of file RBend3D.cpp.

Member Function Documentation

◆ accept()

void RBend3D::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to RBend3D.

Implements ElementBase.

Definition at line 64 of file RBend3D.cpp.

References BeamlineVisitor::visitRBend3D().

Here is the call graph for this function:

◆ apply() [1/2]

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

overridevirtual

Reimplemented from Component.

Definition at line 68 of file RBend3D.cpp.

References apply(), PartBunchBase< T, Dim >::P, PartBunchBase< T, Dim >::R, and Component::RefPartBunch_m.

Referenced by apply().

Here is the call graph for this function:

◆ apply() [2/2]

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

overridevirtual

Reimplemented from Component.

Definition at line 72 of file RBend3D.cpp.

References BendBase::fieldAmplitude_m, fieldAmplitudeError_m, BendBase::fieldmap_m, Fieldmap::getFieldstrength(), Attrib::Distribution::R, and startField_m.

Here is the call graph for this function:

◆ applyToReferenceParticle()

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

overridevirtual

Reimplemented from Component.

Definition at line 83 of file RBend3D.cpp.

References BendBase::fieldAmplitude_m, BendBase::fieldmap_m, Fieldmap::getFieldstrength(), Attrib::Distribution::R, and startField_m.

Referenced by trackRefParticleThrough().

Here is the call graph for this function:

◆ clone()

ElementBase * RBend3D::clone ( ) const

overridevirtual

Inheritable copy constructor

Implements ElementBase.

Definition at line 216 of file RBend3D.cpp.

References RBend3D().

Here is the call graph for this function:

◆ finalise()

void RBend3D::finalise ( )

overridevirtual

Implements Component.

Definition at line 188 of file RBend3D.cpp.

◆ getDimensions()

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

overridevirtual

Implements Component.

Definition at line 201 of file RBend3D.cpp.

References ElementBase::getElementLength(), and startField_m.

Here is the call graph for this function:

◆ getExitAngle()

double RBend3D::getExitAngle ( ) const

inlineoverridevirtual

Implements BendBase.

Definition at line 108 of file RBend3D.h.

References BendBase::getBendAngle(), and BendBase::getEntranceAngle().

Here is the call graph for this function:

◆ getField() [1/2]

const EMField & RBend3D::getField ( ) const

overridevirtual

Return a dummy (0.) field value (what is this for?)

Implements Component.

Definition at line 232 of file RBend3D.cpp.

References dummyField_m.

◆ getField() [2/2]

EMField & RBend3D::getField ( )

overridevirtual

Return a dummy (0.) field value (what is this for?)

Implements Component.

Definition at line 228 of file RBend3D.cpp.

References dummyField_m.

◆ getGeometry() [1/2]

const BGeometryBase & RBend3D::getGeometry ( ) const

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 224 of file RBend3D.cpp.

References geometry_m.

◆ getGeometry() [2/2]

BGeometryBase & RBend3D::getGeometry ( )

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 220 of file RBend3D.cpp.

References geometry_m.

◆ getSurfaceMesh()

MeshData RBend3D::getSurfaceMesh ( ) const

Definition at line 236 of file RBend3D.cpp.

References BendBase::fieldmap_m, Fieldmap::getFieldDimensions(), MeshData::triangles_m, and MeshData::vertices_m.

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getType()

ElementType RBend3D::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 207 of file RBend3D.cpp.

References RBEND3D.

◆ goOffline()

void RBend3D::goOffline ( )

overridevirtual

Reimplemented from Component.

Definition at line 196 of file RBend3D.cpp.

References BendBase::fileName_m, Fieldmap::freeMap(), and Component::online_m.

Here is the call graph for this function:

◆ goOnline()

void RBend3D::goOnline ( const double & kineticEnergy )

overridevirtual

Reimplemented from Component.

Definition at line 191 of file RBend3D.cpp.

References BendBase::fileName_m, Component::online_m, and Fieldmap::readMap().

Referenced by initialise().

Here is the call graph for this function:

◆ initialise()

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

overridevirtual

Implements Component.

Definition at line 93 of file RBend3D.cpp.

References abs(), BendBase::angle_m, atan2(), BendBase::calcFieldAmplitude(), BendBase::chordLength_m, copysign(), BendBase::entranceAngle_m, BendBase::fast_m, BendBase::fieldAmplitude_m, BendBase::fieldAmplitudeX_m, BendBase::fieldAmplitudeY_m, BendBase::fieldmap_m, BendBase::fileName_m, PartBunchBase< T, Dim >::getdT(), ElementBase::getElementLength(), Fieldmap::getFieldDimensions(), Fieldmap::getFieldmap(), Fieldmap::getFieldstrength(), Fieldmap::getInfo(), ElementBase::getName(), PartBunchBase< T, Dim >::getQ(), gmsg, goOnline(), lengthField_m, level2(), Physics::pi, Component::RefPartBunch_m, ElementBase::rotationZAxis_m, ElementBase::setElementLength(), startField_m, trackRefParticleThrough(), and Options::writeBendTrajectories.

Here is the call graph for this function:

◆ isInside()

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

overridevirtual

Reimplemented from ElementBase.

Definition at line 211 of file RBend3D.cpp.

References BendBase::fieldmap_m, Fieldmap::isInside(), and startField_m.

Here is the call graph for this function:

◆ operator=()

void RBend3D::operator= ( const RBend3D & )

private

◆ trackRefParticleThrough()

double RBend3D::trackRefParticleThrough	(	double	dt,
		bool	print = `false`
	)

private

Definition at line 268 of file RBend3D.cpp.

References applyToReferenceParticle(), atan2(), Physics::c, BendBase::calcBetaGamma(), BendBase::calcGamma(), Util::combineFilePath(), cos(), endl(), BendBase::entranceAngle_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInputBasename(), OpalData::getInstance(), ElementBase::getName(), PartBunchBase< T, Dim >::getReference(), BorisPusher::kick(), lengthField_m, IpplInfo::myNode(), BorisPusher::push(), Component::RefPartBunch_m, sin(), startField_m, tan(), and X.

Referenced by initialise().

Here is the call graph for this function:

Member Data Documentation

◆ dummyField_m

BMultipoleField RBend3D::dummyField_m

private

Definition at line 101 of file RBend3D.h.

Referenced by getField().

◆ fieldAmplitudeError_m

double RBend3D::fieldAmplitudeError_m

private

scale multiplier error

Definition at line 94 of file RBend3D.h.

Referenced by apply().

◆ geometry_m

StraightGeometry RBend3D::geometry_m

private

Definition at line 99 of file RBend3D.h.

Referenced by getGeometry().

◆ lengthField_m

double RBend3D::lengthField_m

private

Definition at line 97 of file RBend3D.h.

Referenced by initialise(), and trackRefParticleThrough().

◆ startField_m

double RBend3D::startField_m

private

startingpoint of field, m

Definition at line 96 of file RBend3D.h.

Referenced by apply(), applyToReferenceParticle(), getDimensions(), initialise(), isInside(), and trackRefParticleThrough().

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

/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/RBend3D.h
/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/RBend3D.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RBend3D() [1/3]

◆ RBend3D() [2/3]

◆ RBend3D() [3/3]

◆ ~RBend3D()

Member Function Documentation

◆ accept()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ clone()

◆ finalise()

◆ getDimensions()

◆ getExitAngle()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getSurfaceMesh()

◆ getType()

◆ goOffline()

◆ goOnline()

◆ initialise()

◆ isInside()

◆ operator=()

◆ trackRefParticleThrough()

Member Data Documentation

◆ dummyField_m

◆ fieldAmplitudeError_m

◆ geometry_m

◆ lengthField_m

◆ startField_m