realTime.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) 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 #include "realTime.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace userTimes
34 {
37 }
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
44 :
46 {}
47 
48 
49 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
50 
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56 
57 Foam::scalar Foam::userTimes::real::userTimeToTime(const scalar tau) const
58 {
59  return tau;
60 }
61 
62 
63 Foam::scalar Foam::userTimes::real::timeToUserTime(const scalar t) const
64 {
65  return t;
66 }
67 
68 
70 {
71  return "s";
72 }
73 
74 
76 {
77  return true;
78 }
79 
80 
81 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A simple userTime which simply returns the real-time is seconds.
Definition: realTime.H:53
virtual scalar timeToUserTime(const scalar t) const
Return t (s)
Definition: realTime.C:63
real(const dictionary &controlDict)
Construct from controlDict.
Definition: realTime.C:43
virtual scalar userTimeToTime(const scalar tau) const
Return tau (s)
Definition: realTime.C:57
virtual ~real()
Destructor.
Definition: realTime.C:51
virtual bool read(const dictionary &controlDict)
Read the controlDict and set all the parameters.
Definition: realTime.C:75
virtual word unit() const
Return real-time unit (s)
Definition: realTime.C:69
A class for handling words, derived from string.
Definition: word.H:62
addToRunTimeSelectionTable(userTime, engine, dictionary)
defineTypeNameAndDebug(engine, 0)
Namespace for OpenFOAM.
runTime controlDict().lookup("adjustTimeStep") >> adjustTimeStep