Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
algorithms
subCycle
subCycle.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::subCycle
26
27
Description
28
Perform a subCycleTime on a field
29
30
\*---------------------------------------------------------------------------*/
31
32
#ifndef subCycle_H
33
#define subCycle_H
34
35
#include <
OpenFOAM/subCycleTime.H
>
36
37
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38
39
namespace
Foam
40
{
41
42
/*---------------------------------------------------------------------------*\
43
Class subCycle Declaration
44
\*---------------------------------------------------------------------------*/
45
46
template
<
class
GeometricField>
47
class
subCycle
48
:
49
public
subCycleTime
50
{
51
// Private data
52
53
//- Reference to the field being sub-cycled
54
GeometricField
& gf_;
55
56
//- Copy of the "real" old-time value of the field
57
GeometricField
gf0_;
58
59
60
// Private Member Functions
61
62
//- Disallow default bitwise copy construct
63
subCycle
(
const
subCycle<GeometricField>
&);
64
65
//- Disallow default bitwise assignment
66
void
operator=(
const
subCycle<GeometricField>
&);
67
68
69
public
:
70
71
// Constructors
72
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
{}
80
81
82
// Destructor
83
84
~subCycle
()
85
{
86
// End the subCycleTime which restores the time state
87
endSubCycle
();
88
89
// Correct the time index of the field to correspond to the global
90
// time
91
gf_.
timeIndex
() = gf_.
time
().
timeIndex
();
92
93
// Reset the old-time field value
94
gf_.
oldTime
() = gf0_;
95
gf_.
oldTime
().timeIndex() = gf_.
time
().
timeIndex
();
96
}
97
};
98
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
}
// End namespace Foam
103
104
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106
#endif
107
108
// ************************ vim: set sw=4 sts=4 et: ************************ //