JobInfo.H 3.34 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
OpenFOAM bot's avatar
OpenFOAM bot committed
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8 9
    Copyright (C) 2011 OpenFOAM Foundation
    Copyright (C) 2017 OpenCFD Ltd.
10 11 12 13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14 15 16 17
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
18 19 20 21 22 23 24

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
25
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
26 27 28 29 30 31 32 33 34 35 36

Class
    Foam::JobInfo

Description
    Helper class for recording information about run/finished jobs.

    Writes the following files:
      - $FOAM_JOB_DIR/runningJobs
      - $FOAM_JOB_DIR/finishedJobs

37 38
    If FOAM_JOB_DIR is unset, defaults to ~/.OpenFOAM/jobControl

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
SourceFiles
    JobInfo.C

\*---------------------------------------------------------------------------*/

#ifndef JobInfo_H
#define JobInfo_H

#include "dictionary.H"
#include "fileName.H"
#include "cpuTime.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class JobInfo Declaration
\*---------------------------------------------------------------------------*/

class JobInfo
:
    public dictionary
{
    // Private data
65 66 67 68 69

        //- The name of the job file
        string   jobFileName_;
        fileName runningDir_;
        fileName finishedDir_;
70
        cpuTime  cpuTime_;
71

72
    // Private Member Functions
73

74
        bool write(Ostream& os) const;
75 76 77 78 79
        void end(const word& terminationType);


public:

80
    //- Global value for constructed job info
81
    static bool constructed;
82 83

    //- Global value for writeJobInfo enabled
84 85
    static bool writeJobInfo;

86

87 88 89 90 91 92
    // Constructors

        //- Construct null
        JobInfo();


93
    //- Destructor
94
    //  Update job info and relocate the file from running to finished.
95
    ~JobInfo();
96 97 98 99


    // Member Functions

100 101
        //- Write the job info to its file in the runningJobs directory
        void write() const;
102

103 104
        //- End with "termination=normal"
        void end();
105

106 107
        //- End with "termination=exit"
        void exit();
108

109 110
        //- End with "termination=abort"
        void abort();
111

112 113
        //- Update job info and relocate the file from running to finished.
        void signalEnd() const;
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
};


extern JobInfo jobInfo;


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //