SplineTimeDependence.h

Go to the documentation of this file.

//
// Copyright (c) 2026, Paul Scherrer Institute, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
 
#ifndef ALGORITHMS_SPLINETIMEDEPENDENCE_H_
#define ALGORITHMS_SPLINETIMEDEPENDENCE_H_
 
#include <vector>
 
#include "Algorithms/AbstractTimeDependence.h"
#include "Utilities/CubicSpline.h"
#include "Utilities/LinearSpline.h"
 
class Inform;
 
class SplineTimeDependence : public AbstractTimeDependence {
public:
    SplineTimeDependence(
            size_t splineOrder, const std::vector<double>& times,
            const std::vector<double>& values);
 
    SplineTimeDependence() = default;
 
    ~SplineTimeDependence() override = default;
 
    double getValue(double time) override;
 
    double getIntegral(double time) override;
 
    SplineTimeDependence* clone() override;
 
    Inform& print(Inform& os) const;
 
    void setSpline(
            size_t splineOrder, const std::vector<double>& times,
            const std::vector<double>& values);
 
    /* Getters for the test case use */
    [[nodiscard]] const std::vector<double>& getTimes() const { return times_m; }
    [[nodiscard]] const std::vector<double>& getValues() const { return values_m; }
    [[nodiscard]] size_t getSplineOrder() const { return splineOrder_m; }
 
    // Spline order constants
    static constexpr size_t LinearInterpolation = 1;
    static constexpr size_t CubicInterpolation  = 3;
 
private:
    std::unique_ptr<AbstractSpline> spline_m;
    std::unique_ptr<AbstractSpline::Accelerator> splineAcc_m;
    size_t splineOrder_m{LinearInterpolation};
    std::vector<double> times_m;
    std::vector<double> values_m;
};
 
inline Inform& operator<<(Inform& os, const SplineTimeDependence& p) { return p.print(os); }
 
#endif