FreeFOAM The Cross-Platform CFD Toolkit
TimeState.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include <OpenFOAM/TimeState.H>
27 #include <OpenFOAM/Time.H>
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
32 :
34  timeIndex_(0),
35  deltaT_(0),
36  deltaTSave_(0),
37  deltaT0_(0),
38  deltaTchanged_(false),
39  outputTimeIndex_(0),
40  outputTime_(false)
41 {}
42 
43 
44 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * * //
45 
47 {}
48 
49 
50 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
51 
52 Foam::scalar Foam::TimeState::userTimeToTime(const scalar theta) const
53 {
54  return theta;
55 }
56 
57 
58 Foam::scalar Foam::TimeState::timeToUserTime(const scalar t) const
59 {
60  return t;
61 }
62 
63 
65 {
66  return timeToUserTime(value());
67 }
68 
69 
70 Foam::label Foam::TimeState::timeIndex() const
71 {
72  return timeIndex_;
73 }
74 
75 
77 {
78  return dimensionedScalar("deltaT", dimTime, deltaT_);
79 }
80 
81 
83 {
84  return dimensionedScalar("deltaT0", dimTime, deltaT0_);
85 }
86 
87 
89 {
90  return outputTime_;
91 }
92 
93 
94 // ************************ vim: set sw=4 sts=4 et: ************************ //