setTimeStepFunctionObject.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) 2013-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 
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace functionObjects
34 {
35  defineTypeNameAndDebug(setTimeStepFunctionObject, 0);
36 
38  (
39  functionObject,
40  setTimeStepFunctionObject,
41  dictionary
42  );
43 }
44 }
45 
46 
47 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48 
49 Foam::functionObjects::setTimeStepFunctionObject::setTimeStepFunctionObject
50 (
51  const word& name,
52  const Time& runTime,
53  const dictionary& dict
54 )
55 :
56  functionObject(name),
57  time_(runTime)
58 {
59  read(dict);
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
70 
71 const Foam::Time&
73 {
74  return time_;
75 }
76 
77 
79 {
80  const_cast<Time&>(time()).setDeltaT
81  (
82  timeStepPtr_().value(time_.timeOutputValue()),
83  false
84  );
85 
86  return true;
87 }
88 
89 
91 (
92  const dictionary& dict
93 )
94 {
95  timeStepPtr_ = Function1<scalar>::New("deltaT", dict);
96 
97  // Check that adjustTimeStep is active
98  const dictionary& controlDict = time_.controlDict();
99 
100  Switch adjust;
101  if
102  (
103  !controlDict.readIfPresent<Switch>("adjustTimeStep", adjust)
104  || !adjust
105  )
106  {
108  << "Need to set 'adjustTimeStep' true to allow timestep control"
109  << exit(FatalIOError);
110  }
111 
112  return true;
113 }
114 
115 
117 {
118  return true;
119 }
120 
121 
123 {
124  return true;
125 }
126 
127 
128 // ************************************************************************* //
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
runTime controlDict().lookup("adjustTimeStep") >> adjustTimeStep
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool adjustTimeStep()
Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool write()
Called at each ++ or += of the time-loop.
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none.
Definition: Switch.H:60
Abstract base-class for Time/database function objects.
virtual bool execute()
Called at each ++ or += of the time-loop.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Macros for easy insertion into run-time selection tables.
bool read(const char *, int32_t &)
Definition: int32IO.C:85
A class for handling words, derived from string.
Definition: word.H:59
virtual bool read(const dictionary &)
Read and set the function object if its data have changed.
bool readIfPresent(const word &, T &, bool recursive=false, bool patternMatch=true) const
Find an entry if present, and assign to T.
const Time & time() const
Return time database.
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:331
defineTypeNameAndDebug(fvMeshFunctionObject, 0)
static autoPtr< Function1< Type > > New(const word &entryName, const dictionary &dict)
Selector.
Definition: Function1New.C:32
addToRunTimeSelectionTable(functionObject, add, dictionary)
Namespace for OpenFOAM.
IOerror FatalIOError