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) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::subCycleTime
  27
  28 Description
  29     A class for managing sub-cycling times
  30
  31 SourceFiles
  32     subCycleTime.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef subCycleTime_H
  37 #define subCycleTime_H
  38
  39 #include "Time.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         TimeState initialTimeState_;
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct from original time and number of sub-cycles
  65         subCycleTime(Time&, const label nSubCycles);
  66
  67
  68     // Destructor
  69
  70         ~subCycleTime();
  71
  72
  73     // Member functions
  74
  75         //- Return true if the number of sub-cycles has been reached
  76         bool end() const;
  77
  78         //- End the sub-cycling and reset the time-state
  79         void endSubCycle();
  80
  81
  82     // Member operators
  83
  84         //- Prefix increment
  85         subCycleTime& operator++();
  86
  87         //- Postfix increment
  88         subCycleTime& operator++(int);
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //