Line data    Source code

       1            1 : // Distributed under the MIT License.
       2              : // See LICENSE.txt for details.
       3              : 
       4              : /// \file
       5              : /// Defines class Informer.
       6              : 
       7              : #pragma once
       8              : 
       9              : /// \cond
      10              : class CkArgMsg;
      11              : /// \endcond
      12              : 
      13              : /// \ingroup LoggingGroup
      14              : /// The Informer manages textual output regarding the status of a simulation.
      15            1 : class Informer {
      16              :  public:
      17              :   /// Print useful information at the beginning of a simulation.
      18              :   ///
      19              :   /// This includes the command used to start the executable such as
      20              :   ///
      21              :   /// ```
      22              :   /// ./MyExecutable --input-file MyInputFile.yaml
      23              :   /// ```
      24              :   ///
      25              :   /// If you used charmrun, mpirun, or something similar to start your
      26              :   /// executable, you'll only see the options that have to do with the
      27              :   /// executable itself. Meaning, for this command
      28              :   ///
      29              :   /// ```
      30              :   /// mpirun -np 4 MyExecutable --input-file MyInputFile.yaml
      31              :   /// ```
      32              :   ///
      33              :   /// only `MyExecutable` and onwards will be printed.
      34            1 :   static void print_startup_info(CkArgMsg* msg);
      35              : 
      36              :   /// Print useful information at the end of a simulation.
      37            1 :   static void print_exit_info();
      38              : };