ElementBase Class Reference

#include <ElementBase.h>

Inheritance diagram for ElementBase:

Collaboration diagram for ElementBase:

Public Member Functions
	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...

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

Protected Member Functions
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
bool	shareFlag
CoordinateSystemTrafo	csTrafoGlobal2Local_m
CoordinateSystemTrafo	misalignment_m
std::pair< ApertureType, std::vector< double > >	aperture_m
double	elementEdge_m
double	rotationZAxis_m

Private Member Functions
void	operator= (const ElementBase &)

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

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

Detailed Description

Definition at line 127 of file ElementBase.h.

Constructor & Destructor Documentation

ElementBase() [1/3]

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

explicit

Constructor with given name.

Definition at line 139 of file ElementBase.cpp.

ElementBase() [2/3]

ElementBase::ElementBase

(

)

Definition at line 105 of file ElementBase.cpp.

ElementBase() [3/3]

ElementBase::ElementBase

(

const ElementBase &

right

)

Definition at line 110 of file ElementBase.cpp.

References bgeometry_m, parmatint_m, BoundaryGeometry::updateElement(), and ParticleMatterInteractionHandler::updateElement().

Here is the call graph for this function:

~ElementBase()

ElementBase::~ElementBase ( )

virtual

Definition at line 158 of file ElementBase.cpp.

Member Function Documentation

accept()

virtual void ElementBase::accept ( BeamlineVisitor &  visitor ) const

pure virtual

Apply visitor.

Implemented in Corrector, Cyclotron, Degrader, Undulator, TBeamline< T >, CCollimator, Drift, FlexibleCollimator, Marker, Monitor, Multipole, Offset, Probe, RBend, RBend3D, RFCavity, SBend, Septum, Solenoid, Source, Stripper, TravelingWave, Vacuum, VariableRFCavity, VariableRFCavityFringeField, Bend2D, VerticalFFAMagnet, MultipoleT, MultipoleTCurvedConstRadius, MultipoleTCurvedVarRadius, MultipoleTStraight, Ring, SBend3D, and ScalingFFAMagnet.

Referenced by ElmPtr::accept(), ParallelCyclotronTracker::execute(), DefaultVisitor::execute(), ParallelTTracker::prepareSections(), ThickTracker::prepareSections(), SpecificElementVisitor< ELEM >::visitFlaggedElmPtr(), and DefaultVisitor::visitFlaggedElmPtr().

clone()

virtual ElementBase * ElementBase::clone ( ) const

pure virtual

Return clone.

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

Referenced by Ring::appendElement(), Sequence::copy(), copyStructure(), RingSection::operator=(), ParallelCyclotronTracker::ParallelCyclotronTracker(), OpalBeamline::visit(), ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitCyclotron(), ParallelCyclotronTracker::visitDrift(), ParallelCyclotronTracker::visitMarker(), ParallelCyclotronTracker::visitMonitor(), ParallelCyclotronTracker::visitMultipole(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSBend(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitSolenoid(), ParallelCyclotronTracker::visitStripper(), and ParallelCyclotronTracker::visitVacuum().

copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtual

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 245 of file ElementBase.cpp.

References clone(), and isSharable().

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

Here is the call graph for this function:

fixPosition()

void ElementBase::fixPosition ( )

inline

Definition at line 550 of file ElementBase.h.

References positionIsFixed.

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

getAperture()

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

inline

Definition at line 524 of file ElementBase.h.

References aperture_m.

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

getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtual

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 410 of file ElementBase.h.

References BGeometryBase::getArcLength(), and 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

virtual

Get attribute value.

Definition at line 188 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtual

return the attached boundary geometrt object if there is any

Definition at line 474 of file ElementBase.h.

References bgeometry_m.

getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtual

Reimplemented in Bend2D.

Definition at line 314 of file ElementBase.cpp.

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

Here is the call graph for this function:

getChannel()

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

virtual

Construct a read/write channel.

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

Definition at line 229 of file ElementBase.cpp.

References AttributeSet::getChannel(), and userAttribs.

Referenced by CCollimatorRep::getChannel(), CorrectorRep::getChannel(), CyclotronRep::getChannel(), DegraderRep::getChannel(), DriftRep::getChannel(), FlexibleCollimatorRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RBendRep::getChannel(), RFCavityRep::getChannel(), SBendRep::getChannel(), SeptumRep::getChannel(), SingleMultipole< order >::getChannel(), SolenoidRep::getChannel(), SourceRep::getChannel(), StripperRep::getChannel(), TravelingWaveRep::getChannel(), UndulatorRep::getChannel(), VacuumRep::getChannel(), XCorrectorRep::getChannel(), YCorrectorRep::getChannel(), getConstChannel(), and setAttribute().

Here is the call graph for this function:

getConstChannel()

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

virtual

Construct a read-only channel.

Definition at line 234 of file ElementBase.cpp.

References getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inline

Definition at line 497 of file ElementBase.h.

References csTrafoGlobal2Local_m.

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

getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtual

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 502 of file ElementBase.h.

Referenced by getBoundingBoxInLabCoords(), Bend2D::getBoundingBoxInLabCoords(), and isInsideTransverse().

getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtual

Reimplemented in Bend2D, RFCavity, Solenoid, and TravelingWave.

Definition at line 510 of file ElementBase.h.

References getElementLength().

Referenced by getBoundingBoxInLabCoords().

Here is the call graph for this function:

getElementDimensions()

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

inlinevirtual

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 173 of file ElementBase.h.

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

Referenced by MeshGenerator::add().

Here is the call graph for this function:

getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtual

Get design length.

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

Definition at line 414 of file ElementBase.h.

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

Referenced by ScatteringPhysics::addBackToBunch(), Undulator::apply(), Multipole::apply(), Component::apply(), Corrector::apply(), Solenoid::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Vacuum::checkPoint(), ScatteringPhysics::copyFromBunch(), RBend::findChordLength(), SBend::findChordLength(), Corrector::getDimensions(), Degrader::getDimensions(), CCollimator::getDimensions(), Drift::getDimensions(), FlexibleCollimator::getDimensions(), Multipole::getDimensions(), RBend3D::getDimensions(), Solenoid::getDimensions(), Vacuum::getDimensions(), getEdgeToEnd(), Solenoid::getEdgeToEnd(), getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Multipole::initialise(), RBend3D::initialise(), Solenoid::initialise(), Source::initialise(), Vacuum::initialise(), Degrader::isInMaterial(), isInside(), Monitor::isInside(), Multipole::isInside(), isInsideTransverse(), FlexibleCollimator::isStopped(), ScatteringPhysics::setTimeStepForLeavingParticles(), Bend2D::setupDefaultFieldMap(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitDrift(), ThickTracker::visitDrift(), ParallelCyclotronTracker::visitMultipole(), ThickTracker::visitMultipole(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitSBend(), and ThickTracker::visitSBend().

Here is the call graph for this function:

getElementPosition()

double ElementBase::getElementPosition ( ) const

inline

Definition at line 588 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtual

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 426 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntrance().

Here is the call graph for this function:

getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 446 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtual

Get patch.

Definition at line 454 of file ElementBase.h.

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

Here is the call graph for this function:

getExit()

double ElementBase::getExit ( ) const

inlinevirtual

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 430 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExit().

Here is the call graph for this function:

getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 450 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtual

Get patch.

Definition at line 458 of file ElementBase.h.

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

Here is the call graph for this function:

getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inline

Definition at line 613 of file ElementBase.h.

References deleteOnTransverseExit_m.

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

getGeometry() [1/2]

virtual const BGeometryBase & ElementBase::getGeometry ( ) const

pure virtual

Get geometry.

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

getGeometry() [2/2]

virtual BGeometryBase & ElementBase::getGeometry ( )

pure virtual

Get geometry.

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

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

getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inline

Definition at line 540 of file ElementBase.h.

References misalignment_m.

getMisalignment() [2/2]

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

Referenced by ParallelTTracker::computeParticleMatterInteraction().

getName()

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

virtual

Get element name.

Definition at line 163 of file ElementBase.cpp.

References elementID.

Referenced by Ring::appendElement(), Cyclotron::apply(), Ring::apply(), Bend2D::calculateRefTrajectory(), Vacuum::checkPressure(), Stripper::doCheck(), CCollimator::doFinalise(), Stripper::doFinalise(), Probe::doGoOffline(), PlaceRep::enter(), Cyclotron::finalise(), Degrader::finalise(), FlexibleCollimator::finalise(), Vacuum::finalise(), getElementPosition(), RFCavity::getMomentaKick(), BeamStrippingPhysics::getName(), ScatteringPhysics::getName(), Bend2D::getOutline(), getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Ring::initialise(), Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalWake::initWakefunction(), PlaceRep::leave(), operator<<(), Offset::operator=(), VariableRFCavity::operator=(), operator==(), Vacuum::print(), BeamStrippingPhysics::print(), ScatteringPhysics::print(), Sequence::print(), ParticleMatterInteraction::print(), Bend2D::readFieldMap(), Component::trackBunch(), Component::trackMap(), RBend3D::trackRefParticleThrough(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), Sequence::updateList(), ParallelTTracker::updateRFElement(), ParallelCyclotronTracker::visitCCollimator(), Replacer::visitFlaggedElmPtr(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitStripper(), and ParallelTTracker::writePhaseSpace().

getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtual

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 422 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

getOutputFN()

std::string ElementBase::getOutputFN

(

)

const

Get output filename.

Definition at line 178 of file ElementBase.cpp.

References getName(), and outputfn_m.

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

Here is the call graph for this function:

getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtual

Definition at line 482 of file ElementBase.h.

References parmatint_m.

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

getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtual

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

Definition at line 602 of file ElementBase.h.

getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inline

Definition at line 573 of file ElementBase.h.

References rotationZAxis_m.

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

getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 438 of file ElementBase.h.

References 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

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 434 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTransform(), and TBeamline< T >::getTransform().

Here is the call graph for this function:

getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double  s ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 442 of file ElementBase.h.

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

Here is the call graph for this function:

getType()

virtual ElementType ElementBase::getType ( ) const

pure virtual

Get element type std::string.

Implemented in Component, Corrector, Cyclotron, Degrader, Undulator, TBeamline< T >, CCollimator, Drift, FlexibleCollimator, Marker, Monitor, Multipole, Probe, RBend, RBend3D, RFCavity, SBend, Septum, Solenoid, Source, Stripper, TravelingWave, Vacuum, and Bend2D.

Referenced by MeshGenerator::add(), BeamStrippingPhysics::apply(), getTypeString(), and ScatteringPhysics::ScatteringPhysics().

getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inline

Definition at line 578 of file ElementBase.h.

References getType(), and getTypeString().

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

Here is the call graph for this function:

getTypeString() [2/2]

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

static

Definition at line 241 of file ElementBase.cpp.

References elementTypeToString_s.

getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtual

return the attached wake object if there is any

Definition at line 466 of file ElementBase.h.

References wake_m.

hasAttribute()

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

virtual

Test for existence of an attribute.

Definition at line 201 of file ElementBase.cpp.

References getConstChannel().

Referenced by ParallelCyclotronTracker::visitSolenoid().

Here is the call graph for this function:

hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtual

Definition at line 478 of file ElementBase.h.

References bgeometry_m.

hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtual

Definition at line 486 of file ElementBase.h.

References parmatint_m.

hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtual

Definition at line 470 of file ElementBase.h.

References wake_m.

isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inline

Definition at line 597 of file ElementBase.h.

References elemedgeSet_m.

isInside()

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

inlinevirtual

Reimplemented in Bend2D, Monitor, Multipole, RBend3D, RFCavity, Solenoid, and TravelingWave.

Definition at line 529 of file ElementBase.h.

References getElementLength(), and isInsideTransverse().

Here is the call graph for this function:

isInsideTransverse()

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

protected

Definition at line 288 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

isPositioned()

bool ElementBase::isPositioned ( ) const

inline

Definition at line 555 of file ElementBase.h.

References positionIsFixed.

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

isSharable()

bool ElementBase::isSharable ( ) const

inline

Test if the element can be shared.

Definition at line 462 of file ElementBase.h.

References shareFlag.

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

makeSharable()

void ElementBase::makeSharable ( )

virtual

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 254 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker(), and Element::setShared().

operator=()

void ElementBase::operator= ( const ElementBase &  )

private

releasePosition()

void ElementBase::releasePosition ( )

inline

Definition at line 545 of file ElementBase.h.

References positionIsFixed.

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

removeAttribute()

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

virtual

Remove an existing attribute.

Definition at line 213 of file ElementBase.cpp.

References AttributeSet::removeAttribute(), and userAttribs.

Here is the call graph for this function:

setActionRange()

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

inline

Definition at line 560 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

setAperture()

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

inline

Definition at line 518 of file ElementBase.h.

References aperture_m.

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

setAttribute()

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

virtual

Set value of an attribute.

Definition at line 218 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry *  geo )

virtual

attach a boundary geometry field to the element

Definition at line 271 of file ElementBase.cpp.

References bgeometry_m.

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

setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo &  ori )

inline

Definition at line 490 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

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

setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate

(

double

s

)

Definition at line 279 of file ElementBase.cpp.

References actionRange_m, and elementEdge_m.

setElementLength()

void ElementBase::setElementLength ( double  length )

inlinevirtual

Set design length.

Definition at line 418 of file ElementBase.h.

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

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

Here is the call graph for this function:

setElementPosition()

void ElementBase::setElementPosition ( double  elemedge )

inline

Access to ELEMEDGE attribute.

Definition at line 582 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool  flag = true )

inline

Definition at line 607 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo &  cst )

inline

Definition at line 535 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

setName()

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

virtual

Set element name.

Definition at line 168 of file ElementBase.cpp.

References elementID, and name.

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

setOutputFN()

void ElementBase::setOutputFN

(

std::string

fn

)

Set output filename.

Definition at line 173 of file ElementBase.cpp.

References outputfn_m.

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

setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler *  spys )

virtual

Definition at line 275 of file ElementBase.cpp.

References parmatint_m.

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

setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double  rotation )

inline

Set rotation about z axis in bend frame.

Definition at line 568 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

setWake()

void ElementBase::setWake ( WakeFunction *  wf )

virtual

attach a wake field to the element

Definition at line 267 of file ElementBase.cpp.

References wake_m.

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

update()

bool ElementBase::update

(

const AttributeSet &

set

)

Update element.

Definition at line 259 of file ElementBase.cpp.

References AttributeSet::begin(), AttributeSet::end(), and 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

private

Definition at line 398 of file ElementBase.h.

Referenced by setActionRange(), and setCurrentSCoordinate().

aperture_m

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

protected

Definition at line 368 of file ElementBase.h.

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

bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

private

Definition at line 389 of file ElementBase.h.

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

csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protected

Definition at line 365 of file ElementBase.h.

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

deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

private

Definition at line 402 of file ElementBase.h.

Referenced by getFlagDeleteOnTransverseExit(), and setFlagDeleteOnTransverseExit().

elemedgeSet_m

bool ElementBase::elemedgeSet_m

private

Definition at line 396 of file ElementBase.h.

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

elementEdge_m

double ElementBase::elementEdge_m

protected

Definition at line 370 of file ElementBase.h.

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

elementID

std::string ElementBase::elementID

private

Definition at line 380 of file ElementBase.h.

Referenced by getName(), and setName().

elementPosition_m

double ElementBase::elementPosition_m

private

ELEMEDGE attribute.

Definition at line 395 of file ElementBase.h.

Referenced by getElementPosition(), and setElementPosition().

elementTypeToString_s

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

staticprivate

Definition at line 382 of file ElementBase.h.

Referenced by getTypeString().

misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protected

Definition at line 366 of file ElementBase.h.

Referenced by getMisalignment(), and setMisalignment().

outputfn_m

std::string ElementBase::outputfn_m

private

The name of the outputfile

Definition at line 400 of file ElementBase.h.

Referenced by getOutputFN(), and setOutputFN().

parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

private

Definition at line 391 of file ElementBase.h.

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

positionIsFixed

bool ElementBase::positionIsFixed

private

Definition at line 393 of file ElementBase.h.

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

rotationZAxis_m

double ElementBase::rotationZAxis_m

protected

Definition at line 372 of file ElementBase.h.

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

shareFlag

bool ElementBase::shareFlag

mutableprotected

Definition at line 363 of file ElementBase.h.

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

userAttribs

AttributeSet ElementBase::userAttribs

private

Definition at line 385 of file ElementBase.h.

Referenced by getChannel(), and removeAttribute().

wake_m

WakeFunction* ElementBase::wake_m

private

Definition at line 387 of file ElementBase.h.

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

---

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

• /Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/ElementBase.h
• /Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/ElementBase.cpp