setTimeStepFunctionObject.C
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) 2013-2018 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()).setDeltaTNoAdjust
81  (
82  timeStepPtr_().value(time_.timeOutputValue())
83  );
84 
85  return true;
86 }
87 
88 
90 (
91  const dictionary& dict
92 )
93 {
94  timeStepPtr_ = Function1<scalar>::New("deltaT", dict);
95 
96  return true;
97 }
98 
99 
101 {
102  bool adjustTimeStep =
103  time().controlDict().lookupOrDefault("adjustTimeStep", false);
104 
105  if (!adjustTimeStep)
106  {
107  return setTimeStep();
108  }
109 
110  return true;
111 }
112 
113 
115 {
116  return true;
117 }
118 
119 
120 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool write()
Called at each ++ or += of the time-loop.
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.
const Time & time() const
Return time database.
Writes run time, CPU time and clock time and optionally the CPU and clock times per time step...
defineTypeNameAndDebug(fvMeshFunctionObject, 0)
virtual bool setTimeStep()
Override the time-step value.
bool adjustTimeStep
static autoPtr< Function1< Type > > New(const word &entryName, const dictionary &dict)
Selector.
Definition: Function1New.C:32
addToRunTimeSelectionTable(functionObject, add, dictionary)
Namespace for OpenFOAM.