timeControlI.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) 2016 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 
28 inline const Foam::Time& Foam::timeControl::time() const
29 {
30  return time_;
31 }
32 
33 
35 {
36  return timeControl_;
37 }
38 
39 
40 inline Foam::scalar Foam::timeControl::interval() const
41 {
42  return interval_;
43 }
44 
45 
47 {
48  return executionIndex_;
49 }
50 
51 
52 // ************************************************************************* //
label executionIndex() const
Return the index of the previous execution.
Definition: timeControlI.H:46
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
timeControls
The time control options.
Definition: timeControl.H:54
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
scalar interval() const
Return interval.
Definition: timeControlI.H:40
timeControls control() const
Return control.
Definition: timeControlI.H:34
const Time & time() const
Return Time.
Definition: timeControlI.H:28