SBendRep.h

Go to the documentation of this file.

//
// Class SBendRep
//   Representation for a sector bend magnet.
//   A sector bend magnet has a planar arc geometry about which its
//   multipole components are specified.
//
// Copyright (c) 200x - 2020, 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_SBendRep_HH
#define CLASSIC_SBendRep_HH

#include "AbsBeamline/SBend.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
#include "Fields/BMultipoleField.h"


class SBendRep: public SBend {

public:

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

    SBendRep();
    SBendRep(const SBendRep &);
    virtual ~SBendRep();

    //  Return an identical deep copy of the element.
    virtual ElementBase *clone() const;

    //  This method constructs a Channel permitting read/write access to
    //  the attribute [b]aKey[/b] and returns it.
    //  If the attribute does not exist, it returns nullptr.
    virtual Channel *getChannel(const std::string &aKey, bool = false);

    //  Version for non-constant object.
    virtual BMultipoleField &getField();

    //  Version for constant object.
    virtual const BMultipoleField &getField() const;

    //  Version for non-constant object.
    virtual PlanarArcGeometry &getGeometry();

    //  Version for constant object.
    virtual const PlanarArcGeometry &getGeometry() const;

    //  Return the vertical component of the field in Teslas.
    virtual double getB() const;

    //  Assign the vertical component of the field in Teslas.
    virtual void setB(double By);

    //  Assign the multipole expansion.
    virtual void setField(const BMultipoleField &field);

    //  Return the rotation of the entry pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual double getEntryFaceRotation() const;

    //  Return the rotation of the exit pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual double getExitFaceRotation() const;

    //  Return the curvature of the entry pole face.
    //  A positive curvature creates a convex pole face.
    virtual double getEntryFaceCurvature() const;

    //  Return the curvature of the exit pole face.
    //  A positive curvature creates a convex pole face.
    virtual double getExitFaceCurvature() const;

    //  Return the rotation of the entry pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual void setEntryFaceRotation(double e1);

    //  Return the rotation of the exit pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual void setExitFaceRotation(double e2);

    //  Return the curvature of the entry pole face.
    //  A positive curvature creates a convex pole face.
    virtual void setEntryFaceCurvature(double h1);

    //  Return the curvature of the exit pole face.
    //  A positive curvature creates a convex pole face.
    virtual void setExitFaceCurvature(double h2);

    virtual double getSlices() const;

    virtual double getStepsize() const;

    virtual void setSlices(double sl);

    virtual void setStepsize(double ds);

private:

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

    PlanarArcGeometry geometry;

    BMultipoleField field;

    // The pole face angles and curvatures.
    double rEntry;
    double rExit;
    double hEntry;
    double hExit;

    // Parameters that determine integration step-size.
    double slices;
    double stepsize;
};

#endif // CLASSIC_SBendRep_HH