SpECTRE Documentation Coverage Report
Current view: top level - Evolution/Particles/MonteCarlo - GhostZoneCommunicationStep.hpp Hit Total Coverage
Commit: 6e1258ccd353220e12442198913007fb6c170b6b Lines: 1 2 50.0 %
Date: 2024-10-23 19:54:13
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : /// Items related to the evolution of particles
       7             : /// Items related to Monte-Carlo radiation transport
       8             : namespace Particles::MonteCarlo {
       9             : 
      10             : /// This class is used to template communication actions
      11             : /// in the Monte-Carlo code, to know which of the two
      12             : /// communication steps we need to take care of
      13             : /// (just before or just after the MC step).
      14           1 : enum class CommunicationStep {
      15             :   /// PreStep should occur just before the MC step.
      16             :   /// It should send to the ghost zones of each
      17             :   /// element the fluid and metric data.
      18             :   PreStep,
      19             :   /// PostStep should occur just after a MC step.
      20             :   /// It sends packets that have left their current
      21             :   /// element to the element they now belong to.
      22             :   /// NOT CODE YET: This is also when information
      23             :   /// about energy/momentum/lepton number exchance
      24             :   /// in the ghost zones should be communicated back
      25             :   /// to the corresponding live point for coupling to
      26             :   /// the fluid evolution.
      27             :   PostStep
      28             : };
      29             : 
      30             : }  // namespace Particles::MonteCarlo

Generated by: LCOV version 1.14