DependencyChecks.h

Go to the documentation of this file.

#pragma once
 
#include "exaparty/kernels/ParticleUpdatePredicates.h"
 
#include <string>
#include <type_traits>
 
 
namespace exaparty {
  namespace dependencychecks {
    enum class Invariant {
      TouchFirstUsage_MaskOutAfterwards_AllPreviousStepsUpdateAtLeastOnce,
      TouchFirstUsage_MaskOutAfterwards_AllPreviousStepsUpdateAtLeastOnce_SweepMayRerun,
      TouchAtMostOnce_MaskOutOtherwise_AllPreviousStepsUpdateAtLeastOnce,
      TouchAtMostOnce_MaskOutOtherwise_AllPreviousStepsUpdateAtLeastOnce_SweepMayRerun,
      TouchAtLeastOnce_AllPreviousStepsUpdateAtLeastOnce,
      TouchAtLeastOnce_AllPreviousStepsUpdateAtLeastOnce_FutureStagesMayUpdate,
      TouchAtLeastOnce_AllPreviousStepsUpdateAtLeastOnce_MayOverwritePreviousCellUpdatesFromSameSweep,
      TouchAtLeastOnce_AllPreviousStepsUpdateAtLeastOnce_MayOverwritePreviousCellUpdatesFromSameSweep_FutureStagesMayUpdate
    };
 
    std::string toString(Invariant policy);
 
    // some templates for convenience and code readability.
    template <typename ParticleContainer>
    using PCParticle = typename std::remove_pointer<
      typename ParticleContainer::value_type>::type;
 
    template <typename ParticleContainer>
    using PCAlgorithmStepEnum = PCParticle<
      ParticleContainer>::DependencyChecksAlgorithmStepLastUpdated;
 
    template <typename ParticleContainer>
    using PCInitStepEnum = PCParticle<
      ParticleContainer>::DependencyChecksInitStepLastUpdated;
 
    template <typename ParticleContainer>
    using PCSweepStageEnum = PCParticle<
      ParticleContainer>::DependencyChecksPeanoEventUsedBySwift;
 
    template <typename Particle>
    using PAlgorithmStepEnum = typename std::remove_pointer<
      Particle>::type::DependencyChecksAlgorithmStepLastUpdated;
 
    template <typename Particle>
    using PInitStepEnum = typename std::remove_pointer<
      Particle>::type::DependencyChecksInitStepLastUpdated;
 
    template <typename Particle>
    using PSweepStageEnum = typename std::remove_pointer<
      Particle>::type::DependencyChecksPeanoEventUsedBySwift;
 
 
    namespace internal {
      bool isValid(
        Invariant policy,
        bool      workOnParticle,
        bool      particleIsLocal,
        int       numberOfUpdates,
        int       numberOfMaskOuts
      );
 
      bool previousStepsAllHaveToAccessAtLeastOnce(Invariant policy);
 
      int firstFutureStepThatHasToBeCleared(
        Invariant policy,
        int       numberOfSteps
      );
 
      template <typename Particle>
      static std::string outputParticle(
        const Particle*              particle,
        PAlgorithmStepEnum<Particle> algorithmStep,
        PSweepStageEnum<Particle>    sweepStageMarkerEnum,
        const int                    errors
      );
 
      template <typename Particle>
      static std::string outputParticle(
        const Particle*           particle,
        PInitStepEnum<Particle>   algorithmStep,
        PSweepStageEnum<Particle> sweepStageMarkerEnum,
        const int                 errors
      );
 
      int checkPastStages(
        Invariant  policy,
        bool       isLocal,
        const int  currentStep,
        const int  currentStage,
        const int  nsteps,
        const int  nstages,
        const int* sweepStateProgression
      );
 
 
      int checkFutureStages(
        Invariant  policy,
        const int  currentStep,
        const int  currentStage,
        const int  nsteps,
        const int  nstages,
        const int* sweepStateProgression
      );
    } // namespace internal
 
 
    template <typename ParticleContainer>
    static void markAlgorithmStep(
      const ParticleContainer&                    particles,
      const peano4::datamanagement::VertexMarker& marker,
      PCAlgorithmStepEnum<ParticleContainer>      algorithmStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>         sweepStageMarkerEnum,
      Invariant                                   policy,
      ::exaparty::kernels::UpdateParticleAssignedToVertexPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void markAlgorithmStep(
      const ParticleContainer&                  localParticles,
      const ParticleContainer&                  activeParticles,
      const peano4::datamanagement::CellMarker& marker,
      PCAlgorithmStepEnum<ParticleContainer>    algorithmStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>       sweepStageMarkerEnum,
      Invariant                                 policy,
      ::exaparty::kernels::UpdateParticlePairWithinCellPredicate<
        typename std::remove_pointer<
          typename ParticleContainer::value_type>::type> workOnParticle,
      int                                                spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void markInitStep(
      const ParticleContainer&                    localParticles,
      const peano4::datamanagement::VertexMarker& marker,
      PCInitStepEnum<ParticleContainer>           initStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>         sweepStageMarkerEnum,
      Invariant                                   policy,
      ::exaparty::kernels::UpdateParticleAssignedToVertexPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void markInitStep(
      const ParticleContainer&                  localParticles,
      const ParticleContainer&                  activeParticles,
      const peano4::datamanagement::CellMarker& marker,
      PCInitStepEnum<ParticleContainer>         initStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>       sweepStageMarkerEnum,
      Invariant                                 policy,
      ::exaparty::kernels::UpdateParticlePairWithinCellPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void checkAlgorithmStep(
      Invariant                                 policy,
      const ParticleContainer&                  localParticles,
      const ParticleContainer&                  activeParticles,
      const peano4::datamanagement::CellMarker& marker,
      PCAlgorithmStepEnum<ParticleContainer>    algorithmStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>       sweepStageMarkerEnum,
      ::exaparty::kernels::UpdateParticlePairWithinCellPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void checkAlgorithmStep(
      Invariant                                   policy,
      const ParticleContainer&                    localParticles,
      const peano4::datamanagement::VertexMarker& marker,
      PCAlgorithmStepEnum<ParticleContainer>      algorithmStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>         sweepStageMarkerEnum,
      ::exaparty::kernels::UpdateParticleAssignedToVertexPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void checkParticlesAssignedToVertexInTouchLastTimeAlgorithmStep(
      Invariant                              policy,
      const ParticleContainer&               assignedParticles,
      PCAlgorithmStepEnum<ParticleContainer> algorithmStepMarkerEnum,
      int                                    spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void checkInitStep(
      Invariant                                   policy,
      const ParticleContainer&                    localParticles,
      const peano4::datamanagement::VertexMarker& marker,
      PCInitStepEnum<ParticleContainer>           initStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>         sweepStageMarkerEnum,
      ::exaparty::kernels::UpdateParticleAssignedToVertexPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void checkInitStep(
      Invariant                                 policy,
      const ParticleContainer&                  localParticles,
      const ParticleContainer&                  activeParticles,
      const peano4::datamanagement::CellMarker& marker,
      PCInitStepEnum<ParticleContainer>         initStepMarkerEnum,
      PCSweepStageEnum<ParticleContainer>       sweepStageMarkerEnum,
      ::exaparty::kernels::UpdateParticlePairWithinCellPredicate<
        PCParticle<ParticleContainer>> workOnParticle,
      int                              spacetreeId
    );
 
    template <typename ParticleContainer>
    static void checkParticlesAssignedToVertexInTouchLastTimeInitStep(
      Invariant                         policy,
      const ParticleContainer&          activeParticles,
      PCInitStepEnum<ParticleContainer> initStepMarkerEnum,
      int                               spacetreeId
    );
 
 
    template <typename ParticleContainer>
    static void clearDependencyChecksAlgorithmStep(
      const ParticleContainer& localParticles
    );
 
 
    template <typename ParticleContainer>
    static void clearDependencyChecksInitStep(
      const ParticleContainer& localParticles
    );
 
 
  } // namespace dependencychecks
} // namespace exaparty
 
 
#include "../dependencychecks/DependencyChecks.cpph"