TraversalObserver.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include <set>
#include <vector>
 
#include "peano4/parallel/parallel.h"
#include "peano4/utils/Globals.h"
#include "tarch/la/Vector.h"
 
namespace peano4 {
  namespace grid {
    class TraversalObserver;
    // Forward declarations as structs
    struct GridControlEvent;
    struct GridTraversalEvent;
  } // namespace grid
  namespace datamanagement {
    struct CellMarker;
    struct FaceMarker;
    struct VertexMarker;
  } // namespace datamanagement
} // namespace peano4
 
class peano4::grid::TraversalObserver {
public:
  virtual ~TraversalObserver() {}
 
  static constexpr int NoRebalancing = -1;
 
  static constexpr int NoData = -1;
 
  static constexpr int CreateOrDestroyPersistentGridEntity = -2;
 
  static constexpr int CreateOrDestroyHangingGridEntity = -3;
 
  virtual void loadCell(const GridTraversalEvent& event) = 0;
 
  virtual void enterCell(const GridTraversalEvent& event) = 0;
 
  virtual void leaveCell(const GridTraversalEvent& event) = 0;
 
  virtual void storeCell(const GridTraversalEvent& event) = 0;
 
  virtual bool canSkipFullyRemoteCells() const { return false; }
 
  virtual TraversalObserver* clone(int spacetreeId) = 0;
 
  virtual std::vector<GridControlEvent> createGridControlEventsForNextTraversal() const = 0;
 
  virtual void beginTraversal(
    const tarch::la::Vector<Dimensions, double>& x, const tarch::la::Vector<Dimensions, double>& h
  ) = 0;
 
  virtual void endTraversal(
    const tarch::la::Vector<Dimensions, double>& x, const tarch::la::Vector<Dimensions, double>& h
  ) = 0;
 
  virtual void exchangeAllVerticalDataExchangeStacks(int /*masterId*/) {};
 
  virtual void exchangeAllHorizontalDataExchangeStacks(bool /*symmetricDataCardinality*/) {};
 
  virtual void exchangeAllPeriodicBoundaryDataStacks() {};
 
  virtual void streamDataFromSplittingTreeToNewTree(int /*newWorker*/) {};
  virtual void streamDataFromJoiningTreeToMasterTree(int /*masterId*/) {};
 
  virtual void finishAllOutstandingSendsAndReceives() {};
 
  enum class SendReceiveContext {
    BoundaryExchange,
    MultiscaleExchange,
    ForkDomain,
    JoinDomain,
    PeriodicBoundaryDataSwap
  };
 
  virtual void sendVertex(int /*position*/, int /*toStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/) {};
  virtual void sendFace(int /*position*/, int /*toStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/) {};
  virtual void sendCell(int /*toStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/) {};
 
  virtual void receiveAndMergeVertex(int /*position*/, int /*fromStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/) {};
  virtual void receiveAndMergeFace(int /*position*/, int /*fromStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/) {};
  virtual void receiveAndMergeCell(int /*fromStack*/, SendReceiveContext /*context*/, const GridTraversalEvent& /*event*/){};
 
  virtual void deleteAllStacks() {};
};