OpenFOAM logo
Open Source CFD Toolkit

JobInfo.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     JobInfo
00027 
00028 Description
00029 
00030 SourceFiles
00031     JobInfo.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef JobInfo_H
00036 #define JobInfo_H
00037 
00038 #include "dictionary.H"
00039 #include "fileName.H"
00040 #include "cpuTime.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class JobInfo Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class JobInfo
00052 :
00053     public dictionary
00054 {
00055     // Private data
00056 
00057         fileName runningJobsDir_;
00058         fileName finishedJobsDir_;
00059         fileName jobFileName_;
00060         fileName runningJobPath_;
00061         fileName finishedJobPath_;
00062 
00063         cpuTime cpuTime_;
00064 
00065     // Private member functions
00066 
00067         bool write(Ostream& JobInfoFile) const;
00068         void end(const word& terminationType);
00069 
00070 
00071 public:
00072 
00073     static bool constructed;
00074     static bool writeJobInfo;
00075 
00076     // Constructors
00077 
00078         //- Construct null
00079         JobInfo();
00080 
00081 
00082     // Destructor
00083 
00084         ~JobInfo();
00085 
00086 
00087     // Member Functions
00088 
00089         // Write
00090 
00091             void write() const;
00092 
00093             void end();
00094 
00095             void exit();
00096 
00097             void abort();
00098 
00099             void signalEnd() const;
00100 };
00101 
00102 
00103 extern JobInfo jobInfo;
00104 
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 } // End namespace Foam
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 #endif
00113 
00114 // ************************************************************************* //
For further information go to www.openfoam.org