The open source CFD toolbox
timeControlFunctionObjectI.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29
31{
32 return dict_;
33}
34
35
36inline const Foam::timeControl&
38{
39 return executeControl_;
40}
41
42
43inline const Foam::timeControl&
45{
46 return writeControl_;
47}
48
49
50inline const Foam::functionObject&
52{
53 return *foPtr_;
54}
55
56
57// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Abstract base-class for Time/database function objects.
const Foam::timeControl & writeControl() const
Return the write control object.
const dictionary & dict() const
Return the input dictionary.
const Foam::timeControl & executeControl() const
Return the execute control object.
const functionObject & filter() const
Return the functionObject filter.
General time dependent execution controller. The execution parameters are given by the "Control" and ...
Definition: timeControl.H:62