OpalMultipoleT.h

Go to the documentation of this file.

//
// Class OpalMultipoleT
//   The Opal MultipoleT element.
//
// Copyright (c) 2017 - 2025, Titus Dascalu
//                            Chris Rogers, STFC Rutherford Appleton Laboratory, Didcot, UK
//                            Jon Thompson, STFC Rutherford Appleton Laboratory, Didcot, UK
// 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 OPAL_OPALMULTIPOLET_HH
#define OPAL_OPALMULTIPOLET_HH
 
#include "Elements/OpalElement.h"
 
class OpalMultipoleT final: public OpalElement {
 
public:
    // The attributes of class OpalMultipoleT
    enum {
        TP = COMMON,     // Transverse field components
        // Attributes for a straight multipole
        RFRINGE,         // Length of right fringe field
        LFRINGE,         // Length of left fringe field
        HAPERT,          // Aperture horizontal dimension
        VAPERT,          // Aperture vertical dimension
        MAXFORDER,       // Maximum order in the field expansion
        ROTATION,        // Rotation angle about central axis for skew elements
        EANGLE,          // Entrance angle
        BBLENGTH,        // Length within which field is calculated
        // Further attributes for a constant radius curved multipole
        ANGLE,           // Bending angle of a sector magnet
        MAXXORDER,       // Maximum order in x in polynomial expansions
        // Further attributes for a variable radius multipole
        VARRADIUS,       // Variable radius flag
        ENTRYOFFSET,     // Longitudinal offset from standard entrance point
        // Time dependence
        SCALING_MODEL,   // Name of a time dependence object
        SIZE             // size of the enum
    };

    OpalMultipoleT();

    OpalMultipoleT* clone(const std::string& name) override;

    void update() override;
 
    void print(std::ostream& os) const override;
 
private:
    // Not implemented.
    OpalMultipoleT(const OpalMultipoleT&) = delete;
    void operator=(const OpalMultipoleT&) = delete;

    static constexpr double DefaultMAXFORDER = 3.0;
    static constexpr double MinimumMAXFORDER = 1.0;
    static constexpr double MaximumMAXFORDER = 20.0;
    static constexpr double DefaultMAXXORDER = 20.0;
 
    // Clone constructor.
    OpalMultipoleT(const std::string& name, OpalMultipoleT* parent);
};
 
#endif // OPAL_OpalMultipoleT_HH