OpenFOAM logo
Open Source CFD Toolkit

subCycleTime.H

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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     subCycleTime
00027 
00028 Description
00029 
00030 SourceFiles
00031     subCycleTime.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef subCycleTime_H
00036 #define subCycleTime_H
00037 
00038 #include "Time.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class subCycleTimeTime Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class subCycleTime
00050 {
00051     // Private data
00052 
00053         Time& time_;
00054 
00055         label nSubCycles_;
00056         label subCycleIndex_;
00057         TimeState initialTimeState_;
00058 
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Construct from original time and number of sub-cycles
00064         subCycleTime(Time& t, const label nSubCycles);
00065 
00066 
00067     // Destructor
00068 
00069         ~subCycleTime();
00070 
00071 
00072     // Member functions
00073 
00074         bool end() const;
00075 
00076 
00077     // Member operators
00078 
00079         //- Prefix increment
00080         subCycleTime& operator++();
00081 
00082         //- Postfix increment
00083         subCycleTime& operator++(int);
00084 };
00085 
00086 
00087 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00088 
00089 } // End namespace Foam
00090 
00091 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00092 
00093 #endif
00094 
00095 // ************************************************************************* //
For further information go to www.openfoam.org