SpECTRE Documentation Coverage Report
Current view: top level - Parallel - ExitCode.hpp Hit Total Coverage
Commit: 9a905b0737f373631c1b8e8389b8f26e67fa5313 Lines: 2 5 40.0 %
Date: 2024-03-28 09:03:18
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             : #include "DataStructures/DataBox/Tag.hpp"
       7             : 
       8             : namespace Parallel {
       9             : 
      10             : /*!
      11             :  * \brief Exit code of an executable
      12             :  *
      13             :  * \warning Don't change the integer values of the enum cases unless you have a
      14             :  * very good reason to do so. The integer values are used by external code, so
      15             :  * this is a public interface that should remain stable.
      16             :  */
      17           1 : enum class ExitCode : int {
      18             :   /// Program is complete
      19             :   Complete = 0,
      20             :   /// Program aborted because of an error
      21             :   Abort = 1,
      22             :   /// Program is incomplete and should be continued from the last checkpoint
      23             :   ContinueFromCheckpoint = 2
      24             : };
      25             : 
      26           0 : namespace Tags {
      27             : 
      28             : /*!
      29             :  * \brief Exit code of an executable
      30             :  *
      31             :  * \see Parallel::ExitCode
      32             :  */
      33           1 : struct ExitCode : db::SimpleTag {
      34           0 :   using type = Parallel::ExitCode;
      35             : };
      36             : 
      37             : }  // namespace Tags
      38             : }  // namespace Parallel

Generated by: LCOV version 1.14