src/foam/global/profiling/profilingPool.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::profilingPool
  26
  27 Description
  28     Collects all the data for profiling
  29
  30 SourceFiles
  31     profilingPool.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef profilingPool_H
  36 #define profilingPool_H
  37
  38 #include "regIOobject.H"
  39 #include "clockTime.H"
  40
  41 #include <map>
  42
  43 #include "profilingInfo.H"
  44 #include "profilingStack.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 // class Istream;
  53 class Ostream;
  54
  55 // // Forward declaration of friend functions and operators
  56 // Istream& operator>>(Istream&, profilingPool&);
  57 // Ostream& operator<<(Ostream&, const profilingPool&);
  58
  59
  60 /*---------------------------------------------------------------------------*\
  61                            Class profilingPool Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class profilingPool
  65 :
  66     public regIOobject
  67 {
  68     // Private typedefs
  69
  70         typedef std::multimap<Foam::string,Foam::profilingInfo*> mapType;
  71         typedef std::pair<Foam::string,Foam::profilingInfo*> mapValues;
  72         typedef mapType::iterator mapIterator;
  73         typedef mapType::const_iterator mapConstIterator;
  74
  75
  76     // Private data
  77
  78         mapType allInfo_;
  79
  80         profilingStack theStack_;
  81
  82         clockTime globalTime_;
  83
  84
  85     // Private Member Functions
  86
  87         //- Disallow default bitwise copy construct
  88         profilingPool(const profilingPool&);
  89
  90         //- Disallow default bitwise assignment
  91         void operator=(const profilingPool&);
  92
  93
  94     // Static data members
  95
  96         //- The only possible Pool-Object
  97         static profilingPool *thePool_;
  98
  99
 100     // Constructors
 101
 102         //- Construct null
 103         profilingPool(const IOobject&);
 104
 105
 106     //- Destructor
 107     ~profilingPool();
 108
 109
 110     // Member functions
 111
 112         mapType& map()
 113         {
 114             return allInfo_;
 115         }
 116
 117         const mapType& map() const
 118         {
 119             return allInfo_;
 120         }
 121
 122         profilingStack& stack()
 123         {
 124             return theStack_;
 125         }
 126
 127         const profilingStack& stack() const
 128         {
 129             return theStack_;
 130         }
 131
 132 public:
 133
 134     static void initprofiling(const IOobject&);
 135
 136     static profilingInfo& getInfo(const string& name);
 137
 138     static void remove(const profilingInfo& info);
 139
 140     static void rememberTimer(const profilingInfo& info, clockTime& timer);
 141
 142     virtual bool writeData(Ostream&) const;
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //