MultipoleTStraight.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_STRAIGHT_H
#define CLASSIC_MULTIPOLET_STRAIGHT_H
 
#include "BeamlineGeometry/StraightGeometry.h"
#include "AbsBeamline/MultipoleTBase.h"
#include <vector>
 
class MultipoleTStraight: public MultipoleTBase {
public: 
    explicit MultipoleTStraight(const std::string &name);
    MultipoleTStraight(const MultipoleTStraight &right);
    ~MultipoleTStraight();
    virtual ElementBase* clone() const override;
    void accept(BeamlineVisitor &visitor) const override;
    virtual void setMaxOrder(const std::size_t &maxOrder) override;
    StraightGeometry& getGeometry() override;
    const StraightGeometry& getGeometry() const override;
    virtual void initialise(PartBunch_t* bunch,
                            double &startField,
                            double &endField) override;
private:
    MultipoleTStraight operator=(const MultipoleTStraight &rhs);
    StraightGeometry straightGeometry_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;
    virtual double getRadius(const double &s) override;
    virtual double getScaleFactor(const double &x, const double &s) override;
    virtual double getBx (const Vector_t<double, 3> &R) override;
    virtual double getBs (const Vector_t<double, 3> &R) override;
    virtual double getFn(const std::size_t &n,
                         const double &x,
                         const double &s) override;
};
 
inline
    void MultipoleTStraight::accept(BeamlineVisitor &visitor) const {
        visitor.visitMultipoleTStraight(*this);
}
inline
    void MultipoleTStraight::transformBField(Vector_t<double, 3> &/*B*/, const Vector_t<double, 3> &/*R*/) {
}
inline
    double MultipoleTStraight::getRadius(const double &/*s*/) {
        return 1e300;
}
inline
    double MultipoleTStraight::getScaleFactor(const double &/*x*/,
                                              const double &/*s*/) {
    return 1.0;
}
inline
    StraightGeometry& MultipoleTStraight::getGeometry() {
        return straightGeometry_m;
}
inline
    const StraightGeometry& MultipoleTStraight::getGeometry() const {
        return straightGeometry_m;
}
inline
    void MultipoleTStraight::initialise(PartBunch_t* bunch,
                                        double &/*startField*/,
                                        double &/*endField*/) {
        RefPartBunch_m = bunch;
        straightGeometry_m.setElementLength(2 * getBoundingBoxLength());
}
 
#endif