Enge.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_ENGE_H_
#define ENDFIELDMODEL_ENGE_H_

#include <iostream>
#include <vector>

#include "AbsBeamline/EndFieldModel/EndFieldModel.h"

namespace endfieldmodel {

class Enge : public EndFieldModel {
  public:
    Enge() : _a(), _lambda(0.) {setEngeDiffIndices(10);}
    Enge(const std::vector<double> a, double x0, double lambda);

    ~Enge() {}

    Enge* clone() const;

    void rescale(double scaleFactor);

    inline double function(double x, int n) const;

    inline double getEndLength() const;

    inline double getCentreLength() const;

    std::ostream& print(std::ostream& out) const;

    std::vector<double> getCoefficients() const {return _a;}

    void setCoefficients(std::vector<double> a) {_a = a;}

    inline double getLambda() const {return _lambda;}

    inline void setLambda(double lambda) {_lambda = lambda;}

    inline double getX0() const {return _x0;}

    inline void setX0(double x0) {_x0 = x0;}

    inline void setMaximumDerivative(size_t n);

    double getEnge(double x, int n) const;

    inline double getDoubleEnge(double x, int n) const;

    double hN(double x, int n) const;

    double gN(double x, int n) const;

    static void   setEngeDiffIndices(size_t n);

    inline static std::vector< std::vector<int> > getQIndex(int n);

    inline static std::vector< std::vector<int> > getHIndex(int n);
  private:
    Enge(const Enge& enge);
    Enge& operator=(const Enge& enge);
    std::vector<double> _a;
    double              _lambda, _x0;

    static std::vector< std::vector< std::vector<int> > > _q;
    static std::vector< std::vector< std::vector<int> > > _h;
};

void Enge::setMaximumDerivative(size_t n) {
    Enge::setEngeDiffIndices(n);
}

double Enge::function(double x, int n) const {
    return getDoubleEnge(x, n);
}

std::vector< std::vector<int> > Enge::getQIndex(int n) {
  return _q[n];
}

std::vector< std::vector<int> > Enge::getHIndex(int n) {
  return _h[n];
}

double Enge::getDoubleEnge(double x, int n) const {
  if (n == 0) {
    return (getEnge(x-_x0, n)+getEnge(-x-_x0, n))-1.;
  } else {
    if (n%2 != 0) return getEnge(x-_x0, n)-getEnge(-x-_x0, n);
    else          return getEnge(x-_x0, n)+getEnge(-x-_x0, n);
  }
}

double Enge::getCentreLength() const {
  return _x0/2.0;
}

double Enge::getEndLength() const {
  return _lambda;
}
}

#endif