src/foam/global/profiling/profiling.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   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
  26 Description
  27     Add everything necessary for profiling plus a macro
  28
  29     Originally proposed in
  30     http://www.cfd-online.com/Forums/openfoam-bugs/64081-feature-proposal-application-level-profiling.html
  31
  32 SourceFiles
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef profiling_H
  37 #define profiling_H
  38
  39 #include "profilingTrigger.H"
  40
  41 // to be used at the beginning of a section to be profiled
  42 // profiling ends automatically at the end of a block
  43 #define addProfile(name) Foam::profilingTrigger profileTriggerFor##name (#name)
  44
  45 // Use this if a description with spaces, colons etc should be added
  46 #define addProfile2(name,descr) Foam::profilingTrigger profileTriggerFor##name (descr)
  47
  48 // this is only needed if profiling should end before the end of a block
  49 #define endProfile(name) profileTriggerFor##name.stop()
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 #endif
  54
  55 // ************************************************************************* //