CouplingData.hpp

Go to the documentation of this file.

#pragma once
 
#include <Eigen/Core>
#include <vector>
#include "cplscheme/CouplingScheme.hpp"
#include "mesh/SharedPointer.hpp"
#include "time/Waveform.hpp"
#include "utils/assertion.hpp"
 
namespace precice::cplscheme {
 
class CouplingData {
public:
  enum struct Direction : bool { Send,
                                 Receive };
 
  CouplingData(
      mesh::PtrData data,
      mesh::PtrMesh mesh,
      bool          requiresInitialization,
      bool          exchangeSubsteps,
      Direction     direction);
 
  int getDimensions() const;
 
  int getSize() const;
 
  int nVertices() const;

  const Eigen::VectorXd &values() const;

  const Eigen::MatrixXd &gradients() const;

  int gradientsRows() const;

  int gradientsCols() const;

  const time::Sample &sample() const;

  time::Waveform &waveform();

  time::SampleResult getPreviousValuesAtTime(double relativeDt);
 
  Eigen::MatrixXd getPreviousGradientsAtTime(double relativeDt);

  const time::Waveform &waveform() const;

  auto stamples() const
  {
    return waveform().stamples();
  }

  void setSampleAtTime(double time, time::Sample sample);

  void setGlobalSample(const time::Sample &sample); // @todo try to remove this function

  void initializeWithZeroAtTime(double time);

  void emplaceSampleAtTime(double time);

  void emplaceSampleAtTime(double time, std::initializer_list<double> values);

  void emplaceSampleAtTime(double time, std::initializer_list<double> values, std::initializer_list<double> gradients);

  bool hasGradient() const;

  int meshDimensions() const;

  void reinitialize();

  void storeIteration();

  const Eigen::VectorXd &previousIteration() const;

  const Eigen::MatrixXd &previousIterationGradients() const;

  int getPreviousIterationSize() const;

  int getMeshID();

  int getDataID();

  std::string getDataName() const;

  std::string getMeshName() const;

  std::vector<std::optional<double>> getLowerBound() const;

  std::vector<std::optional<double>> getUpperBound() const;

  std::vector<int> getVertexOffsets();

  Direction getDirection() const;

  const bool requiresInitialization;

  void moveToNextWindow();
 
  bool exchangeSubsteps() const;
 
private:
  logging::Logger _log{"cplscheme::CouplingData"};

  mesh::PtrMesh _mesh;

  mesh::PtrData _data;

  time::Waveform _previousTimeStepsStorage;

  bool _exchangeSubsteps;
 
  Direction _direction;
};
 
} // namespace precice::cplscheme