BUG: UListIO: byteSize overflowing on really big faceLists
[OpenFOAM-2.0.x.git] / src / OpenFOAM / algorithms / subCycle / subCycle.H
blob7ead8235051bb033ffe23888798dfb20bcf0603a
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 Class
25     Foam::subCycle
27 Description
28     Perform a subCycleTime on a field
30 \*---------------------------------------------------------------------------*/
32 #ifndef subCycle_H
33 #define subCycle_H
35 #include "subCycleTime.H"
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 namespace Foam
42 /*---------------------------------------------------------------------------*\
43                           Class subCycle Declaration
44 \*---------------------------------------------------------------------------*/
46 template<class GeometricField>
47 class subCycle
49     public subCycleTime
51     // Private data
53         //- Reference to the field being sub-cycled
54         GeometricField& gf_;
56         //- Copy of the "real" old-time value of the field
57         GeometricField  gf0_;
60     // Private Member Functions
62         //- Disallow default bitwise copy construct
63         subCycle(const subCycle<GeometricField>&);
65         //- Disallow default bitwise assignment
66         void operator=(const subCycle<GeometricField>&);
69 public:
71     // Constructors
73         //- Construct field and number of sub-cycles
74         subCycle(GeometricField& gf, const label nSubCycles)
75         :
76             subCycleTime(const_cast<Time&>(gf.time()), nSubCycles),
77             gf_(gf),
78             gf0_(gf.oldTime())
79         {}
82     //- Destructor
83     ~subCycle()
84     {
85         // End the subCycleTime, which restores the time state
86         endSubCycle();
88         // Correct the time index of the field to correspond to the global time
89         gf_.timeIndex() = gf_.time().timeIndex();
91         // Reset the old-time field value
92         gf_.oldTime() = gf0_;
93         gf_.oldTime().timeIndex() = gf_.time().timeIndex();
94     }
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 } // End namespace Foam
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 #endif
106 // ************************************************************************* //