OpenFOAM: API Guide
v2112
The open source CFD toolbox
timeFunctionObject.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 | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2019 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
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
#include "
timeFunctionObject.H
"
29
#include "
Time.H
"
30
31
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32
33
Foam::functionObjects::timeFunctionObject::timeFunctionObject
34
(
35
const
word
&
name
,
36
const
Time
&
runTime
37
)
38
:
39
functionObject
(
name
),
40
time_(
runTime
)
41
{}
42
43
44
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
45
46
void
Foam::functionObjects::timeFunctionObject::clearOutputObjects
47
(
48
const
wordList
& objNames
49
)
50
{
51
objectRegistry
& obr = storedObjects();
52
53
for
(
const
word
& objName : objNames)
54
{
55
obr.
checkOut
(objName);
56
}
57
}
58
59
60
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
61
62
Foam::objectRegistry
&
63
Foam::functionObjects::timeFunctionObject::storedObjects
()
64
{
65
return
const_cast<
Time
&
>
(
time_
).functionObjects().storedObjects();
66
}
67
68
69
const
Foam::objectRegistry
&
70
Foam::functionObjects::timeFunctionObject::storedObjects
()
const
71
{
72
return
time_.functionObjects().storedObjects();
73
}
74
75
76
// ************************************************************************* //
runTime
engineTime & runTime
Definition:
createEngineTime.H:13
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition:
Time.H:73
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:65
Foam::functionObjects::timeFunctionObject::storedObjects
objectRegistry & storedObjects()
Definition:
timeFunctionObject.C:63
Foam::functionObjects::timeFunctionObject::time_
const Time & time_
Reference to the time database.
Definition:
timeFunctionObject.H:65
Foam::functionObjects::timeFunctionObject::timeFunctionObject
timeFunctionObject(const timeFunctionObject &)=delete
No copy construct.
Foam::functionObject
Abstract base-class for Time/database function objects.
Definition:
functionObject.H:332
timeFunctionObject.H
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:60
Time.H
Foam::List< word >
Foam::functionObjects::timeFunctionObject::clearOutputObjects
void clearOutputObjects(const wordList &objNames)
Remove specified items from "functionObjectObjects".
Definition:
timeFunctionObject.C:47
Foam::objectRegistry::checkOut
bool checkOut(regIOobject *io) const
Definition:
objectRegistry.C:254
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition:
exprTraits.C:59
src
OpenFOAM
db
functionObjects
timeFunctionObject
timeFunctionObject.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.