CouplingScheme.hpp

Go to the documentation of this file.

#pragma once
 
#include <map>
#include <string>
#include <vector>
 
#include "com/SharedPointer.hpp"
#include "cplscheme/ImplicitData.hpp"
#include "precice/impl/Types.hpp"
 
namespace precice::cplscheme {

class CouplingScheme {
public:
  static const double UNDEFINED_MAX_TIME;

  static const int UNDEFINED_TIME_WINDOWS;

  static const double UNDEFINED_TIME_WINDOW_SIZE;

  static const int UNDEFINED_MAX_ITERATIONS;

  static const int UNDEFINED_MIN_ITERATIONS;

  static const int INFINITE_MAX_ITERATIONS;

  enum struct Action {
    InitializeData, 
    ReadCheckpoint, 
    WriteCheckpoint 
  };
 
  static std::string toString(Action action);
 
  CouplingScheme &operator=(CouplingScheme &&) = delete;
 
  virtual ~CouplingScheme() = default;

  virtual void initialize() = 0;

  virtual void reinitialize() = 0;

  virtual bool sendsInitializedData() const = 0;

  virtual bool isInitialized() const = 0;


  virtual bool addComputedTime(double timeToAdd) = 0;
 
  using ChangedMeshes = std::vector<MeshID>;

  virtual ChangedMeshes firstSynchronization(const ChangedMeshes &changes) = 0;

  virtual void firstExchange() = 0;

  virtual ChangedMeshes secondSynchronization() = 0;

  virtual void secondExchange() = 0;


  virtual void finalize() = 0;

  virtual std::vector<std::string> getCouplingPartners() const = 0;

  virtual std::string localParticipant() const = 0;

  virtual bool willDataBeExchanged(double lastSolverTimeStepSize) const = 0;

  virtual bool hasDataBeenReceived() const = 0;

  virtual double getTimeWindowStart() const = 0;

  virtual double getTime() const = 0;

  virtual int getTimeWindows() const = 0;

  virtual bool hasTimeWindowSize() const = 0;

  virtual double getTimeWindowSize() const = 0;

  virtual double getNextTimeStepMaxSize() const = 0;

  virtual bool isCouplingOngoing() const = 0;

  virtual bool isTimeWindowComplete() const = 0;

  virtual bool isActionRequired(Action action) const = 0;

  virtual bool isActionFulfilled(Action action) const = 0;

  virtual void markActionFulfilled(Action action) = 0;

  virtual void requireAction(Action action) = 0;

  virtual std::string printCouplingState() const = 0;

  virtual bool isImplicitCouplingScheme() const = 0;

  virtual bool hasConverged() const = 0;

  virtual bool requiresSubsteps() const = 0;

  virtual ImplicitData implicitDataToReceive() const = 0;
};
 
} // namespace precice::cplscheme