CyclotronValley.h

Go to the documentation of this file.

#ifndef CLASSIC_CyclotronValley_HH
#define CLASSIC_CyclotronValley_HH

// ------------------------------------------------------------------------
// $RCSfile: CyclotronValley.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: CyclotronValley
//   Defines the abstract interface for an element modeling the valley of
//   a cyclotron.
//
// ------------------------------------------------------------------------
// Class category: AbsBeamline
// ------------------------------------------------------------------------
//
// $Date: 2010/12/8 09:51:31 $
// $Author: fci $
//
// ------------------------------------------------------------------------


#include "AbsBeamline/Component.h"

class Fieldmap;

// Class CyclotronValley
// ------------------------------------------------------------------------
//  Class CyclotronValley defines the abstract interface for the magnetic field of cyclotron valley.


class CyclotronValley: public Component {

public:


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

    CyclotronValley();
    CyclotronValley(const CyclotronValley &);
    virtual ~CyclotronValley();

    virtual void accept(BeamlineVisitor &) const;


    void setFieldMapFN(std::string fmapfn);

    std::string getFieldMapFN() const;

    void setFast(bool fast);

    bool getFast() const;
    ElementBase::ElementType getType() const;

    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 void initialise(PartBunchBase<double, 3> *bunch, double &startField, double &endField);

    //virtual void initialise(PartBunchBase<double, 3> *bunch);

    virtual void finalise();

    virtual bool bends() const;

    virtual void goOnline(const double &kineticEnergy);

    virtual void goOffline();

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

private:
    std::string filename_m;             
    Fieldmap *fieldmap_m;
    double scale_m;              
    double ElementEdge_m;
    double startField_m;         
    double endField_m;
    bool fast_m;


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

#endif // CLASSIC_CyclotronValley_HH