SplineTimeDependence.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2018, 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 _CLASSIC_SRC_ALGORITHMS_SPLINETIMEDEPENDENCE_H_
#define _CLASSIC_SRC_ALGORITHMS_SPLINETIMEDEPENDENCE_H_

#include <memory>

#include <gsl/gsl_spline.h>

#include "Ippl.h"
#include "Utilities/GeneralClassicException.h"
#include "Algorithms/AbstractTimeDependence.h"

class SplineTimeDependence : public AbstractTimeDependence {
  public:
    SplineTimeDependence(size_t splineOrder,
                         std::vector<double> times,
                         std::vector<double> values);

    SplineTimeDependence(const SplineTimeDependence& rhs);

    SplineTimeDependence();
    ~SplineTimeDependence();

    inline double getValue(double time);

    SplineTimeDependence* clone();

    Inform &print(Inform &os);
    
    void setSpline(size_t splineOrder,
                   std::vector<double> times,
                   std::vector<double> values);
  private:
    gsl_spline* spline_m;
    gsl_interp_accel* acc_m;
    size_t splineOrder_m;
    std::vector<double> times_m;
    std::vector<double> values_m;
  
};

inline
Inform &operator<<(Inform &os, SplineTimeDependence &p) {
  return p.print(os);
}

inline
double SplineTimeDependence::getValue(double time) {
    if (time < times_m[0] or time > times_m.back()) {
        throw GeneralClassicException(
                            "SplineTimeDependence::getValue",
                            "time out of spline range");
    }
    return gsl_spline_eval (spline_m, time, acc_m);
}

#endif