src/OpenFOAM/db/Time/subCycleTime.C

   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "subCycleTime.H"
  27
  28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  29
  30 Foam::subCycleTime::subCycleTime(Time& t, const label nSubCycles)
  31 :
  32     time_(t),
  33     nSubCycles_(nSubCycles),
  34     subCycleIndex_(0)
  35 {
  36     time_.subCycle(nSubCycles_);
  37 }
  38
  39
  40 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  41
  42 Foam::subCycleTime::~subCycleTime()
  43 {
  44     endSubCycle();
  45 }
  46
  47
  48 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  49
  50 bool Foam::subCycleTime::end() const
  51 {
  52     return subCycleIndex_ > nSubCycles_;
  53 }
  54
  55
  56 void Foam::subCycleTime::endSubCycle()
  57 {
  58     time_.endSubCycle();
  59 }
  60
  61
  62 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
  63
  64 Foam::subCycleTime& Foam::subCycleTime::operator++()
  65 {
  66     time_++;
  67     subCycleIndex_++;
  68     return *this;
  69 }
  70
  71
  72 Foam::subCycleTime& Foam::subCycleTime::operator++(int)
  73 {
  74     return operator++();
  75 }
  76
  77
  78 // ************************************************************************* //