Data.hpp

Go to the documentation of this file.

#pragma once
 
#include <Eigen/Core>
#include <stddef.h>
#include <string>
 
#include "SharedPointer.hpp"
#include "logging/Logger.hpp"
#include "precice/impl/Types.hpp"
#include "time/Sample.hpp"
#include "time/Storage.hpp"
#include "time/Time.hpp"
#include "time/Waveform.hpp"
 
namespace precice {
namespace mesh {
class Mesh;
}
} // namespace precice
 
// ----------------------------------------------------------- CLASS DEFINITION
 
namespace precice {
namespace mesh {
 
class Data {
public:
  // @brief Data dimensions type (scalar/vector)
  enum typeName {
    SCALAR,
    VECTOR
  };
 
  // @brief Possible types of data values.
  //  enum DataType {
  //    TYPE_UNDEFINED,
  //    TYPE_DOUBLE,
  //    TYPE_VECTOR
  //  };
 
  // @brief Name of an undefined data type.
  //static const std::string TYPE_NAME_UNDEFINED;
  // @brief Name of a double data type.
  //static const std::string TYPE_NAME_DOUBLE;
  // @brief Name of a vector data type.
  //static const std::string TYPE_NAME_VECTOR;
 
  Data(
      std::string name,
      DataID      id,
      int         dimension,
      int         spatialDimensions = -1,
      int         waveformDegree    = time::Time::DEFAULT_WAVEFORM_DEGREE);
 
  Eigen::VectorXd &values();
 
  const Eigen::VectorXd &values() const;
 
  Eigen::MatrixXd &gradients();
 
  const Eigen::MatrixXd &gradients() const;
 
  time::Sample &sample();
 
  const time::Sample &sample() const;
 
  Eigen::VectorXd sampleAtTime(double time) const;
 
  int getWaveformDegree() const;
 
  time::Storage &timeStepsStorage();
 
  void moveToNextWindow();
 
  auto stamples() const
  {
    return _waveform.stamples();
  }
 
  void setSampleAtTime(double time, const time::Sample &sample);
 
  const std::string &getName() const;
 
  DataID getID() const;
 
  void toZero();
 
  bool hasGradient() const;
 
  void requireDataGradient();
 
  int getSpatialDimensions() const;
 
  int getDimensions() const;
 
  void allocateValues(int expectedCount);
 
private:
  logging::Logger _log{"mesh::Data"};
 
  time::Waveform _waveform;
 
  std::string _name;
 
  DataID _id;
 
  int _dimensions;
 
  int _spatialDimensions;
 
  bool _hasGradient = false;
 
  time::Sample _sample;
};
 
} // namespace mesh
} // namespace precice