ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / OpenFOAM / db / Time / subCycleTime.C
blobfcfb07df63de49e877fa0e55eccb58ce7b605eba
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.
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.
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.
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/>.
24 \*---------------------------------------------------------------------------*/
26 #include "subCycleTime.H"
28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
30 Foam::subCycleTime::subCycleTime(Time& t, const label nSubCycles)
32     time_(t),
33     nSubCycles_(nSubCycles),
34     subCycleIndex_(0)
36     time_.subCycle(nSubCycles_);
40 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
42 Foam::subCycleTime::~subCycleTime()
44     endSubCycle();
48 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
50 bool Foam::subCycleTime::end() const
52     return subCycleIndex_ > nSubCycles_;
56 void Foam::subCycleTime::endSubCycle()
58     time_.endSubCycle();
62 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
64 Foam::subCycleTime& Foam::subCycleTime::operator++()
66     time_++;
67     subCycleIndex_++;
68     return *this;
72 Foam::subCycleTime& Foam::subCycleTime::operator++(int)
74     return operator++();
78 // ************************************************************************* //