class BeamBeam : public Component

(Return to index)

Abstract beam-beam interaction.

Class BeamBeam defines the abstract interface for beam-beam interactions.

Type:	Abstract
Superclasses:	public Component
Include file:	./AbsBeamline/BeamBeam.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • BeamBeam (const string&) ;
  • BeamBeam () ;
  • BeamBeam (const BeamBeam&) ;
  • virtual ~BeamBeam () ;
  • virtual void accept (BeamlineVisitor&)const ;
  • virtual double getBunchCharge ()const = 0 ;
  • virtual const Matrix3D& getBunchMoment ()const = 0 ;
  • virtual const Vector3D& getBunchDisplacement ()const = 0 ;
  • virtual EMField& getField () = 0 ;
  • virtual const EMField& getField ()const = 0 ;
  • EVector Efield (const Point3D&)const ;
  • BVector Bfield (const Point3D&)const ;
  • EVector Efield (const Point3D&,double)const ;
  • BVector Bfield (const Point3D&,double)const ;
  • EBVectors EBfield (const Point3D&)const ;
  • EBVectors EBfield (const Point3D&,double)const ;
  • virtual const ElementBase& getDesign ()const ;
  • virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const ;
  • virtual void trackMap (FVps<double,6>&,const PartData&,bool,bool)const ;
  • virtual const string& getName ()const ;
  • virtual void setName (const string&) ;
  • virtual const string& getType ()const = 0 ;
  • virtual Geometry& getGeometry () = 0 ;
  • virtual const Geometry& getGeometry ()const = 0 ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • virtual double getOrigin ()const ;
  • virtual double getEntrance ()const ;
  • virtual double getExit ()const ;
  • virtual Euclid3D getTransform (double,double)const ;
  • virtual Euclid3D getTransform (double)const ;
  • virtual Euclid3D getTotalTransform ()const ;
  • virtual Euclid3D getEntranceFrame ()const ;
  • virtual Euclid3D getExitFrame ()const ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;
  • virtual double getAttribute (const string&)const ;
  • virtual bool hasAttribute (const string&)const ;
  • virtual void removeAttribute (const string&) ;
  • virtual void setAttribute (const string&,double) ;
  • virtual Channel* getChannel (const string&) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementImage* getImage ()const ;
  • virtual ElementBase* clone ()const = 0 ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual void makeSharable () ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;

Documentation:

• Public members:

  BeamBeam (const string&) ;

  Constructor with given name.

  virtual void accept (BeamlineVisitor&)const ;

  Apply visitor to BeamBeam.

  virtual double getBunchCharge ()const = 0 ;

  Get bunch charge.
  Return the number of particles times the particle charge in the opposite bunch. Units are proton charges.

  virtual const Vector3D& getBunchDisplacement ()const = 0 ;

  Get displacement.
  Return the displacement vector for position of opposite bunch. Units are metres.

  virtual const Matrix3D& getBunchMoment ()const = 0 ;

  Get moments.
  Return the moment matrix for the opposite bunch (the matrix of second momenta). Units are square metres.