MultipoleTCurvedVarRadius.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2017, Titus Dascalu
 *  Copyright (c) 2018, Martin Duy Tat
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *  3. Neither the name of STFC nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
 
 
#ifndef CLASSIC_MULTIPOLET_CURVED_VAR_RADIUS_H
#define CLASSIC_MULTIPOLET_CURVED_VAR_RADIUS_H
 
#include "BeamlineGeometry/VarRadiusGeometry.h"
 
#include "AbsBeamline/MultipoleTBase.h"
#include "AbsBeamline/MultipoleTFunctions/RecursionRelationTwo.h"
#include <vector>
 
class MultipoleTCurvedVarRadius: public MultipoleTBase {
public: 
    explicit MultipoleTCurvedVarRadius(const std::string &name);
    MultipoleTCurvedVarRadius(const MultipoleTCurvedVarRadius &right);
    ~MultipoleTCurvedVarRadius();
    virtual ElementBase* clone() const override;
    void accept(BeamlineVisitor &visitor) const override;
    VarRadiusGeometry& getGeometry() override;
    const VarRadiusGeometry& getGeometry() const override;
    virtual void setMaxOrder(const std::size_t &maxOrder) override;
    std::size_t getMaxXOrder() const;
    void setMaxXOrder(const std::size_t &maxXOrder);
    virtual void setBendAngle(const double &angle) override;
    virtual double getBendAngle() const override;
    virtual void initialise(PartBunch_t* bunch,
                            double &startField,
                            double &endField) override;
private:
    MultipoleTCurvedVarRadius operator=(const MultipoleTCurvedVarRadius& rhs);
    std::size_t maxOrderX_m;
    std::vector<polynomial::RecursionRelationTwo> recursion_m;
    VarRadiusGeometry varRadiusGeometry_m;
    virtual void transformCoords(Vector_t<double, 3> &R) override;
    virtual void transformBField(Vector_t<double, 3> &B, const Vector_t<double, 3> &R) override;
    double angle_m;
    virtual double getRadius(const double &s) override;
    virtual double getScaleFactor(const double &x, const double &s) override;
    virtual double getFn(const std::size_t &n,
                         const double &x,
                         const double &s) override;
};
 
inline
    void MultipoleTCurvedVarRadius::accept(BeamlineVisitor &visitor) const {
        visitor.visitMultipoleTCurvedVarRadius(*this);
}
inline
    void MultipoleTCurvedVarRadius::setMaxXOrder(
                                      const std::size_t &maxXorder) {
        maxOrderX_m = maxXorder;
}
inline
    std::size_t MultipoleTCurvedVarRadius::getMaxXOrder() const {
        return maxOrderX_m;
}
inline
    VarRadiusGeometry& MultipoleTCurvedVarRadius::getGeometry() {
        return varRadiusGeometry_m;
}
inline
    const VarRadiusGeometry& MultipoleTCurvedVarRadius::getGeometry() const {
        return varRadiusGeometry_m;
}
inline
    void MultipoleTCurvedVarRadius::setBendAngle(const double &angle) {
        angle_m = angle;
}
inline
    double MultipoleTCurvedVarRadius::getBendAngle() const {
        return angle_m;
}
inline
    void MultipoleTCurvedVarRadius::initialise(PartBunch_t* bunch,
                                               double &/*startField*/,
                                               double &/*endField*/) {
        RefPartBunch_m = bunch;
        double length = getLength();
        varRadiusGeometry_m.setElementLength(2 * getBoundingBoxLength());
        varRadiusGeometry_m.setRadius(length / angle_m);
        varRadiusGeometry_m.setS0(length / 2);
        std::vector<double> fringeLength = getFringeLength();
        varRadiusGeometry_m.setLambdaLeft(fringeLength[0]);
        varRadiusGeometry_m.setLambdaRight(fringeLength[1]);
}
 
#endif