Participant.hpp

Go to the documentation of this file.

#pragma once
 
#include <memory>
#include <precice/Version.h>
#include <precice/export.h>
#include <precice/span.hpp>
#include "precice/Types.hpp"
 
namespace precice {
namespace impl {
class ParticipantImpl;
}
namespace testing {
struct WhiteboxAccessor;
}
} // namespace precice
 
// ----------------------------------------------------------- CLASS DEFINITION
 
namespace precice {
 
using string_view = ::precice::span<const char>;
 
class PRECICE_API Participant {
public:
  Participant(
      ::precice::string_view participantName,
      ::precice::string_view configurationFileName,
      int                    solverProcessIndex,
      int                    solverProcessSize);
 
  Participant(
      ::precice::string_view participantName,
      ::precice::string_view configurationFileName,
      int                    solverProcessIndex,
      int                    solverProcessSize,
      void *                 communicator);
 
  ~Participant();
 
 
  void initialize();
 
  void advance(double computedTimeStepSize);
 
  void finalize();
 
 
  bool requiresWritingCheckpoint();
 
  bool requiresReadingCheckpoint();
 
 
  int getMeshDimensions(::precice::string_view meshName) const;
 
  int getDataDimensions(::precice::string_view meshName, ::precice::string_view dataName) const;
 
  bool isCouplingOngoing() const;
 
  bool isTimeWindowComplete() const;
 
  double getMaxTimeStepSize() const;
 
 
  bool requiresMeshConnectivityFor(::precice::string_view meshName) const;
 
  VertexID setMeshVertex(
      ::precice::string_view        meshName,
      ::precice::span<const double> position);
 
  int getMeshVertexSize(::precice::string_view meshName) const;
 
  void setMeshVertices(
      ::precice::string_view        meshName,
      ::precice::span<const double> coordinates,
      ::precice::span<VertexID>     ids);
 
  void setMeshEdge(
      ::precice::string_view meshName,
      VertexID               first,
      VertexID               second);
 
  void setMeshEdges(
      ::precice::string_view          meshName,
      ::precice::span<const VertexID> ids);
 
  void setMeshTriangle(
      ::precice::string_view meshName,
      VertexID               first,
      VertexID               second,
      VertexID               third);
 
  void setMeshTriangles(
      ::precice::string_view          meshName,
      ::precice::span<const VertexID> ids);
 
  void setMeshQuad(
      ::precice::string_view meshName,
      VertexID               first,
      VertexID               second,
      VertexID               third,
      VertexID               fourth);
 
  void setMeshQuads(
      ::precice::string_view          meshName,
      ::precice::span<const VertexID> ids);
 
  void setMeshTetrahedron(
      ::precice::string_view meshName,
      VertexID               first,
      VertexID               second,
      VertexID               third,
      VertexID               fourth);
 
  void setMeshTetrahedra(
      ::precice::string_view          meshName,
      ::precice::span<const VertexID> ids);
 
 
  bool requiresInitialData();
 
  void writeData(
      ::precice::string_view          meshName,
      ::precice::string_view          dataName,
      ::precice::span<const VertexID> ids,
      ::precice::span<const double>   values);
 
  void readData(
      ::precice::string_view          meshName,
      ::precice::string_view          dataName,
      ::precice::span<const VertexID> ids,
      double                          relativeReadTime,
      ::precice::span<double>         values) const;
 
 
  void setMeshAccessRegion(
      ::precice::string_view        meshName,
      ::precice::span<const double> boundingBox) const;
 
  void getMeshVertexIDsAndCoordinates(
      ::precice::string_view    meshName,
      ::precice::span<VertexID> ids,
      ::precice::span<double>   coordinates) const;
 
 
 
  bool requiresGradientDataFor(::precice::string_view meshName,
                               ::precice::string_view dataName) const;
 
  void writeGradientData(
      ::precice::string_view          meshName,
      ::precice::string_view          dataName,
      ::precice::span<const VertexID> ids,
      ::precice::span<const double>   gradients);
 
 
  Participant(const Participant &copy) = delete;
 
  Participant &operator=(const Participant &assign) = delete;
 
private:
  std::unique_ptr<impl::ParticipantImpl> _impl;
 
  // @brief To allow white box tests.
  friend struct testing::WhiteboxAccessor;
};
 
} // namespace precice