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/Storage.hpp"
#include "utils/assertion.hpp"
 
namespace precice {
namespace 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;
 
  Eigen::VectorXd &values();
 
  const Eigen::VectorXd &values() const;
 
  Eigen::MatrixXd &gradients();
 
  const Eigen::MatrixXd &gradients() const;
 
  time::Sample &sample();
 
  const time::Sample &sample() const;
 
  time::Storage &timeStepsStorage();
 
  Eigen::VectorXd getPreviousValuesAtTime(double relativeDt);
 
  Eigen::MatrixXd getPreviousGradientsAtTime(double relativeDt);
 
  const time::Storage &timeStepsStorage() const;
 
  auto stamples() const
  {
    return timeStepsStorage().stamples();
  }
 
  void setSampleAtTime(double time, time::Sample sample);
 
  bool hasGradient() const;
 
  int meshDimensions() const;
 
  void storeIteration();
 
  const Eigen::VectorXd &previousIteration() const;
 
  const Eigen::MatrixXd &previousIterationGradients() const;
 
  int getPreviousIterationSize() const;
 
  int getMeshID();
 
  int getDataID();
 
  std::string getDataName();
 
  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::Storage _previousTimeStepsStorage;
 
  bool _exchangeSubsteps;
 
  Direction _direction;
};
 
} // namespace cplscheme
} // namespace precice