class BeamBeam3D : public BeamBeam

(Return to index)

A concrete representation for a beam-beam interaction.

The ``strong'' bunch has a Gaussian distribution of the form

N(x,y,s) = c * exp(- transpose(z - delta) sigma**(-1) (z - delta)),

1. z: position vector in space,
2. delta: centroid of strong bunch in global reference system,
3. sigma: "beam" matrix in the TRANSPORT sense,
4. c: a normalising factor, such that the total charge is Q,
5. sigma(i,i): standard deviation sigma(i) in direction i,
6. r(i,j): = sigma(i,j) / sqrt(sigma(i,i)*sigma(i,j)), correlations between phase space coordinates i and j .

Type:	Instantiable
Superclasses:	public BeamBeam
Include file:	./Algorithms/BeamBeam3D.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • struct Beta ;
  • BeamBeam3D (const string&) ;
  • BeamBeam3D () ;
  • BeamBeam3D (const BeamBeam3D&) ;
  • virtual ~BeamBeam3D () ;
  • virtual void accept (BeamlineVisitor&)const ;
  • virtual ElementBase* clone ()const ;
  • virtual Channel* getChannel (const string&) ;
  • virtual NullField& getField () ;
  • virtual const NullField& getField ()const ;
  • virtual NullGeometry& getGeometry () ;
  • virtual const NullGeometry& getGeometry ()const ;
  • virtual ElementImage* getImage ()const ;
  • virtual const string& getType ()const ;
  • virtual double getBunchCharge ()const ;
  • virtual const Matrix3D& getBunchMoment ()const ;
  • virtual const Vector3D& getBunchDisplacement ()const ;
  • void setErrorFunctionPointer (std::complex<double>*(std::complex<double>)) ;
  • void setCrossingAngle (double) ;
  • void setBeamBeamParameter (double) ;
  • void setBeamDescription (const Vector3D&,const Beta&) ;
  • void setSlices (int) ;
  • virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const ;
  • virtual void trackMap (Map&,const PartData&,bool,bool)const ;

Documentation:

• Public members:

  BeamBeam3D (const string&) ;

  Constructor with given name.

  struct Beta ;

  Collection of lattice functions and emittances.

  virtual void accept (BeamlineVisitor&)const ;

  Apply visitor to BeamBeam.

  virtual ElementBase* clone ()const ;

  Return exact copy of the element.

  virtual double getBunchCharge ()const ;

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

  virtual const Vector3D& getBunchDisplacement ()const ;

  Get displacement vector for the strong bunch.
  Return the displacement in metres.

  virtual const Matrix3D& getBunchMoment ()const ;

  Get the moment matrix for the strong bunch.
  Return matrix of second momenta. Units are square metres.

  virtual Channel* getChannel (const string&) ;

  Return a channel to an attribute.

  virtual NullField& getField () ;

  Return the zero electromagnetic field.

  virtual const NullField& getField ()const ;

  Return the zero electromagnetic field. Version for const object.

  virtual NullGeometry& getGeometry () ;

  Return the null geometry.

  virtual const NullGeometry& getGeometry ()const ;

  Return the null geometry. Version for const object.

  virtual ElementImage* getImage ()const ;

  Return an image of the element.

  virtual const string& getType ()const ;

  Return type name string.

  void setBeamBeamParameter (double) ;

  Set the proportionality factor.

  void setBeamDescription (const Vector3D&,const Beta&) ;

  Store the description of the strong beam.
  disp is the displacement of the closed orbit of the strong beam. latFun is the collection of lattice functions and emittances of the strong beam.

  void setCrossingAngle (double) ;

  Set the crossing angle.

  void setErrorFunctionPointer (std::complex<double>*(std::complex<double>)) ;

  Set the pointer to the complex error function.
  Changing this pointer allows use of a different, potentially faster algorithm for determination of the kick.

  void setSlices (int) ;

  Select number of slices for strong beam.

  virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const ;

  Track a particle bunch.

  virtual void trackMap (Map&,const PartData&,bool,bool)const ;

  Track a transfer map.