FreeFOAM The Cross-Platform CFD Toolkit
subCycleTime.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::subCycleTime
26 
27 Description
28  A class for managing sub-cycling times
29 
30 SourceFiles
31  subCycleTime.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef subCycleTime_H
36 #define subCycleTime_H
37 
38 #include <OpenFOAM/Time.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class subCycleTime Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private data
52 
53  Time& time_;
54 
55  label nSubCycles_;
56  label subCycleIndex_;
57 
58 public:
59 
60  // Constructors
61 
62  //- Construct from original time and number of sub-cycles
63  subCycleTime(Time&, const label nSubCycles);
64 
65 
66  // Destructor
67 
68  ~subCycleTime();
69 
70 
71  // Member functions
72 
73  //- Return true if the number of sub-cycles has been reached
74  bool end() const;
75 
76  //- End the sub-cycling and reset the time-state
77  void endSubCycle();
78 
79 
80  // Member operators
81 
82  //- Prefix increment
84 
85  //- Postfix increment
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************ vim: set sw=4 sts=4 et: ************************ //