src/foam/global/JobInfo/JobInfo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   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
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class JobInfo Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class JobInfo
  56 :
  57     public dictionary
  58 {
  59     // Private data
  60         fileName runningJobPath_;
  61         fileName finishedJobPath_;
  62         cpuTime  cpuTime_;
  63
  64     // Private member functions
  65
  66         bool write(Ostream&) const;
  67         void end(const word& terminationType);
  68
  69
  70 public:
  71
  72     static bool constructed;
  73     static bool writeJobInfo;
  74
  75     // Constructors
  76
  77         //- Construct null
  78         JobInfo();
  79
  80
  81     // Destructor
  82
  83         ~JobInfo();
  84
  85
  86     // Member Functions
  87
  88         // Write
  89
  90             void write() const;
  91
  92             void end();
  93
  94             void exit();
  95
  96             void abort();
  97
  98             void signalEnd() const;
  99 };
 100
 101
 102 extern JobInfo jobInfo;
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //