PintableMacroSolver.h

// Copyright (C) 2023 Helmut Schmidt University
// This file is part of the Mamico project. For conditions of distribution
// and use, please see the copyright notice in Mamico's main folder
 
#pragma once
 
namespace coupling {
namespace interface {
class PintableMacroSolver;
class PintableMacroSolverState;
} // namespace interface
} // namespace coupling
 
#include <memory>

class coupling::interface::PintableMacroSolver {
public:
  using State = PintableMacroSolverState;
  enum class Mode { supervising, coupling };
 
  virtual ~PintableMacroSolver() {}

  virtual std::unique_ptr<State> getState() = 0;

  virtual void setState(const std::unique_ptr<State>&, int cycle = 0) = 0;

  virtual std::unique_ptr<State> operator()(const std::unique_ptr<State>&, int cycle = 0) = 0;

  virtual Mode getMode() const = 0;

  virtual std::unique_ptr<PintableMacroSolver> getSupervisor(int num_cycles, double visc_multiplier = 1) const = 0;

  virtual void print(std::ostream& os) const = 0;

  virtual double get_avg_vel(const std::unique_ptr<State>& state) const { return 0; }
  friend std::ostream& operator<<(std::ostream& os, const coupling::interface::PintableMacroSolver& s) {
    s.print(os);
    return os;
  }
};

class coupling::interface::PintableMacroSolverState {
public:
  using State = PintableMacroSolverState;
 
  virtual std::unique_ptr<State> clone() const = 0;
 
  virtual ~PintableMacroSolverState() {}

  virtual int getSizeBytes() const = 0; //

  virtual std::unique_ptr<State> operator+(const State&) = 0;

  virtual std::unique_ptr<State> operator-(const State&) = 0;
 
  friend bool operator==(const State& lhs, const State& rhs) { return lhs.__equals__(rhs); }

  virtual double* getData() = 0;

  virtual const double* getData() const = 0;

  virtual void print(std::ostream& os) const = 0;
 
  friend std::ostream& operator<<(std::ostream& os, const coupling::interface::PintableMacroSolverState& s) {
    s.print(os);
    return os;
  }
 
protected:
  virtual bool __equals__(const State&) const = 0;
};