Zoltan2
Loading...
Searching...
No Matches
Zoltan2_TimerManager.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Zoltan2: A package of combinatorial algorithms for scientific computing
6// Copyright 2012 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Karen Devine (kddevin@sandia.gov)
39// Erik Boman (egboman@sandia.gov)
40// Siva Rajamanickam (srajama@sandia.gov)
41//
42// ***********************************************************************
43//
44// @HEADER
45
50#ifndef ZOLTAN2_TIMERMANAGER_HPP
51#define ZOLTAN2_TIMERMANAGER_HPP
52
53#include <Zoltan2_Standards.hpp>
55#include <Teuchos_TimeMonitor.hpp>
56
57#include <map>
58#include <iostream>
59#include <fstream>
60#include <bitset>
61
62namespace Zoltan2{
63
65
66private:
67 RCP<const Comm<int> > comm_;
68 std::ostream *myOS_;
69 std::ofstream *fileOS_;
70 TimerType ttype_;
71 std::bitset<NUM_TIMING_OPTIONS> typeSelector_;
72
73 Array<RCP<Teuchos::Time> > timers_;
74 std::map<std::string, int> timerMap_;
75 int stopHint_;
76
77public:
78
81 TimerManager(const RCP<const Comm<int> > & comm, std::ofstream *of,
82 TimerType tt);
83
86 TimerManager(const RCP<const Comm<int> > & comm, std::ostream *os,
87 TimerType tt);
88
92
95 void start(TimerType tt, const std::string &name);
96
99 void stop(TimerType tt, const std::string &name);
100
103 void printAndResetToZero();
104
107 void print() const;
108};
109
110} // namespace Zoltan2
111
112#endif
Defines Parameter related enumerators, declares functions.
Gathering definitions used in software development.
void stop(TimerType tt, const std::string &name)
Stop the named timer.
void print() const
Print out global summary, do not reset timers.
void start(TimerType tt, const std::string &name)
Start the named timer.
void printAndResetToZero()
Print out global summary of timers and reset timers to zero.
Created by mbenlioglu on Aug 31, 2020.
TimerType
The type of timers which should be active.