Tanh.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_TANH_H_
#define ENDFIELDMODEL_TANH_H_

#include <iostream>
#include <vector>

#include "AbsBeamline/EndFieldModel/EndFieldModel.h"

namespace endfieldmodel {

class Tanh : public EndFieldModel {
  public:
    Tanh(double x0, double lambda, int max_index);

    Tanh() : _x0(0.), _lambda(0.) {setTanhDiffIndices(12);}

    Tanh(const Tanh& rhs) : _x0(rhs._x0), _lambda(rhs._lambda) {}

    ~Tanh();

    Tanh* clone() const;

    void rescale(double scaleFactor);

    double function(double x, int n) const;

    double getCentreLength() const {return getX0()*2.0;}

    double getEndLength() const {return getLambda();}

    double getTanh(double x, int n) const;

    double getNegTanh(double x, int n) const;

    static std::vector< std::vector<int> > getTanhDiffIndices(size_t n);

    static void setTanhDiffIndices(size_t n);

    inline double getLambda() const {return _lambda;}

    inline double getX0() const {return _x0;}

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

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

    virtual void setMaximumDerivative(size_t n);

    std::ostream& print(std::ostream& out) const;
  private:
    double _x0, _lambda;

    static std::vector< std::vector< std::vector<int> > > _tdi;
};

}

#endif