Multipole.h

Go to the documentation of this file.

//
// Class Multipole
//   The MULTIPOLE element defines a thick multipole.
//
// Copyright (c) 2012-2021, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//

#ifndef CLASSIC_Multipole_HH
#define CLASSIC_Multipole_HH

#include "AbsBeamline/Component.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/BMultipoleField.h"
#include "Fields/Definitions.h"

template <class T, unsigned Dim>
class PartBunchBase;

// Class Multipole
// ------------------------------------------------------------------------
//  Class Multipole defines the abstract interface for magnetic multipoles.
//  The order n of multipole components runs from 1 to N and is dynamically
//  adjusted. It is connected with the number of poles by the table
//
//  [tab 2 b]
//  [ROW]1[&]dipole[/ROW]
//  [ROW]2[&]quadrupole[/ROW]
//  [ROW]3[&]sextupole[/ROW]
//  [ROW]4[&]octupole[/ROW]
//  [ROW]5[&]decapole[/ROW]
//  [ROW]n[&]multipole with 2*n poles[/ROW]
//  [/TAB]
//  Units for multipole strengths are Teslas / m**(n-1).

class Multipole: public Component {

public:

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

    Multipole();
    Multipole(const Multipole &);
    virtual ~Multipole();

    virtual void accept(BeamlineVisitor &) const override;


    virtual BMultipoleField &getField() override = 0;

    virtual const BMultipoleField &getField() const override = 0;

    //  Return the normal component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the return value is zero.
    double getNormalComponent(int n) const;

    //  Return the skew component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the return value is zero.
    double getSkewComponent(int n) const;

    //  Set the normal component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the component is created.
    void setNormalComponent(int, double);

    //  Set the normal component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the component is created.
    void setNormalComponent(int, double, double);

    //  Set the skew component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the component is created.
    void setSkewComponent(int, double);

    //  Set the skew component of order [b]n[/b] in T/m**(n-1).
    //  If [b]n[/b] is larger than the maximum order, the component is created.
    void setSkewComponent(int, double, double);

    size_t getMaxNormalComponentIndex() const;
    size_t getMaxSkewComponentIndex() const;

    //set number of slices for map tracking
    void setNSlices(const std::size_t& nSlices);

    //set number of slices for map tracking
    std::size_t getNSlices() const;

    bool isFocusing(unsigned int component) const;

    virtual StraightGeometry &getGeometry() override = 0;

    virtual const StraightGeometry &getGeometry() const override = 0;

    virtual bool apply(const size_t &i, const double &t, Vector_t &E, Vector_t &B) override;

    virtual bool apply(const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override;

    virtual bool applyToReferenceParticle(const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override;

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

    virtual void finalise() override;

    virtual bool bends() const override;

    virtual ElementType getType() const override;

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

    virtual bool isInside(const Vector_t &r) const override;
private:
    void computeField(Vector_t R, Vector_t &E, Vector_t &B);

    // Not implemented.
    void operator=(const Multipole &);
    std::vector<double> NormalComponents;
    std::vector<double> NormalComponentErrors;
    std::vector<double> SkewComponents;
    std::vector<double> SkewComponentErrors;
    int max_SkewComponent_m;
    int max_NormalComponent_m;
    std::size_t nSlices_m;
};

inline
void Multipole::setNormalComponent(int n, double v) {
    setNormalComponent(n, v, 0.0);
}

inline
void Multipole::setSkewComponent(int n, double v) {
    setSkewComponent(n, v, 0.0);
}

inline
size_t Multipole::getMaxNormalComponentIndex() const {
    return NormalComponents.size();
}

inline
size_t Multipole::getMaxSkewComponentIndex() const {
    return SkewComponents.size();
}

#endif // CLASSIC_Multipole_HH