MacroscopicSolverInterface.h

// Copyright (C) 2015 Technische Universitaet Muenchen
// This file is part of the Mamico project. For conditions of distribution
// and use, please see the copyright notice in Mamico's main folder, or at
// www5.in.tum.de/mamico
#ifndef _MOLECULARDYNAMICS_COUPLING_INTERFACE_MACROSCOPICSOLVERINTERFACE_H_
#define _MOLECULARDYNAMICS_COUPLING_INTERFACE_MACROSCOPICSOLVERINTERFACE_H_
 
#include "coupling/CouplingMDDefinitions.h"
#include "tarch/la/Vector.h"
#include <vector>
 
namespace coupling {
namespace interface {
template <unsigned int dim> class MacroscopicSolverInterface;
}
} // namespace coupling

template <unsigned int dim> class coupling::interface::MacroscopicSolverInterface {
 
public:
  MacroscopicSolverInterface() {}
  virtual ~MacroscopicSolverInterface() {}
 
  /* This function defines an offset of cells which is considered to be the outer region.
   * It replaces the legacy functions 'receiveMacroscopicQuantityFromMDSolver' and 'sendMacroscopicQuantityToMDSolver'
   * from older versions of MaMiCo. Data are sent to MD solver for cells that are not in the ghost layer
   * and not part of the inner region. Data needs so be send from micro to macro solver for all inner cells.
   *  @return number of cells in outer region per direction at each boundary, e.g. 3
   */
  virtual unsigned int getOuterRegion() = 0;

  virtual std::vector<unsigned int> getRanks(I01 idx) = 0;

  virtual std::vector<unsigned int> getSourceRanks(I01 idx) { return getRanks(idx); }

  virtual std::vector<unsigned int> getTargetRanks(I01 idx) { return getRanks(idx); }
};
#endif // _MOLECULARDYNAMICS_COUPLING_INTERFACE_MACROSCOPICSOLVERINTERFACE_H_