src/OpenFOAM/algorithms/subCycle/subCycle.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::subCycle
  27
  28 Description
  29     Perform a subCycleTime on a field
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef subCycle_H
  34 #define subCycle_H
  35
  36 #include <OpenFOAM/subCycleTime.H>
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class subCycle Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class GeometricField>
  48 class subCycle
  49 :
  50     public subCycleTime
  51 {
  52     // Private data
  53
  54         //- Reference to the field being sub-cycled
  55         GeometricField& gf_;
  56
  57         //- Copy of the "real" old-time value of the field
  58         GeometricField  gf0_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow default bitwise copy construct
  64         subCycle(const subCycle<GeometricField>&);
  65
  66         //- Disallow default bitwise assignment
  67         void operator=(const subCycle<GeometricField>&);
  68
  69
  70 public:
  71
  72     // Constructors
  73
  74         //- Construct field and number of sub-cycles
  75         subCycle(GeometricField& gf, const label nSubCycles)
  76         :
  77             subCycleTime(const_cast<Time&>(gf.time()), nSubCycles),
  78             gf_(gf),
  79             gf0_(gf.oldTime())
  80         {}
  81
  82
  83     // Destructor
  84
  85         ~subCycle()
  86         {
  87             // End the subCycleTime which restores the time state
  88             endSubCycle();
  89
  90             // Correct the time index of the field to correspond to the global
  91             // time
  92             gf_.timeIndex() = gf_.time().timeIndex();
  93
  94             // Reset the old-time field value
  95             gf_.oldTime() = gf0_;
  96             gf_.oldTime().timeIndex() = gf_.time().timeIndex();
  97         }
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************ vim: set sw=4 sts=4 et: ************************ //