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 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 \*---------------------------------------------------------------------------*/
27 
28 #include "profilingPstream.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 Foam::autoPtr<Foam::cpuTime> Foam::profilingPstream::timer_(nullptr);
33 
34 Foam::autoPtr<Foam::cpuTime> Foam::profilingPstream::suspend_(nullptr);
35 
36 Foam::FixedList<Foam::scalar, 5> Foam::profilingPstream::times_(Zero);
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_.valid())
60  {
61  timer_->resetCpuTime(); // Not really needed ...
62  }
63  else if (suspend_.valid())
64  {
65  suspend_.swap(timer_);
66  timer_->resetCpuTime(); // Not really needed ...
67  }
68  else
69  {
70  timer_.reset(new cpuTime);
71  times_ = Zero;
72  }
73 
74  suspend_.clear();
75 }
76 
77 
79 {
80  timer_.clear();
81  suspend_.clear();
82 }
83 
84 
86 {
87  suspend_.clear();
88  suspend_.swap(timer_);
89 }
90 
91 
93 {
94  if (suspend_.valid())
95  {
96  timer_.clear();
97  timer_.swap(suspend_);
98  }
99 }
100 
101 
102 // ************************************************************************* //
Foam::Zero
static constexpr const zero Zero
Global zero.
Definition: zero.H:128
Foam::profilingPstream::suspend
static void suspend()
Suspend use of timer (if active)
Definition: profilingPstream.C:85
Foam::cpuTimeCxx
Starts timing CPU usage and return elapsed time from start.
Definition: cpuTimeCxx.H:53
Foam::profilingPstream::~profilingPstream
~profilingPstream()
Destructor - remove global timer.
Definition: profilingPstream.C:49
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::profilingPstream::disable
static void disable()
Remove timer for measuring communication activity.
Definition: profilingPstream.C:78
Foam::FixedList
A 1D vector of objects of type <T> with a fixed length <N>.
Definition: HashTable.H:104
Foam::profilingPstream::enable
static void enable()
Create timer for measuring communication, or reset existing.
Definition: profilingPstream.C:57
Foam::profilingPstream::profilingPstream
profilingPstream()
Construct and enable global timer.
Definition: profilingPstream.C:41
Foam::profilingPstream::resume
static void resume()
Resume use of timer (if previously active)
Definition: profilingPstream.C:92
profilingPstream.H