src/OpenFOAM/db/Time/subCycleTime.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  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 "Time.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                         Class subCycleTime Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class subCycleTime
  50 {
  51     // Private data
  52
  53         Time& time_;
  54
  55         label nSubCycles_;
  56         label subCycleIndex_;
  57
  58 public:
  59
  60     // Constructors
  61
  62         //- Construct from original time and number of sub-cycles
  63         subCycleTime(Time&, const label nSubCycles);
  64
  65
  66     //- Destructor
  67     ~subCycleTime();
  68
  69
  70     // Member functions
  71
  72         //- Return true if the number of sub-cycles has been reached
  73         bool end() const;
  74
  75         //- End the sub-cycling and reset the time-state
  76         void endSubCycle();
  77
  78
  79     // Member operators
  80
  81         //- Prefix increment
  82         subCycleTime& operator++();
  83
  84         //- Postfix increment
  85         subCycleTime& operator++(int);
  86 };
  87
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 } // End namespace Foam
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //