FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

subCycleTime.C

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 \*---------------------------------------------------------------------------*/
00025 
00026 #include <OpenFOAM/subCycleTime.H>
00027 
00028 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
00029 
00030 Foam::subCycleTime::subCycleTime(Time& t, const label nSubCycles)
00031 :
00032     time_(t),
00033     nSubCycles_(nSubCycles),
00034     subCycleIndex_(0)
00035 {
00036     time_.subCycle(nSubCycles_);
00037 }
00038 
00039 
00040 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
00041 
00042 Foam::subCycleTime::~subCycleTime()
00043 {
00044     endSubCycle();
00045 }
00046 
00047 
00048 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
00049 
00050 bool Foam::subCycleTime::end() const
00051 {
00052     return subCycleIndex_ > nSubCycles_;
00053 }
00054 
00055 
00056 void Foam::subCycleTime::endSubCycle()
00057 {
00058     time_.endSubCycle();
00059 }
00060 
00061 
00062 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
00063 
00064 Foam::subCycleTime& Foam::subCycleTime::operator++()
00065 {
00066     time_++;
00067     subCycleIndex_++;
00068     return *this;
00069 }
00070 
00071 
00072 Foam::subCycleTime& Foam::subCycleTime::operator++(int)
00073 {
00074     return operator++();
00075 }
00076 
00077 
00078 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines