SinusoidalTimeDependence.h

Go to the documentation of this file.

//
// Class SinusoidalTimeDependence
//   A time dependence class that generates sine waves
//
// Copyright (c) 2025, Jon Thompson, STFC Rutherford Appleton Laboratory, Didcot, UK
//
// 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 Public License
// along with OPAL.  If not, see <https://www.gnu.org/licenses/>.
//
 
#ifndef OPAL_SINUSOIDALTIMEDEPENDENCE_H
#define OPAL_SINUSOIDALTIMEDEPENDENCE_H
 
#include <vector>
#include "Algorithms/AbstractTimeDependence.h"
class Inform;
 
class SinusoidalTimeDependence final : public AbstractTimeDependence {
public:
    SinusoidalTimeDependence(
            const std::vector<double>& f, const std::vector<double>& p,
            const std::vector<double>& a, const std::vector<double>& o);
 
    SinusoidalTimeDependence() = default;
 
    ~SinusoidalTimeDependence() override = default;
 
    double getValue(double time) override;
 
    double getIntegral(double time) override;
 
    SinusoidalTimeDependence* clone() override;
 
    Inform& print(Inform& os) const;
 
    /* Getters for the test case use */
    [[nodiscard]] const std::vector<double>& getFrequencies() const { return f_m; }
    [[nodiscard]] const std::vector<double>& getAmplitudes() const { return a_m; }
    [[nodiscard]] const std::vector<double>& getOffsets() const { return o_m; }
    [[nodiscard]] const std::vector<double>& getPhases() const { return p_m; }
 
private:
    std::vector<double> f_m;
    std::vector<double> p_m;
    std::vector<double> a_m;
    std::vector<double> o_m;
};
 
inline Inform& operator<<(Inform& os, const SinusoidalTimeDependence& p) { return p.print(os); }
 
#endif  // OPAL_SINUSOIDALTIMEDEPENDENCE_H