TimeStateI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2021 OpenFOAM Foundation
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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return timeIndex_;
31 }
32 
33 
34 inline Foam::scalar Foam::TimeState::deltaTValue() const
35 {
36  return deltaT_;
37 }
38 
39 
40 inline Foam::scalar Foam::TimeState::deltaT0Value() const
41 {
42  return deltaT0_;
43 }
44 
45 
47 {
48  return dimensionedScalar("deltaT", dimTime, deltaT_);
49 }
50 
51 
53 {
54  return dimensionedScalar("deltaT0", dimTime, deltaT0_);
55 }
56 
57 
58 inline bool Foam::TimeState::writeTime() const
59 {
60  return writeTime_;
61 }
62 
63 
64 inline bool Foam::TimeState::outputTime() const
65 {
66  return writeTime_;
67 }
68 
69 
70 // ************************************************************************* //
dimensionedScalar deltaT0() const
Return old time step.
Definition: TimeStateI.H:52
bool writeTime() const
Return true if this is a write time.
Definition: TimeStateI.H:58
const dimensionSet dimTime
scalar deltaT0Value() const
Return old time step value.
Definition: TimeStateI.H:40
scalar deltaTValue() const
Return time step value.
Definition: TimeStateI.H:34
label timeIndex() const
Return current time index.
Definition: TimeStateI.H:28
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
bool outputTime() const
Return true if this is a write time.
Definition: TimeStateI.H:64
dimensionedScalar deltaT() const
Return time step.
Definition: TimeStateI.H:46