The open source CFD toolbox
profilingSysInfo.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2016-2020 OpenCFD Ltd.
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::profilingSysInfo
28
29Description
30 General system information useful for profiling
31
32SourceFiles
33 profilingSysInfo.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef profilingSysInfo_H
38#define profilingSysInfo_H
39
40// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42namespace Foam
43{
44
45// Forward Declarations
46class Ostream;
47
48/*---------------------------------------------------------------------------*\
49 Class profilingSysInfo Declaration
50\*---------------------------------------------------------------------------*/
53{
54public:
55
56 // Member Functions
57
58 //- Write the profiling system-info, use dictionary format.
59 Ostream& write(Ostream& os) const;
60};
61
62
63// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64
65} // End namespace Foam
66
67// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68
69#endif
70
71// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
General system information useful for profiling.
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
runTime write()