OpalParticle Class Reference

OpalParticle position. More...

#include <OpalParticle.h>

Public Types
enum	{   X, PX, Y, PY,   T, PT }

Public Member Functions
	OpalParticle (double x, double px, double y, double py, double t, double pt)
	Constructor. More...
	OpalParticle ()
double &	operator[] (int)
	Get coordinate. More...
double &	x ()
	Get reference to horizontal position in m. More...
double &	px ()
	Get reference to horizontal momentum (no dimension). More...
double &	y ()
	Get reference to vertical displacement in m. More...
double &	py ()
	Get reference to vertical momentum (no dimension). More...
double &	t ()
	Get reference to longitudinal displacement c*t in m. More...
double &	pt ()
	Get reference to relative momentum error (no dimension). More...
double	operator[] (int) const
	Get coordinate. More...
double	x () const
	Get horizontal position in m. More...
double	px () const
	Get horizontal momentum (no dimension). More...
double	y () const
	Get vertical displacement in m. More...
double	py () const
	Get vertical momentum (no dimension). More...
double	t () const
	Get longitudinal displacement c*t in m. More...
double	pt () const
	Get relative momentum error (no dimension). More...

Private Attributes
double	phase [6]

Detailed Description

OpalParticle position.

Definition at line 38 of file OpalParticle.h.

Member Enumeration Documentation

anonymous enum

Enumerator
X
PX
Y
PY
T
PT

Definition at line 43 of file OpalParticle.h.

Constructor & Destructor Documentation

OpalParticle::OpalParticle	(	double	x,
		double	px,
		double	y,
		double	py,
		double	t,
		double	pt
	)

Constructor.

Definition at line 33 of file OpalParticle.cpp.

References PT, PX, PY, T, X, and Y.

OpalParticle::OpalParticle

(

)

Definition at line 28 of file OpalParticle.cpp.

Member Function Documentation

double & OpalParticle::operator[] ( int  i )

inline

Get coordinate.

Definition at line 106 of file OpalParticle.h.

References phase.

double OpalParticle::operator[] ( int  i ) const

inline

Get coordinate.

Definition at line 130 of file OpalParticle.h.

References phase.

double & OpalParticle::pt ( )

inline

Get reference to relative momentum error (no dimension).

Definition at line 125 of file OpalParticle.h.

References phase, and PT.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), MapIntegrator::trackParticle(), OrbitTracker::visitComponent(), ThinTracker::visitRBend(), ThinTracker::visitRFCavity(), ThinTracker::visitSBend(), ThinTracker::visitSeparator(), and ThinTracker::visitSolenoid().

double OpalParticle::pt ( ) const

inline

Get relative momentum error (no dimension).

Definition at line 149 of file OpalParticle.h.

References phase, and PT.

double & OpalParticle::px ( )

inline

Get reference to horizontal momentum (no dimension).

Definition at line 119 of file OpalParticle.h.

References phase, and PX.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), MPSplitIntegrator::applyMultipole(), Tracker::applyThinMultipole(), Tracker::applyThinSBend(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), MapIntegrator::trackParticle(), ThinTracker::visitBeamBeam(), OrbitTracker::visitComponent(), ThinTracker::visitCorrector(), ThinTracker::visitRBend(), ThinTracker::visitSBend(), ThinTracker::visitSeparator(), and ThinTracker::visitSolenoid().

double OpalParticle::px ( ) const

inline

Get horizontal momentum (no dimension).

Definition at line 143 of file OpalParticle.h.

References phase, and PX.

double & OpalParticle::py ( )

inline

Get reference to vertical momentum (no dimension).

Definition at line 122 of file OpalParticle.h.

References phase, and PY.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), MPSplitIntegrator::applyMultipole(), Tracker::applyThinMultipole(), Tracker::applyThinSBend(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), MapIntegrator::trackParticle(), ThinTracker::visitBeamBeam(), OrbitTracker::visitComponent(), ThinTracker::visitCorrector(), ThinTracker::visitRBend(), ThinTracker::visitSBend(), ThinTracker::visitSeparator(), and ThinTracker::visitSolenoid().

double OpalParticle::py ( ) const

inline

Get vertical momentum (no dimension).

Definition at line 146 of file OpalParticle.h.

References phase, and PY.

double & OpalParticle::t ( )

inline

Get reference to longitudinal displacement c*t in m.

Definition at line 116 of file OpalParticle.h.

References phase, and T.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), OrbitTracker::visitComponent(), ThinTracker::visitRBend(), ThinTracker::visitRFCavity(), ThinTracker::visitSBend(), and ThinTracker::visitSolenoid().

double OpalParticle::t ( ) const

inline

Get longitudinal displacement c*t in m.

Definition at line 140 of file OpalParticle.h.

References phase, and T.

double & OpalParticle::x ( )

inline

Get reference to horizontal position in m.

Definition at line 110 of file OpalParticle.h.

References phase, and X.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), MPSplitIntegrator::applyMultipole(), Tracker::applyThinMultipole(), Tracker::applyThinSBend(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), MapIntegrator::trackParticle(), ThinTracker::visitBeamBeam(), OrbitTracker::visitComponent(), ThinTracker::visitRBend(), ThinTracker::visitSBend(), and ThinTracker::visitSolenoid().

double OpalParticle::x ( ) const

inline

Get horizontal position in m.

Definition at line 134 of file OpalParticle.h.

References phase, and X.

double & OpalParticle::y ( )

inline

Get reference to vertical displacement in m.

Definition at line 113 of file OpalParticle.h.

References phase, and Y.

Referenced by MPSplitIntegrator::applyDrift(), ThinTracker::applyDrift(), Tracker::applyDrift(), MPSplitIntegrator::applyMultipole(), Tracker::applyThinMultipole(), Tracker::applyThinSBend(), Tracker::applyTransform(), TrackSave::execute(), PartBunchBase< T, Dim >::maximumAmplitudes(), MapIntegrator::trackParticle(), ThinTracker::visitBeamBeam(), OrbitTracker::visitComponent(), ThinTracker::visitRBend(), ThinTracker::visitSBend(), and ThinTracker::visitSolenoid().

double OpalParticle::y ( ) const

inline

Get vertical displacement in m.

Definition at line 137 of file OpalParticle.h.

References phase, and Y.

Member Data Documentation

double OpalParticle::phase[6]

private

Definition at line 99 of file OpalParticle.h.

Referenced by operator[](), pt(), px(), py(), t(), x(), and y().

---

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

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