CorrectionBase.h

Go to the documentation of this file.

#ifndef OPAL_CorrectionBase_HH
#define OPAL_CorrectionBase_HH

// ------------------------------------------------------------------------
// $RCSfile: CorrectionBase.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.2 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Classes: CorrectionBase
//
// ------------------------------------------------------------------------
//
// $Date: 2001/08/13 15:25:22 $
// $Author: jowett $
//
// ------------------------------------------------------------------------

#include "AbstractObjects/Action.h"
#include "Algorithms/PartData.h"
#include "Beamlines/FlaggedElmPtr.h"
#include "Beamlines/TBeamline.h"
#include "FixedAlgebra/FMatrix.h"
#include "FixedAlgebra/FVector.h"


#include <list>

class ElementBase;


// Class CorrectionBase
// ------------------------------------------------------------------------
//  Factors out all common behaviour for these algorithms.
//  A CorrectionBase contains a RBeamline<CorrectionBase::Row> which
//  holds pointers to the elements in the line, together with the ideal
//  transfer matrices from the beginning to the current position and the
//  orbit computed from the algorithm.  This information is used to find
//  the required corrections.  This class also contains a method to set
//  the orbit corrector strength once it has been found.

class CorrectionBase: public Action {

public:

    virtual ~CorrectionBase();

protected:

    enum {
        // User-definable attributes:
        LINE,        // The beam line for the table,
        BEAM,        // The beam to be used.
        RANGE,       // The range in the lattice.
        SIZE
    };

    struct Row: public FlaggedElmPtr {

        Row(ElementBase *, int);
        explicit Row(const FlaggedElmPtr &);
        ~Row();

        FVector<double, 6> orbit;

        FMatrix<double, 6, 6> matrix;

        double arc;

        bool isUsed[2];
    };

    // The contained beamline type.
    typedef TBeamline<Row> TLine;


    CorrectionBase(int size, const char *name, const char *help);

    CorrectionBase(const std::string &name, CorrectionBase *parent);

    //  Arguments:
    //  [ol]
    //  [li] The plane: (0 = x, 1 = y).
    //  [li] The position, given by an iterator into the Twiss table.
    //  [li] The kick change.
    //  [/ol]
    void addKick(int plane, Row &, double kick);

    void listCorrectors(bool list, int plane);

    void listMonitors(bool list, int plane);

    void setupTables();

    void test(ElementBase *);


    TLine itsLine;

    PartData reference;

    FVector<double, 6> orbitGuess;

    bool isCorr[2];

    bool isMoni[2];

    // Types used for corrector and monitor tables.
    typedef std::list<Row *> LocalList;
    typedef LocalList::iterator LocalIter;

    // The table of correctors per plane.
    LocalList correctorTable[2];

    // The table of monitors per plane.
    LocalList monitorTable[2];

private:

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

#endif // OPAL_CorrectionBase_HH