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