OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Protected Attributes | List of all members
BendBase Class Referenceabstract

#include <BendBase.h>

Inheritance diagram for BendBase:
Inheritance graph
[legend]
Collaboration diagram for BendBase:
Collaboration graph
[legend]

Public Member Functions

 BendBase ()
 
 BendBase (const BendBase &)
 
 BendBase (const std::string &)
 
virtual bool bends () const
 Indicates that element bends the beam. More...
 
void setLength (double length)
 
double getLength () const
 
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_tgetDesignPath () 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 EMFieldgetField ()=0
 Return field. More...
 
virtual const EMFieldgetField () 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 void addKR (int i, double t, Vector_t &K)
 
virtual void addKT (int i, double t, Vector_t &K)
 
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 &R, const double &t, Vector_t &A, double &phi)
 
virtual void initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0
 
virtual void finalise ()=0
 
virtual void goOnline (const double &kineticEnergy)
 
virtual void goOffline ()
 
virtual bool Online ()
 
virtual void getDimensions (double &zBegin, double &zEnd) const =0
 
virtual ElementBase::ElementType getType () const
 Get element type std::string. More...
 
virtual void setComponentType (std::string)
 
virtual std::string getComponentType () const
 
virtual const ElementBasegetDesign () 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...
 
std::string getTypeString () const
 
virtual BGeometryBasegetGeometry ()=0
 Get geometry. More...
 
virtual const BGeometryBasegetGeometry () 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 ChannelgetChannel (const std::string &aKey, bool create=false)
 Construct a read/write channel. More...
 
virtual const ConstChannelgetConstChannel (const std::string &aKey) const
 Construct a read-only channel. More...
 
virtual ElementImagegetImage () const
 Construct an image. More...
 
virtual void accept (BeamlineVisitor &visitor) const =0
 Apply visitor. More...
 
virtual ElementBaseclone () const =0
 Return clone. More...
 
virtual ElementBasecopyStructure ()
 Make a structural copy. More...
 
bool isSharable () const
 Test if the element can be shared. More...
 
virtual void makeSharable ()
 Set sharable flag. More...
 
virtual ElementBasemakeAlignWrapper ()
 Allow misalignment. More...
 
virtual ElementBasemakeFieldWrapper ()
 Allow field errors. More...
 
virtual ElementBasemakeWrappers ()
 Allow errors. More...
 
virtual ElementBaseremoveAlignWrapper ()
 Remove align wrapper. More...
 
virtual const ElementBaseremoveAlignWrapper () const
 Remove align wrapper. More...
 
virtual ElementBaseremoveFieldWrapper ()
 Remove field wrapper. More...
 
virtual const ElementBaseremoveFieldWrapper () const
 Remove field wrapper. More...
 
virtual ElementBaseremoveWrappers ()
 Return the design element. More...
 
virtual const ElementBaseremoveWrappers () const
 Return the design element. More...
 
bool update (const AttributeSet &)
 Update element. More...
 
virtual void setBoundaryGeometry (BoundaryGeometry *geo)
 
virtual BoundaryGeometrygetBoundaryGeometry () 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 WakeFunctiongetWake () 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
 
ElemType getElType () const
 returns element type as enumeration needed in the envelope tracker More...
 
void setElType (ElemType elt)
 set the element type as enumeration needed in the envelope tracker More...
 
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
< ElementBase::ApertureType,
std::vector< double > > 
getAperture () const
 
virtual bool isInside (const Vector_t &r) const
 
void setMisalignment (double x, double y, double s)
 
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
 
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...
 

Protected Attributes

double length_m
 
double chordLength_m
 
double angle_m
 
double entranceAngle_m
 
double gap_m
 Angle between incoming reference trajectory. More...
 
double designEnergy_m
 
bool designEnergyChangeable_m
 Bend design energy (eV). More...
 
std::vector< Vector_trefTrajMap_m
 Map of reference particle trajectory. More...
 
double bX_m
 
double bY_m
 
double fieldAmplitude_m
 
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
 

Additional Inherited Members

- Public Types inherited from ElementBase
enum  ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
 
enum  ElementType {
  ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,
  BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,
  CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,
  DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,
  LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,
  MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,
  PARALLELPLATE, PATCH, PROBE, RBEND,
  RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,
  RING, SBEND3D, SBEND, SBENDWRAPPER,
  SEPARATOR, SEPTUM, SOLENOID, SOURCE,
  STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY
}
 
- Static Public Member Functions inherited from ElementBase
static std::string getTypeString (ElementType type)
 
- Protected Member Functions inherited from ElementBase
bool isInsideTransverse (const Vector_t &r, double f=1) const
 
- Protected Member Functions inherited from RCObject
 RCObject ()
 Default constructor. More...
 
 RCObject (const RCObject &)
 Copy constructor. More...
 
virtual ~RCObject ()=0
 
RCObjectoperator= (const RCObject &right)
 
- Static Protected Attributes inherited from Component
static const std::vector< double > defaultAperture_m
 

Detailed Description

Definition at line 9 of file BendBase.h.

Constructor & Destructor Documentation

BendBase::BendBase ( )

Definition at line 3 of file BendBase.cpp.

BendBase::BendBase ( const BendBase right)

Definition at line 7 of file BendBase.cpp.

References isDipole, and ElementBase::setElType().

Here is the call graph for this function:

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

Definition at line 25 of file BendBase.cpp.

References isDipole, and ElementBase::setElType().

Here is the call graph for this function:

Member Function Documentation

bool BendBase::bends ( ) const
inlinevirtual

Indicates that element bends the beam.

Implements Component.

Reimplemented in RBend3D, and SectorFieldMapComponent.

Definition at line 60 of file BendBase.h.

double BendBase::getBendAngle ( ) const
inline
double BendBase::getChordLength ( ) const
inline

Definition at line 76 of file BendBase.h.

References chordLength_m.

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

double BendBase::getDesignEnergy ( ) const
inlinevirtual

Reimplemented from Component.

Definition at line 120 of file BendBase.h.

References designEnergy_m.

Referenced by OpalBeamline::activateElements(), and ThickTracker::visitSBend().

std::vector< Vector_t > BendBase::getDesignPath ( ) const

Definition at line 43 of file BendBase.cpp.

References refTrajMap_m.

Referenced by OpalBeamline::compute3DLattice(), and OpalBeamline::save3DLattice().

double BendBase::getEntranceAngle ( ) const
inline
virtual double BendBase::getExitAngle ( ) const
pure virtual

Implemented in Bend2D, and RBend3D.

double BendBase::getFieldAmplitude ( ) const
inline

Definition at line 131 of file BendBase.h.

References fieldAmplitude_m.

Referenced by RBend::addKR(), and RBend::addKT().

std::string BendBase::getFieldMapFN ( ) const
inline

Definition at line 142 of file BendBase.h.

References fileName_m.

double BendBase::getFullGap ( ) const
inline

Definition at line 107 of file BendBase.h.

References gap_m.

Referenced by Bend2D::getSurfaceMesh().

double BendBase::getLength ( ) const
inline

Definition at line 70 of file BendBase.h.

References length_m.

Referenced by SBend::findChordLength(), and RBend::findChordLength().

void BendBase::setBendAngle ( double  angle)
inlinevirtual

Reimplemented in RBend.

Definition at line 81 of file BendBase.h.

References angle_m.

Referenced by RBend::setBendAngle(), OpalSBend::update(), and OpalRBend3D::update().

void BendBase::setDesignEnergy ( const double &  energy,
bool  changeable = true 
)
inlinevirtual

Reimplemented from Component.

Definition at line 112 of file BendBase.h.

References abs(), designEnergy_m, and designEnergyChangeable_m.

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

Here is the call graph for this function:

void BendBase::setEntranceAngle ( double  entranceAngle)
inlinevirtual

Reimplemented in RBend.

Definition at line 91 of file BendBase.h.

References entranceAngle_m.

Referenced by RBend::setEntranceAngle(), Bend2D::setupBendGeometry(), OpalSBend::update(), and OpalRBend3D::update().

void BendBase::setFieldAmplitude ( double  k0,
double  k0s 
)
inline

Definition at line 125 of file BendBase.h.

References bX_m, and bY_m.

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

void BendBase::setFieldMapFN ( std::string  fileName)
inline

Definition at line 137 of file BendBase.h.

References fileName_m.

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

void BendBase::setFullGap ( double  gap)
inline

Definition at line 102 of file BendBase.h.

References abs(), and gap_m.

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

Here is the call graph for this function:

void BendBase::setLength ( double  length)
inline

Definition at line 65 of file BendBase.h.

References abs(), and length_m.

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

Here is the call graph for this function:

Member Data Documentation

double BendBase::angle_m
protected
double BendBase::bX_m
protected
double BendBase::bY_m
protected
double BendBase::chordLength_m
protected
double BendBase::designEnergy_m
protected
bool BendBase::designEnergyChangeable_m
protected

Bend design energy (eV).

Definition at line 48 of file BendBase.h.

Referenced by setDesignEnergy().

double BendBase::entranceAngle_m
protected
double BendBase::fieldAmplitude_m
protected
std::string BendBase::fileName_m
protected
double BendBase::gap_m
protected
double BendBase::length_m
protected
std::vector<Vector_t> BendBase::refTrajMap_m
protected

Map of reference particle trajectory.

Definition at line 50 of file BendBase.h.

Referenced by Bend2D::calculateRefTrajectory(), and getDesignPath().


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