AbstractMapper.h

Go to the documentation of this file.

#ifndef CLASSIC_AbstractMapper_HH
#define CLASSIC_AbstractMapper_HH

// ------------------------------------------------------------------------
// $RCSfile: AbstractMapper.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1.2.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: AbstractMapper
//
// ------------------------------------------------------------------------
// Class category: Algorithms
// ------------------------------------------------------------------------
//
// $Date: 2004/11/12 18:57:53 $
// $Author: adelmann $
//
// ------------------------------------------------------------------------

#include "Algorithms/DefaultVisitor.h"
#include "Algorithms/PartData.h"

class BMultipoleField;
template <class T, int N> class LinearMap;
template <class T, int N> class FTps;
template <class T, int N> class FVps;


// Class AbstractMapper
// ------------------------------------------------------------------------
//  An abstract visitor class implementing the default behaviour for all
//  visitors capable of tracking a transfer map through a beam line.
//  It implements access to the accumulated map, and keeps track of the
//  beam reference data.
//  This class redefines all visitXXX() methods for elements as pure
//  to force their implementation in derived classes.

class AbstractMapper: public DefaultVisitor {

public:

    // Particle coordinate numbers.
    enum { X, PX, Y, PY, T, PT };

    //  The beam line to be tracked is [b]bl[/b].
    //  The particle reference data are taken from [b]data[/b].
    //  If [b]revBeam[/b] is true, the beam runs from s = C to s = 0.
    //  If [b]revTrack[/b] is true, we track against the beam.
    AbstractMapper(const Beamline &bl, const PartData &data,
                   bool revBeam, bool revTrack);

    virtual ~AbstractMapper();


    virtual void getMap(LinearMap<double, 6> &) const = 0;

    virtual void getMap(FVps<double, 6> &) const = 0;

    virtual void setMap(const LinearMap<double, 6> &) = 0;

    virtual void setMap(const FVps<double, 6> &) = 0;

protected:

    FTps<double, 6> buildMultipoleVectorPotential(const BMultipoleField &);

    FTps<double, 6> buildSBendVectorPotential(const BMultipoleField &, double h);

    const PartData itsReference;

private:

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

#endif // CLASSIC_AbstractMapper_HH