Corrector.h

Go to the documentation of this file.

#ifndef OPALX_Corrector_HH
#define OPALX_Corrector_HH
 
// ------------------------------------------------------------------------
// $RCSfile: Corrector.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Corrector
//   Defines the abstract interface for a orbit corrector.
//
// ------------------------------------------------------------------------
// Class category: AbsBeamline
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:32:31 $
// $Author: fci $
//
// ------------------------------------------------------------------------
 
#include "AbsBeamline/BeamlineVisitor.h"
#include "AbsBeamline/Component.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/BDipoleField.h"
 
// Class Corrector
// ------------------------------------------------------------------------
//  Class Corrector defines the abstract interface for closed orbit
//  correctors.
 
class Corrector : public Component {
public:
    enum Plane {
        OFF,
        X,
        Y,
        XY
    };
 
    explicit Corrector(const std::string& name);
 
    Corrector();
    Corrector(const Corrector& right);
    virtual ~Corrector();
 
    virtual void accept(BeamlineVisitor&) const;
 
    //  Version for non-constant object.
    virtual BDipoleField& getField() = 0;
 
    //  Version for constant object.
    virtual const BDipoleField& getField() const = 0;
 
    virtual StraightGeometry& getGeometry() = 0;
 
    virtual const StraightGeometry& getGeometry() const = 0;
 
    virtual Plane getPlane() const = 0;
 
    virtual bool apply(
            const size_t& i, const double& t, Vector_t<double, 3>& E, Vector_t<double, 3>& B);
 
    virtual bool apply(
            const Vector_t<double, 3>& R, const Vector_t<double, 3>& P, const double& t,
            Vector_t<double, 3>& E, Vector_t<double, 3>& B);
 
    virtual void initialise(PartBunch_t* bunch, double& startField, double& endField);
 
    virtual void goOnline(const double& kineticEnergy);
 
    virtual void finalise();
 
    virtual bool bends() const;
 
    virtual ElementType getType() const;
 
    virtual void getFieldExtend(double& zBegin, double& zEnd) const;
 
    void setKickX(double k);
 
    void setKickY(double k);
 
    virtual void setDesignEnergy(const double& ekin, bool changeable = true);
 
    double getKickX() const;
 
    double getKickY() const;
 
    void setKickField(const Vector_t<double, 3>& k0);
 
private:
    double kickX_m;
    double kickY_m;
    double designEnergy_m;
    bool designEnergyChangeable_m;
    bool kickFieldSet_m;
 
    Vector_t<double, 3> kickField_m;
 
protected:
    // Not implemented.
    void operator=(const Corrector&);
 
    Plane plane_m;
};
 
inline void Corrector::setKickX(double k) { kickX_m = k; }
 
inline void Corrector::setKickY(double k) { kickY_m = k; }
 
inline double Corrector::getKickX() const { return kickX_m; }
 
inline double Corrector::getKickY() const { return kickY_m; }
 
inline void Corrector::setKickField(const Vector_t<double, 3>& k0) {
    kickField_m    = k0;
    kickFieldSet_m = true;
}
#endif  // OPALX_Corrector_HH