src/OpenFOAM/global/JobInfo/JobInfo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::JobInfo
  27
  28 Description
  29     Helper class for recording information about run/finished jobs.
  30
  31     Writes the following files:
  32       - $FOAM_JOB_DIR/runningJobs
  33       - $FOAM_JOB_DIR/finishedJobs
  34
  35 SourceFiles
  36     JobInfo.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef JobInfo_H
  41 #define JobInfo_H
  42
  43 #include "dictionary.H"
  44 #include "fileName.H"
  45 #include "cpuTime.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 bool 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 // ************************************************************************* //