ParticleSet.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 <list>
 
#include "SieveParticles.h"
#include "tarch/multicore/BooleanSemaphore.h"
 
namespace toolbox {
  namespace particles {
    template <typename T>
    class ParticleSet;
  } // namespace particles
} // namespace toolbox
 
 
template <typename T>
class toolbox::particles::ParticleSet {
public:
  typedef T             DoFType;
  typedef std::list<T*> ParticleList;
 
  using SieveParticles = ::toolbox::particles::SieveParticles<T>;
 
#if PeanoDebug >= 1
  void                                  setDebugX(const tarch::la::Vector<Dimensions, double>& data);
  void                                  setDebugH(const tarch::la::Vector<Dimensions, double>& data);
  tarch::la::Vector<Dimensions, double> getDebugX() const;
  tarch::la::Vector<Dimensions, double> getDebugH() const;
#endif
 
  std::string toString(bool addBrackets = true) const;
 
  static void clearReassignmentStatistics();
 
  static void clearParticleStateStatistics();
 
  static void reduceParticleStateStatistics();
  static std::string printParticleStateStatistics();
 
  static void reduceReassignmentStatistics();
  static std::string printReassignmentStatistics();
 
  static void updateLiftDropStatistics(
    int numberOfLiftsInThisTree,
    int numberOfDropsInThisTree,
    int numberOfReassignmentsInThisTree,
    int numberOfLiftsIntoSieveSetInThisTree,
    int numberOfDropsFromSieveSetInThisTree,
    int numberOfDropsIntoHorizontalTreeDecomposition
  );
 
  static void updateNumberOfLocalAndExpiredParticles(
    int numberOfRemainingLocalParticles,
    int numberOfExpiredHaloParticles,
    int numberOfParticlesThatHaveLeftTheirDomain
  );
 
  static int getNumberOfDropsIntoHorizontalTreeDecomposition();
 
  static bool registeredAnyResorting();
 
#ifdef Parallel
  static void initDatatype();
 
  static void shutdownDatatype();
#endif
 
  static void finishedTraversal(
      const tarch::la::Vector<Dimensions,double>   domainOffset,
      const tarch::la::Vector<Dimensions,double>   domainSize,
      const std::bitset<Dimensions>                periodicBC
  );
 
  static SieveParticles cloneParticlesToBeSieved();
 
  static ParticleList getParticlesToBeSievedIntoVertex(
    const peano4::datamanagement::VertexMarker& marker
 );
 
  static bool hasParticlesToBeSievedIntoVertices();
 
  static int getNumberOfParticlesThatHaveBeSievedIntoVertices();
 
  static int getNumberOfRemainingLocalParticles();
 
private:
  static tarch::logging::Log _log;
 
protected:
  static tarch::multicore::BooleanSemaphore _statisticsSemaphore;
 
  static int _numberOfLifts;
 
  static int _numberOfDrops;
 
  static int _numberOfReassignments;
 
  static int _numberOfLiftsIntoSieveSet;
  static int _numberOfDropsFromSieveSet;
  static int _numberOfDropsIntoHorizontalTreeDecomposition;
 
  static int _numberOfRemainingLocalParticles;
 
  static int _numberOfExpiredHaloParticles;
 
  static int _numberOfParticlesThatHaveLeftTheirDomain;
 
  static int _numberOfDroppedIncomingVirtualParticles;
 
  static int _numberOfRedundantlySharedLocalParticles;
 
  static int _numberOfReplacedVirtualParticlesAlongBoundary;
 
  static int _numberOfAddedVirtualParticlesAlongBoundary;
  static int _numberOfAddedLocalParticlesAlongBoundary;
 
  static SieveParticles _sieveParticles;
 
#if PeanoDebug >= 1
  tarch::la::Vector<Dimensions, double> _debugX;
  tarch::la::Vector<Dimensions, double> _debugH;
#endif
};
 
 
#include "ParticleSet.cpph"