Mapper Class Reference

Build transfer map. More...

#include <Mapper.h>

Inheritance diagram for Mapper:

Collaboration diagram for Mapper:

Public Member Functions
	Mapper (const Beamline &bl, const PartData &data, bool revBeam, bool revTrack)
	Constructor. More...
virtual	~Mapper ()
virtual void	getMap (LinearMap< double, 6 > &) const
	Return the linear part of the accumulated map. More...
virtual void	getMap (TransportMap< double, 6 > &) const
	Return the second-order part of the accumulated map. More...
virtual void	getMap (FVps< double, 6 > &) const
	Return the full map accumulated so far. More...
virtual void	setMap (const LinearMap< double, 6 > &)
	Reset the linear part of the accumulated map for restart. More...
virtual void	setMap (const TransportMap< double, 6 > &)
	Reset the second-order part of the accumulated map for restart. More...
virtual void	setMap (const FVps< double, 6 > &)
	Reset the full map for restart. More...
virtual void	visitComponent (const Component &)
	Apply the algorithm to an arbitrary component. More...
virtual void	visitPatch (const Patch &pat)
	Apply the algorithm to a patch. More...
virtual void	visitAlignWrapper (const AlignWrapper &)
	Apply the algorithm to an align wrapper. More...
virtual void	visitMapIntegrator (const MapIntegrator &)
	Apply the algorithm to an integrator capable of mapping. More...
Public Member Functions inherited from AbstractMapper
	AbstractMapper (const Beamline &bl, const PartData &data, bool revBeam, bool revTrack)
	Constructor. More...
virtual	~AbstractMapper ()
Public Member Functions inherited from DefaultVisitor
	DefaultVisitor (const Beamline &beamline, bool backBeam, bool backTrack)
	Constructor. More...
virtual	~DefaultVisitor ()=0
virtual void	execute ()
	Apply the algorithm to the top-level beamline. More...
virtual void	visitBeamBeam (const BeamBeam &)
	Apply the algorithm to a beam-beam. More...
virtual void	visitBeamStripping (const BeamStripping &)
	Apply the algorithm to a beam stripping. More...
virtual void	visitCCollimator (const CCollimator &)
	Apply the algorithm to a collimator. More...
virtual void	visitCyclotron (const Cyclotron &)
	Apply the algorithm to an cyclotron. More...
virtual void	visitRing (const Ring &)
	Apply the algorithm to an opal ring.. More...
virtual void	visitCorrector (const Corrector &)
	Apply the algorithm to a corrector. More...
virtual void	visitDegrader (const Degrader &)
	Apply the algorithm to a drift. More...
virtual void	visitDiagnostic (const Diagnostic &)
	Apply the algorithm to a diagnostic. More...
virtual void	visitDrift (const Drift &)
	Apply the algorithm to a drift. More...
virtual void	visitFlexibleCollimator (const FlexibleCollimator &)
	Apply the algorithm to a flexible collimator. More...
virtual void	visitLambertson (const Lambertson &)
	Apply the algorithm to a Lambertson. More...
virtual void	visitMarker (const Marker &)
	Apply the algorithm to a marker. More...
virtual void	visitMonitor (const Monitor &)
	Apply the algorithm to a monitor. More...
virtual void	visitMultipole (const Multipole &)
	Apply the algorithm to a multipole. More...
virtual void	visitMultipoleT (const MultipoleT &)
	Apply the algorithm to a multipoleT. More...
virtual void	visitMultipoleTStraight (const MultipoleTStraight &)
	Apply the algorithm to a multipoleTStraight. More...
virtual void	visitMultipoleTCurvedConstRadius (const MultipoleTCurvedConstRadius &)
	Apply the algorithm to a multipoleTCurvedConstRadius. More...
virtual void	visitMultipoleTCurvedVarRadius (const MultipoleTCurvedVarRadius &)
	Apply the algorithm to a multipoleTCurvedVarRadius. More...
virtual void	visitOffset (const Offset &)
	Apply the algorithm to an Offset. More...
virtual void	visitProbe (const Probe &prob)
	Apply the algorithm to a probe. More...
virtual void	visitRBend (const RBend &)
	Apply the algorithm to a rectangular bend. More...
virtual void	visitRBend3D (const RBend3D &)
	Apply the algorithm to a rectangular bend. More...
virtual void	visitVariableRFCavity (const VariableRFCavity &vcav)
	Apply the algorithm to a RF cavity. More...
virtual void	visitVariableRFCavityFringeField (const VariableRFCavityFringeField &vcav)
	Apply the algorithm to a RF cavity. More...
virtual void	visitRFCavity (const RFCavity &)
	Apply the algorithm to a RF cavity. More...
virtual void	visitTravelingWave (const TravelingWave &)
	Apply the algorithm to a RF cavity. More...
virtual void	visitRFQuadrupole (const RFQuadrupole &)
	Apply the algorithm to a RF quadrupole. More...
virtual void	visitSBend (const SBend &)
	Apply the algorithm to a sector bend. More...
virtual void	visitSBend3D (const SBend3D &)
	Apply the algorithm to a sector bend. More...
virtual void	visitScalingFFAMagnet (const ScalingFFAMagnet &)
	Apply the algorithm to a scaling FFA magnet. More...
virtual void	visitVerticalFFAMagnet (const VerticalFFAMagnet &)
	Apply the algorithm to a RF cavity. More...
virtual void	visitSeparator (const Separator &)
	Apply the algorithm to a separator. More...
virtual void	visitSeptum (const Septum &)
	Apply the algorithm to a septum. More...
virtual void	visitSolenoid (const Solenoid &)
	Apply the algorithm to a solenoid. More...
virtual void	visitSource (const Source &)
	Apply the algorithm to a source. More...
virtual void	visitParallelPlate (const ParallelPlate &)
	Apply the algorithm to a ParallelPlate. More...
virtual void	visitCyclotronValley (const CyclotronValley &)
	Apply the algorithm to a CyclotronValley. More...
virtual void	visitStripper (const Stripper &)
	Apply the algorithm to a charge stripper. More...
virtual void	visitBeamline (const Beamline &)
	Apply the algorithm to a beam line. More...
virtual void	visitFlaggedElmPtr (const FlaggedElmPtr &)
	Apply the algorithm to a FlaggedElmPtr. More...
virtual void	visitCorrectorWrapper (const CorrectorWrapper &)
	Apply the algorithm to an corrector wrapper.. More...
virtual void	visitCyclotronWrapper (const CyclotronWrapper &)
	Apply the algorithm to an cyclotron wrapper.. More...
virtual void	visitMultipoleWrapper (const MultipoleWrapper &)
	Apply the algorithm to an multipole wrapper.. More...
virtual void	visitRBendWrapper (const RBendWrapper &)
	Apply the algorithm to an RBend wrapper.. More...
virtual void	visitSBendWrapper (const SBendWrapper &)
	Apply the algorithm to an SBend wrapper.. More...
virtual void	visitIntegrator (const Integrator &)
	Apply the algorithm to a generic integrator. More...
virtual void	visitTrackIntegrator (const TrackIntegrator &)
	Apply the algorithm to an integrator capable of tracking. More...
Public Member Functions inherited from BeamlineVisitor
	BeamlineVisitor ()
virtual	~BeamlineVisitor ()

Protected Member Functions
void	applyDrift (double length)
	Apply drift length. More...
void	applyThinMultipole (const BMultipoleField &field, double factor)
	Thin multipole kick. More...
void	applyThinSBend (const BMultipoleField &field, double scale, double h)
	Thin SBend kick. More...
void	applyTransform (const Euclid3D &, double refLength=0.0)
	Apply transform. More...
Protected Member Functions inherited from AbstractMapper
FTps< double, 6 >	buildMultipoleVectorPotential (const BMultipoleField &)
	Construct the vector potential for a Multipole. More...
FTps< double, 6 >	buildSBendVectorPotential (const BMultipoleField &, double h)
	Construct the vector potential for an SBend. More...

Protected Attributes
FVps< double, 6 >	itsMap
	The transfer map being built. More...
Protected Attributes inherited from AbstractMapper
const PartData	itsReference
	The reference information. More...
Protected Attributes inherited from DefaultVisitor
const Beamline &	itsLine
bool	back_beam
bool	back_track
bool	back_path
double	flip_B
double	flip_s

Private Member Functions
	Mapper ()
	Mapper (const Mapper &)
void	operator= (const Mapper &)

Additional Inherited Members
Public Types inherited from AbstractMapper
enum	{   X, PX, Y, PY,   T, PT }

Detailed Description

Build transfer map.

Definition at line 85 of file Mapper.h.

Constructor & Destructor Documentation

Mapper::Mapper	(	const Beamline &	bl,
		const PartData &	data,
		bool	revBeam,
		bool	revTrack
	)

Constructor.

Definition at line 38 of file Mapper.cpp.

Mapper::~Mapper ( )

virtual

Definition at line 45 of file Mapper.cpp.

Mapper::Mapper ( )

private

Mapper::Mapper ( const Mapper &  )

private

Member Function Documentation

void Mapper::applyDrift ( double  length )

protected

Apply drift length.

Definition at line 118 of file Mapper.cpp.

References PartData::getBeta(), PartData::getM(), PartData::getP(), itsMap, AbstractMapper::itsReference, AbstractMapper::PT, AbstractMapper::PX, AbstractMapper::PY, sqrt(), AbstractMapper::T, AbstractMapper::X, and AbstractMapper::Y.

Here is the call graph for this function:

void Mapper::applyThinMultipole ( const BMultipoleField &  field, double  factor  )

protected

Thin multipole kick.

Definition at line 135 of file Mapper.cpp.

References BMultipoleField::normal(), BMultipoleField::order(), PX, PY, BMultipoleField::skew(), X, and Y.

Referenced by ThinMapper::visitMultipole(), ThickMapper::visitMultipole(), and ThickMapper::visitRBend().

Here is the call graph for this function:

void Mapper::applyThinSBend ( const BMultipoleField &  field, double  scale, double  h  )

protected

Thin SBend kick.

Definition at line 158 of file Mapper.cpp.

References FTps< T, N >::derivative(), PX, PY, FTps< T, N >::substitute(), X, and Y.

Referenced by ThickMapper::visitSBend().

Here is the call graph for this function:

void Mapper::applyTransform ( const Euclid3D &  euclid, double  refLength = 0.0  )

protected

Apply transform.

Definition at line 168 of file Mapper.cpp.

References PartData::getBeta(), PartData::getM(), PartData::getP(), Euclid3D::getX(), Euclid3D::getY(), Euclid3D::getZ(), Euclid3D::isIdentity(), itsMap, AbstractMapper::itsReference, Euclid3D::M(), AbstractMapper::PT, AbstractMapper::PX, AbstractMapper::PY, sqrt(), AbstractMapper::T, AbstractMapper::X, and AbstractMapper::Y.

Referenced by visitAlignWrapper(), visitPatch(), ThickMapper::visitRBend(), and ThickMapper::visitSBend().

Here is the call graph for this function:

void Mapper::getMap ( LinearMap< double, 6 > &  map ) const

virtual

Return the linear part of the accumulated map.

Implements AbstractMapper.

Definition at line 49 of file Mapper.cpp.

References itsMap.

void Mapper::getMap ( TransportMap< double, 6 > &  map ) const

virtual

Return the second-order part of the accumulated map.

Definition at line 54 of file Mapper.cpp.

References itsMap.

void Mapper::getMap ( FVps< double, 6 > &  map ) const

virtual

Return the full map accumulated so far.

Implements AbstractMapper.

Definition at line 59 of file Mapper.cpp.

References itsMap.

void Mapper::operator= ( const Mapper &  )

private

void Mapper::setMap ( const LinearMap< double, 6 > &  map )

virtual

Reset the linear part of the accumulated map for restart.

Implements AbstractMapper.

Definition at line 64 of file Mapper.cpp.

References itsMap.

void Mapper::setMap ( const TransportMap< double, 6 > &  map )

virtual

Reset the second-order part of the accumulated map for restart.

Definition at line 69 of file Mapper.cpp.

References itsMap.

void Mapper::setMap ( const FVps< double, 6 > &  map )

virtual

Reset the full map for restart.

Implements AbstractMapper.

Definition at line 74 of file Mapper.cpp.

References itsMap.

void Mapper::visitAlignWrapper ( const AlignWrapper &  wrap )

virtual

Apply the algorithm to an align wrapper.

Reimplemented from DefaultVisitor.

Definition at line 91 of file Mapper.cpp.

References ElementBase::accept(), applyTransform(), DefaultVisitor::back_path, AlignWrapper::getElement(), AlignWrapper::getEntranceTransform(), AlignWrapper::getExitTransform(), Inverse(), Euclid3D::isIdentity(), and AlignWrapper::offset().

Here is the call graph for this function:

void Mapper::visitComponent ( const Component &  comp )

virtual

Apply the algorithm to an arbitrary component.

Reimplemented from DefaultVisitor.

Definition at line 79 of file Mapper.cpp.

References DefaultVisitor::back_beam, DefaultVisitor::back_track, itsMap, AbstractMapper::itsReference, and Component::trackMap().

Here is the call graph for this function:

void Mapper::visitMapIntegrator ( const MapIntegrator &  i )

virtual

Apply the algorithm to an integrator capable of mapping.

Reimplemented from DefaultVisitor.

Definition at line 113 of file Mapper.cpp.

References DefaultVisitor::back_beam, DefaultVisitor::back_track, itsMap, AbstractMapper::itsReference, and MapIntegrator::trackMap().

Here is the call graph for this function:

void Mapper::visitPatch ( const Patch &  pat )

virtual

Apply the algorithm to a patch.

Reimplemented from DefaultVisitor.

Definition at line 84 of file Mapper.cpp.

References applyTransform(), DefaultVisitor::back_path, Patch::getPatch(), and Inverse().

Here is the call graph for this function:

Member Data Documentation

FVps<double, 6> Mapper::itsMap

protected

The transfer map being built.

Definition at line 152 of file Mapper.h.

Referenced by ThinMapper::applyDrift(), applyDrift(), ThickMapper::applyDrift(), ThickMapper::applyEntranceFringe(), ThickMapper::applyExitFringe(), applyTransform(), getMap(), setMap(), visitComponent(), ThinMapper::visitCorrector(), ThickMapper::visitCorrector(), visitMapIntegrator(), ThickMapper::visitMultipole(), ThinMapper::visitRBend(), ThickMapper::visitRBend(), ThinMapper::visitRFCavity(), ThickMapper::visitRFCavity(), ThinMapper::visitSBend(), ThickMapper::visitSBend(), ThinMapper::visitSeparator(), ThickMapper::visitSeparator(), ThinMapper::visitSolenoid(), and ThickMapper::visitSolenoid().

---

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

• src/Classic/Algorithms/Mapper.h
• src/Classic/Algorithms/Mapper.cpp