All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
timeControlFunctionObjectI.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 time_;
31 }
32 
33 
34 inline const Foam::timeControl&
36 {
37  return executeControl_;
38 }
39 
40 
41 inline const Foam::timeControl&
43 {
44  return writeControl_;
45 }
46 
47 
48 inline const Foam::functionObject&
50 {
51  return foPtr_();
52 }
53 
54 
55 // ************************************************************************* //
const Foam::timeControl & executeControl() const
Return the execute control object.
Abstract base-class for Time/database functionObjects.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
const functionObject & filter() const
Return the functionObject filter.
const Time & time() const
Return time database.
General time dependent execution controller. The default to execute every time-step.
Definition: timeControl.H:49
const Foam::timeControl & writeControl() const
Return the write control object.