GridTraversalEventGenerator.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 "tarch/tests/TestCase.h"
#include "tarch/logging/Log.h"
 
#include "grid.h"
#include "GridTraversalEvent.h"
#include "AutomatonState.h"
#include "GridVertex.h"
 
namespace peano4 {
  namespace grid {
    class GridTraversalEventGenerator;
 
    namespace tests {
      class GridTraversalEventGeneratorTest;
    }
  }
}
 
class peano4::grid::GridTraversalEventGenerator {
  private:
    friend class peano4::grid::tests::GridTraversalEventGeneratorTest;
 
    static tarch::logging::Log _log;
 
    const int _id;
 
  public:
    static bool isFullyRemoteEnterEvent(const GridTraversalEvent& event);
 
    static bool isFullyRemoteLeaveEvent(const GridTraversalEvent& event);
 
    static bool mayMaskDataOnIntermediateStacks(
      const SplitSpecification&  splitTriggered,
      const std::set<int>&       splitting,
      const std::set< int >&     joinTriggered,
      const std::set< int >&     joining,
      const std::set< int >&     hasSplit,
      bool                       spacetreeStateIsRunning
    );
 
  private:
 
    GridTraversalEvent createGenericCellTraversalEvent(
      GridVertex                                coarseGridVertices[TwoPowerD],
      GridVertex                                fineGridVertices[TwoPowerD],
      const AutomatonState&                     state,
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      const tarch::la::Vector<Dimensions,int>&  relativePositionToFather,
      bool                                      spacetreeStateIsRunning
    ) const;
 
    static FaceType getFaceType(
      GridVertex                         coarseGridVertices[TwoPowerD],
      tarch::la::Vector<Dimensions,int>  positionOfCell,
      int                                faceNumber
    );
 
    static FaceType getFaceType(
      const VertexType                   vertexTypes[TwoPowerD],
      int                                faceNumber
    );
 
    std::bitset<TwoPowerD> areVerticesAdjacentToParallelDomainBoundary(
      GridVertex                                vertices[TwoPowerD],
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      bool calledByLeaveCell
    ) const;
 
    std::bitset<TwoTimesD> areFacesAdjacentToParallelDomainBoundary(
        GridVertex                                vertices[TwoPowerD],
        const SplitSpecification&                 splitTriggered,
        const std::set<int>&                      splitting,
        const std::set< int >&                    joinTriggered,
        const std::set< int >&                    joining,
        bool calledByLeaveCell
      ) const;
 
    std::bitset<TwoPowerD> areVerticesLocal(
      GridVertex                  vertices[TwoPowerD],
      const SplitSpecification&   splitTriggered,
      const std::set<int>&        splitting,
      const std::set< int >&      joinTriggered,
      const std::set< int >&      joining
    ) const;
 
    std::bitset<TwoTimesD> areFacesLocal(
      GridVertex  vertices[TwoPowerD],
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining
    ) const;
 
  public:
    GridTraversalEventGenerator(int id);
 
    bool isVertexAdjacentToLocalSpacetree(
      GridVertex  vertex,
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      bool        splittingIsConsideredLocal,
      bool        joiningIsConsideredLocal
    ) const;
 
    bool isSpacetreeNodeLocal(
      GridVertex    vertices[TwoPowerD],
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      bool          splittingIsConsideredLocal,
      bool          joiningIsConsideredLocal
    ) const;
 
    GridTraversalEvent createEnterCellTraversalEvent(
      GridVertex              coarseGridVertices[TwoPowerD],
      GridVertex              fineGridVertices[TwoPowerD],
      const AutomatonState&   state,
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      const std::set< int >&                    hasSplit,
      const tarch::la::Vector<Dimensions,int>&  relativePositionToFather,
      bool                                      spacetreeStateIsRunning
    ) const;
 
    GridTraversalEvent createLeaveCellTraversalEvent(
      GridVertex              coarseGridVertices[TwoPowerD],
      GridVertex              fineGridVertices[TwoPowerD],
      const AutomatonState&   state,
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining,
      const std::set< int >&                    hasSplit,
      const tarch::la::Vector<Dimensions,int>&  relativePositionToFather,
      bool                                      spacetreeStateIsRunning
    ) const;
 
    GridTraversalEvent createPrunedEnterCellTraversalEvent( SpacetreeState spacetreeState, const GridTraversalEvent& event ) const;
    GridTraversalEvent createPrunedLeaveCellTraversalEvent( SpacetreeState spacetreeState, const GridTraversalEvent& event ) const;
 
    static CellType getCellType(
      GridVertex                         coarseGridVertices[TwoPowerD],
      tarch::la::Vector<Dimensions,int>  positionOfCell
    );
 
    static CellType getCellType(
      const VertexType                   vertexTypes[TwoPowerD]
    );
 
    static void getVertexTypes(
      GridVertex                         coarseGridVertices[TwoPowerD],
      const tarch::la::Vector<Dimensions,int>&  positionOfCell,
      VertexType                         vertexTypes[TwoPowerD]
    );
 
    static VertexType getVertexType(
      GridVertex                         coarseGridVertices[TwoPowerD],
      tarch::la::Vector<Dimensions,int>  position
    );
 
    int getTreeOwningSpacetreeNode(
      GridVertex            vertices[TwoPowerD],
      const SplitSpecification&                 splitTriggered,
      const std::set<int>&                      splitting,
      const std::set< int >&                    joinTriggered,
      const std::set< int >&                    joining
    ) const;
 
    tarch::la::Vector< TwoPowerD, int >  getAdjacentRanksOfFace(
      GridVertex vertex[TwoPowerD],
      int faceNumber,
      bool useBackedUpAdjacencyInformation
    ) const;
};