AsymmetricEnge.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2017, Chris Rogers
 *  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 ENDFIELDMODEL_ASYMMETRICENGE_H_
#define ENDFIELDMODEL_ASYMMETRICENGE_H_
 
#include <iostream>
#include <memory>
#include <vector>
 
#include "AbsBeamline/EndFieldModel/EndFieldModel.h"
#include "AbsBeamline/EndFieldModel/Enge.h"
 
namespace endfieldmodel {
 
    class AsymmetricEnge : public EndFieldModel {
    public:
        AsymmetricEnge();
        AsymmetricEnge(
                const std::vector<double> aStart, double x0Start, double lambdaStart,
                const std::vector<double> aEnd, double x0End, double lambdaEnd);
 
        inline AsymmetricEnge* clone() const;
 
        std::ostream& print(std::ostream& out) const;
 
        inline double function(double x, int n) const;
 
        inline double getCentreLength() const;
 
        inline double getEndLength() const;
 
        inline std::shared_ptr<Enge> getEngeStart() const;
 
        inline void setEngeStart(std::shared_ptr<Enge> eStart);
 
        inline std::shared_ptr<Enge> getEngeEnd() const;
 
        inline void setEngeEnd(std::shared_ptr<Enge> eEnd);
 
        inline double getX0Start() const;
 
        inline void setX0Start(double x0);
 
        inline double getX0End() const;
 
        inline void setX0End(double x0);
 
        inline void setMaximumDerivative(size_t n);
 
        void rescale(double scaleFactor);
 
    private:
        AsymmetricEnge(const AsymmetricEnge& rhs);
        std::shared_ptr<Enge> engeStart_m;
        std::shared_ptr<Enge> engeEnd_m;
    };
 
    std::shared_ptr<Enge> AsymmetricEnge::getEngeStart() const { return engeStart_m; }
    std::shared_ptr<Enge> AsymmetricEnge::getEngeEnd() const { return engeEnd_m; }
    void AsymmetricEnge::setEngeStart(std::shared_ptr<Enge> enge) { engeStart_m = enge; }
    void AsymmetricEnge::setEngeEnd(std::shared_ptr<Enge> enge) { engeEnd_m = enge; }
 
    double AsymmetricEnge::getX0Start() const { return engeStart_m->getX0(); }
 
    double AsymmetricEnge::getX0End() const { return engeEnd_m->getX0(); }
 
    void AsymmetricEnge::setX0Start(double x0) { engeStart_m->setX0(x0); }
 
    void AsymmetricEnge::setX0End(double x0) { engeEnd_m->setX0(x0); }
 
    double AsymmetricEnge::function(double x, int n) const {
        // f(x) = E(x-x0) + E(-x-x0) - 1
        // f^{(2n)} = E^{(2n)}(x-x0) + E^{(2n)}(-x-x0)
        // f^{(2n+1)} = E^{(2n)}(x-x0) - E^{(2n)}(-x-x0)
        if (n == 0) {
            return engeStart_m->getEnge(x - engeStart_m->getX0(), n)
                   + engeEnd_m->getEnge(-x - engeEnd_m->getX0(), n) - 1;
        } else if (n % 2) {
            return engeStart_m->getEnge(x - engeStart_m->getX0(), n)
                   - engeEnd_m->getEnge(-x - engeEnd_m->getX0(), n);
        } else {
            return engeStart_m->getEnge(x - engeStart_m->getX0(), n)
                   + engeEnd_m->getEnge(-x - engeEnd_m->getX0(), n);
        }
    }
 
    AsymmetricEnge* AsymmetricEnge::clone() const { return new AsymmetricEnge(*this); }
 
    void AsymmetricEnge::setMaximumDerivative(size_t n) { Enge::setEngeDiffIndices(n); }
 
    double AsymmetricEnge::getCentreLength() const {
        return (engeStart_m->getCentreLength() + engeEnd_m->getCentreLength()) / 2;
    }
 
    double AsymmetricEnge::getEndLength() const {
        return (engeStart_m->getEndLength() + engeEnd_m->getEndLength()) / 2;
    }
}  // namespace endfieldmodel
 
#endif