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

subCycle.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-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::subCycle
00026 
00027 Description
00028     Perform a subCycleTime on a field
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef subCycle_H
00033 #define subCycle_H
00034 
00035 #include <OpenFOAM/subCycleTime.H>
00036 
00037 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00038 
00039 namespace Foam
00040 {
00041 
00042 /*---------------------------------------------------------------------------*\
00043                            Class subCycle Declaration
00044 \*---------------------------------------------------------------------------*/
00045 
00046 template<class GeometricField>
00047 class subCycle
00048 :
00049     public subCycleTime
00050 {
00051     // Private data
00052 
00053         //- Reference to the field being sub-cycled
00054         GeometricField& gf_;
00055 
00056         //- Copy of the "real" old-time value of the field
00057         GeometricField  gf0_;
00058 
00059 
00060     // Private Member Functions
00061 
00062         //- Disallow default bitwise copy construct
00063         subCycle(const subCycle<GeometricField>&);
00064 
00065         //- Disallow default bitwise assignment
00066         void operator=(const subCycle<GeometricField>&);
00067 
00068 
00069 public:
00070 
00071     // Constructors
00072 
00073         //- Construct field and number of sub-cycles
00074         subCycle(GeometricField& gf, const label nSubCycles)
00075         :
00076             subCycleTime(const_cast<Time&>(gf.time()), nSubCycles),
00077             gf_(gf),
00078             gf0_(gf.oldTime())
00079         {}
00080 
00081 
00082     // Destructor
00083 
00084         ~subCycle()
00085         {
00086             // End the subCycleTime which restores the time state
00087             endSubCycle();
00088 
00089             // Correct the time index of the field to correspond to the global
00090             // time
00091             gf_.timeIndex() = gf_.time().timeIndex();
00092 
00093             // Reset the old-time field value
00094             gf_.oldTime() = gf0_;
00095             gf_.oldTime().timeIndex() = gf_.time().timeIndex();
00096         }
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines