Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_MemUtils.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Panzer: A partial differential equation assembly
5// engine for strongly coupled complex multiphysics systems
6// Copyright (2011) 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 Roger P. Pawlowski (rppawlo@sandia.gov) and
39// Eric C. Cyr (eccyr@sandia.gov)
40// ***********************************************************************
41// @HEADER
42
43#ifndef PANZER_MEMUTILS_HPP
44#define PANZER_MEMUTILS_HPP
45
46#include <Teuchos_Comm.hpp>
47#include <iostream>
48
49namespace panzer
50{
52 struct MemUsage
53 {
55 MemUsage(size_t inCurrMin = 0, size_t inCurrMax = 0, size_t inCurrTot = 0,
56 size_t inPeakMin = 0, size_t inPeakMax = 0, size_t inPeakTot = 0)
57 :
58 currMin(inCurrMin), currMax(inCurrMax), currTot(inCurrTot), peakMin(inPeakMin),
59 peakMax(inPeakMax), peakTot(inPeakTot)
60 {
61 }
62 MemUsage operator+(const MemUsage& that) const
63 {
64 return MemUsage(currMin + that.currMin, currMax + that.currMax,
65 currTot + that.currTot, peakMin + that.peakMin, peakMax + that.peakMax,
66 peakTot + that.peakTot);
67 }
68 MemUsage operator-(const MemUsage& that) const
69 {
70 return MemUsage(currMin - that.currMin, currMax - that.currMax,
71 currTot - that.currTot, peakMin - that.peakMin, peakMax - that.peakMax,
72 peakTot - that.peakTot);
73 }
74 MemUsage& operator*=(const size_t& that)
75 {
76 currMin *= that; peakMin *= that;
77 currMax *= that; peakMax *= that;
78 currTot *= that; peakTot *= that;
79 return *this;
80 }
81 MemUsage& operator/=(const size_t& that)
82 {
83 currMin /= that; peakMin /= that;
84 currMax /= that; peakMax /= that;
85 currTot /= that; peakTot /= that;
86 return *this;
87 }
88 };
90
92 void printMemoryUsage(std::ostream& os, const Teuchos::Comm<int>& comm);
93 void printMemoryUsage(std::ostream& os, const Teuchos::Comm<int>& comm,
94 const MemUsage& mem);
95 void pretty(std::ostream& s, size_t num);
96
98 MemUsage getMemoryUsage(const Teuchos::Comm<int>& comm);
99
102 MemUsage getPeakRSS(const Teuchos::Comm<int>& comm);
103
106 MemUsage getCurrentRSS(const Teuchos::Comm<int>& comm);
107
109 MemUsage reduceMemUsage(size_t& mem, const Teuchos::Comm<int>& comm,
110 const MemUsageType& type);
111} // end namespace panzer
112
113#endif // PANZER_MEMUTILS_HPP
MemUsage getCurrentRSS(const Teuchos::Comm< int > &comm)
void pretty(std::ostream &s, size_t num)
void printMemoryUsage(std::ostream &s, const Teuchos::Comm< int > &comm)
Print memory usage to stream.
MemUsage reduceMemUsage(size_t &mem, const Teuchos::Comm< int > &comm, const MemUsageType &type)
Reduce the memory usage over all the processors.
MemUsage getMemoryUsage(const Teuchos::Comm< int > &comm)
Get memory usage in B.
MemUsage getPeakRSS(const Teuchos::Comm< int > &comm)
The memory usage information.
MemUsage(size_t inCurrMin=0, size_t inCurrMax=0, size_t inCurrTot=0, size_t inPeakMin=0, size_t inPeakMax=0, size_t inPeakTot=0)
MemUsage operator-(const MemUsage &that) const
MemUsage & operator/=(const size_t &that)
MemUsage & operator*=(const size_t &that)
MemUsage operator+(const MemUsage &that) const