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-2017 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
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 
26 Class
27  Foam::profilingSysInfo
28 
29 Description
30  General system information useful for profiling
31 
32 SourceFiles
33  profilingSysInfo.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef profilingSysInfo_H
38 #define profilingSysInfo_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of classes
46 class Ostream;
47 class profilingSysInfo;
48 
49 /*---------------------------------------------------------------------------*\
50  Class profilingSysInfo Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class profilingSysInfo
54 {
55 public:
56 
57  // Constructors
58 
59  //- Construct null
60  profilingSysInfo() = default;
61 
62 
63  //- Destructor
64  ~profilingSysInfo() = default;
65 
66 
67  // Member Functions
68 
69  //- Update it with a new timing information
70  void update();
71 
72  //- Write the profiling system-info, use dictionary format.
73  Ostream& write(Ostream& os) const;
74 };
75 
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 } // End namespace Foam
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
Foam::profilingSysInfo::update
void update()
Update it with a new timing information.
Foam::profilingSysInfo::profilingSysInfo
profilingSysInfo()=default
Construct null.
Foam::profilingSysInfo
General system information useful for profiling.
Definition: profilingSysInfo.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::profilingSysInfo::~profilingSysInfo
~profilingSysInfo()=default
Destructor.
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::profilingSysInfo::write
Ostream & write(Ostream &os) const
Write the profiling system-info, use dictionary format.
Definition: profilingSysInfo.C:60