profilingPstream.C
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) 2019-2020 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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\*---------------------------------------------------------------------------*/
27
28#include "profilingPstream.H"
29
30// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31
32std::unique_ptr<Foam::cpuTime> Foam::profilingPstream::timer_(nullptr);
33
34Foam::profilingPstream::timingList Foam::profilingPstream::times_(Zero);
35
36bool Foam::profilingPstream::suspend_(false);
37
38
39// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40
42{
43 enable();
44}
45
46
47// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
48
50{
51 disable();
52}
53
54
55// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56
58{
59 if (timer_)
60 {
61 timer_->resetCpuTime(); // Not necessarily required ...
62 }
63 else
64 {
65 timer_.reset(new cpuTime);
66 times_ = Zero;
67 }
68
69 suspend_ = false;
70}
71
72
74{
75 timer_.reset(nullptr);
76 suspend_ = false;
77}
78
79
80// ************************************************************************* //
A 1D vector of objects of type <T> with a fixed length <N>.
Definition: FixedList.H:81
Starts timing CPU usage and return elapsed time from start.
Definition: cpuTimeCxx.H:54
static void enable()
Create timer for measuring communication, or reset existing.
~profilingPstream()
Destructor, disables global timer.
static void disable()
Remove timer for measuring communication activity.
profilingPstream()
Default construct, enables global timer.
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131