src/foam/global/JobInfo/JobInfo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::JobInfo
  26
  27 Description
  28     Helper class for recording information about run/finished jobs.
  29
  30     Writes the following files:
  31       - $FOAM_JOB_DIR/runningJobs
  32       - $FOAM_JOB_DIR/finishedJobs
  33
  34 SourceFiles
  35     JobInfo.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef JobInfo_H
  40 #define JobInfo_H
  41
  42 #include "dictionary.H"
  43 #include "fileName.H"
  44 #include "cpuTime.H"
  45 #include "infoSwitch.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class JobInfo Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class JobInfo
  57 :
  58     public dictionary
  59 {
  60     // Private data
  61         fileName runningJobPath_;
  62         fileName finishedJobPath_;
  63         cpuTime  cpuTime_;
  64
  65     // Private member functions
  66
  67         bool write(Ostream&) const;
  68         void end(const word& terminationType);
  69
  70
  71 public:
  72
  73     static bool constructed;
  74     static debug::infoSwitch writeJobInfo;
  75
  76     // Constructors
  77
  78         //- Construct null
  79         JobInfo();
  80
  81
  82     // Destructor
  83
  84         ~JobInfo();
  85
  86
  87     // Member Functions
  88
  89         // Write
  90
  91             void write() const;
  92
  93             void end();
  94
  95             void exit();
  96
  97             void abort();
  98
  99             void signalEnd() const;
 100 };
 101
 102
 103 extern JobInfo jobInfo;
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //