BeamBeam.h

Go to the documentation of this file.

#ifndef CLASSIC_BeamBeam_HH
#define CLASSIC_BeamBeam_HH

// ------------------------------------------------------------------------
// $RCSfile: BeamBeam.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: BeamBeam
//   Defines the abstract interface for a beam-beam interaction.
//
// ------------------------------------------------------------------------
// Class category: AbsBeamline
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:32:31 $
// $Author: fci $
//
// ------------------------------------------------------------------------

#include "AbsBeamline/Component.h"


class Matrix3D;
class Vector3D;


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


class BeamBeam: public Component {

public:

    explicit BeamBeam(const std::string &name);

    BeamBeam();
    BeamBeam(const BeamBeam &right);
    virtual ~BeamBeam();

    virtual void accept(BeamlineVisitor &) const;

    //  Return the number of particles times the particle charge in the
    //  opposite bunch.  Units are proton charges.
    virtual double getBunchCharge() const = 0;

    //  Return the moment matrix for the opposite bunch
    //  (the matrix of second momenta).  Units are square metres.
    virtual const Matrix3D &getBunchMoment() const = 0;

    //  Return the displacement vector for position of opposite bunch.
    //  Units are metres.
    virtual const Vector3D &getBunchDisplacement() const = 0;

    virtual void initialise(PartBunchBase<double, 3> *bunch, double &startField, double &endField);

    virtual void finalise();

    virtual bool bends() const;

    virtual ElementBase::ElementType getType() const;

    virtual void getDimensions(double &zBegin, double &zEnd) const;

private:

    // Not implemented.
    void operator=(const BeamBeam &);
};

#endif // CLASSIC_BeamBeam_HH