src/foam/db/Time/subCycleTime.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     Foam::subCycleTime
  26
  27 Description
  28     A class for managing sub-cycling times
  29
  30 SourceFiles
  31     subCycleTime.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef subCycleTime_H
  36 #define subCycleTime_H
  37
  38 #include "objectRegistry.H"
  39 #include "foamTime.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class subCycleTime Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class subCycleTime
  51 {
  52     // Private data
  53
  54         Time& time_;
  55
  56         label nSubCycles_;
  57         label subCycleIndex_;
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Construct from original time and number of sub-cycles
  64         subCycleTime(Time&, const label nSubCycles);
  65
  66
  67     // Destructor
  68
  69         ~subCycleTime();
  70
  71
  72     // Member functions
  73
  74         //- Return true if the number of sub-cycles has been reached
  75         bool end() const;
  76
  77         //- End the sub-cycling and reset the time-state
  78         void endSubCycle();
  79
  80
  81     // Member operators
  82
  83         //- Prefix increment
  84         subCycleTime& operator++();
  85
  86         //- Postfix increment
  87         subCycleTime& operator++(int);
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace Foam
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #endif
  98
  99 // ************************************************************************* //