Node.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/logging/Log.h"
#include "peano4/grid/GridVertex.h"
#include "tarch/multicore/BooleanSemaphore.h"
 
 
#include "TreeEntry.h"
 
 
#include <set>
#include <queue>
#include <map>
 
 
namespace peano4 {
  namespace parallel {
    class Node;
 
    namespace tests {
      class NodeTest;
    }
  }
}
 
 
class peano4::parallel::Node {
  public:
    static constexpr int        Terminate = -2;
    static constexpr int        MaxSpacetreesPerRank = 1024;
 
    static constexpr int        UndefProgramStep = -1;
  private:
    friend class peano4::parallel::tests::NodeTest;
 
    static tarch::logging::Log _log;
 
    static Node                _singleton;
 
    tarch::multicore::BooleanSemaphore  _semaphore;
 
    static constexpr int        StacksPerCommunicationPartner = 4;
 
    #if !defined(Parallel)
    typedef int MPI_Comm;
    #endif
    MPI_Comm                    _dataExchangeCommunicators[MaxSpacetreesPerRank];
 
    int                         _currentProgramStep;
 
    int                         _rankOrchestrationTag;
 
    std::map< int, TreeEntry >  _treeEntries;
 
    Node();
 
    Node( const Node& node ) = delete;
 
    int getId(int rank, int localTreeId) const;
 
    void registerId(int id, int masterId);
 
    static std::bitset<2*Dimensions> getPeriodicBoundaryNumber(const tarch::la::Vector<TwoPowerD,int>& flags);
  public:
    int getLocalTreeId(int treeId) const;
    int getGlobalTreeId(int treeId) const;
 
    static void initMPIDatatypes();
    static void shutdownMPIDatatypes();
 
    static Node& getInstance();
 
    virtual ~Node();
 
    static bool isGlobalMaster(int treeId);
 
    int getNumberOfRegisteredTrees() const;
 
    int reserveId(int rank, int forTreeId);
 
    int getRank(int treeId) const;
 
    void deregisterId(int id);
 
    static int getOutputStackNumberForHorizontalDataExchange(int id);
 
    static int getInputStackNumberForVerticalDataExchange(int id);
    static int getOutputStackNumberForVerticalDataExchange(int id);
 
    static int getInputStackNumberForHorizontalDataExchange(int id);
 
    typedef std::pair<int, int > PeriodicBoundaryStackIdentifier;
 
    static std::set< PeriodicBoundaryStackIdentifier >  getOutputStacksForPeriodicBoundaryExchange(const tarch::la::Vector<TwoPowerD,int>& flags);
 
    static std::string toString( const std::set< PeriodicBoundaryStackIdentifier >& data );
 
    static int  getOutputStackForPeriodicBoundaryExchange(int faceNumber);
 
    static int  getPeriodicBoundaryExchangeInputStackNumberForOutputStack(int outputStackNumber);
    static PeriodicBoundaryStackIdentifier  getPeriodicBoundaryExchangeInputStackNumberForOutputStack(PeriodicBoundaryStackIdentifier outputStackIdentifier);
 
    static int mapPeriodicBoundaryExchangeOutputStackOntoInputStack(int outputStack);
 
    static bool isHorizontalDataExchangeOutputStackNumber(int number);
    static bool isHorizontalDataExchangeInputStackNumber(int number);
 
    static bool isVerticalDataExchangeOutputStackNumber(int number);
    static bool isVerticalDataExchangeInputStackNumber(int number);
 
    static bool isPeriodicBoundaryExchangeOutputStackNumber(int number);
 
    static bool isStorageStackNumber(int number);
 
    static int getTreeNumberTiedToExchangeStackNumber(int number);
 
    bool continueToRun();
 
    void setNextProgramStep( int number );
 
    int getCurrentProgramStep() const;
 
    void init();
 
    void shutdown();
 
    enum class ExchangeMode {
      HorizontalData,
      VerticalData
    };
 
    static std::string toString( ExchangeMode mode );
 
    typedef std::pair<int, MPI_Comm>  GridDataExchangeMetaInformation;
 
    GridDataExchangeMetaInformation getGridDataExchangeMetaInformation( int sendingTreeId, int receivingTreeId, ExchangeMode exchange ) const;
 
    static std::string getSemanticsForTag( int tag );
};