Waveform.hpp

Go to the documentation of this file.

#pragma once
 
#include <Eigen/Core>
#include <boost/range.hpp>
#include <optional>
#include "logging/Logger.hpp"
#include "math/Bspline.hpp"
#include "time/SampleResult.hpp"
#include "time/Stample.hpp"
 
namespace precice::time {
 
class Waveform {
public:
  Waveform();
 
  Waveform(int interpolationDegree);
 
  Waveform &operator=(const Waveform &other);

  void setSampleAtTime(double time, const Sample &sample);

  void setAllSamples(const Sample &sample);
 
  void setInterpolationDegree(int interpolationDegree);
 
  int getInterpolationDegree() const;

  double maxStoredTime() const;

  const Sample &getSampleAtOrAfter(double before) const;

  const Sample &getSampleAtEnd() const;

  Eigen::VectorXd getTimes() const;

  auto stamples() const
  {
    return boost::make_iterator_range(_stampleStorage);
  }
 
  auto stamples()
  {
    return boost::make_iterator_range(_stampleStorage);
  }
 
  bool empty() const;
 
  const time::Stample &last() const;

  std::pair<Eigen::VectorXd, Eigen::MatrixXd> getTimesAndValues() const;

  int nTimes() const;

  int nDofs() const;

  void move();

  void trim();

  void clear();
 
  void clearExceptLast();
 
  void trimBefore(double time);
 
  void trimAfter(double time);

  SampleResult sample(double time) const;
 
  Eigen::MatrixXd sampleGradients(double time) const;
 
private:
  std::vector<Stample> _stampleStorage;
 
  mutable logging::Logger _log{"time::Storage"};
 
  int _degree;
 
  mutable std::optional<math::Bspline> _bspline;

  int computeUsedDegree(int requestedDegree, int numberOfAvailableSamples) const;
};
 
} // namespace precice::time