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 Class 00025 Foam::subCycleTime 00026 00027 Description 00028 A class for managing sub-cycling times 00029 00030 SourceFiles 00031 subCycleTime.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef subCycleTime_H 00036 #define subCycleTime_H 00037 00038 #include <OpenFOAM/Time.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 00045 /*---------------------------------------------------------------------------*\ 00046 Class subCycleTime Declaration 00047 \*---------------------------------------------------------------------------*/ 00048 00049 class subCycleTime 00050 { 00051 // Private data 00052 00053 Time& time_; 00054 00055 label nSubCycles_; 00056 label subCycleIndex_; 00057 00058 public: 00059 00060 // Constructors 00061 00062 //- Construct from original time and number of sub-cycles 00063 subCycleTime(Time&, const label nSubCycles); 00064 00065 00066 // Destructor 00067 00068 ~subCycleTime(); 00069 00070 00071 // Member functions 00072 00073 //- Return true if the number of sub-cycles has been reached 00074 bool end() const; 00075 00076 //- End the sub-cycling and reset the time-state 00077 void endSubCycle(); 00078 00079 00080 // Member operators 00081 00082 //- Prefix increment 00083 subCycleTime& operator++(); 00084 00085 //- Postfix increment 00086 subCycleTime& operator++(int); 00087 }; 00088 00089 00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00091 00092 } // End namespace Foam 00093 00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00095 00096 #endif 00097 00098 // ************************ vim: set sw=4 sts=4 et: ************************ //
