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 "Algorithms/Vektor.h"
#include "AbsBeamline/MultipoleTBase.h"
#include "AbsBeamline/MultipoleTFunctions/RecursionRelationTwo.h"
#include <vector>
 
class MultipoleTCurvedVarRadius: public MultipoleTBase {
public:
    explicit MultipoleTCurvedVarRadius(MultipoleT* element);
    void initialise() override;
    BGeometryBase& getGeometry() override { return varRadiusGeometry_m; }
    const BGeometryBase& getGeometry() const override { return varRadiusGeometry_m; }
    void transformCoords(Vector_t &/*R*/) override;
    void transformBField(Vector_t &/*B*/, const Vector_t &/*R*/) override;
    double getScaleFactor(double x, double s) override;
    double getFn(size_t n, double x, double s) override;
    void setMaxOrder(size_t orderZ, size_t orderX) override;
 
    Vector_t localCartesianToCurvilinear(const Vector_t& r);
    Vector_t curvilinearToLocalCartesian(const Vector_t& r);
    Vector_t localCartesianToOpalCartesian(const Vector_t& r) override;
    double reverseTransformResidual(const Vector_t& r, const Vector_t& target);
    static constexpr size_t ReverseTransformMaxIterations = 1000;
    static constexpr double ReverseTransformTolerance = 1e-6;
    static constexpr double TangentStep = 1e-3;
    double localCartesianRotation() override { return localCartesianRotation_; }
 
private:
    std::vector<polynomial::RecursionRelationTwo> recursion_m;
    VarRadiusGeometry varRadiusGeometry_m;
    Vector_t localCartesianEntryPoint_;
    double localCartesianRotation_{};
};
 
#endif