OpenFOAM
v2312
The open source CFD toolbox
IOdictionary.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) 2011-2017 OpenFOAM Foundation
9
Copyright (C) 2021-2023 OpenCFD Ltd.
10
-------------------------------------------------------------------------------
11
License
12
This file is part of OpenFOAM.
13
14
OpenFOAM is free software: you can redistribute it and/or modify it
15
under the terms of the GNU General Public License as published by
16
the Free Software Foundation, either version 3 of the License, or
17
(at your option) any later version.
18
19
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22
for more details.
23
24
You should have received a copy of the GNU General Public License
25
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27
\*---------------------------------------------------------------------------*/
28
29
#include "
IOdictionary.H
"
30
#include "
objectRegistry.H
"
31
#include "
Pstream.H
"
32
#include "
Time.H
"
33
34
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
35
36
Foam::IOdictionary::IOdictionary
37
(
38
const
IOobject
&
io
,
39
const
dictionary
* fallback
40
)
41
:
42
IOdictionary
(
io
, typeName, fallback)
43
{}
44
45
46
Foam::IOdictionary::IOdictionary
47
(
48
const
IOobject
&
io
,
49
const
dictionary
&
dict
50
)
51
:
52
IOdictionary
(
io
, typeName, &
dict
)
53
{}
54
55
56
Foam::IOdictionary::IOdictionary
57
(
58
const
IOobject
&
io
,
59
const
word
& wantedType,
60
const
dictionary
* fallback
61
)
62
:
63
baseIOdictionary
(
io
, fallback)
64
{
65
if
(!
readHeaderOk
(
IOstreamOption::ASCII
, wantedType) && fallback)
66
{
67
dictionary::operator=
(*fallback);
68
}
69
70
// For if MUST_READ_IF_MODIFIED
71
addWatch
();
72
}
73
74
75
Foam::IOdictionary::IOdictionary
76
(
77
const
IOobject
&
io
,
78
Istream
& is
79
)
80
:
81
baseIOdictionary
(
io
, is)
82
{
83
// Default construct dictionary and read in afterwards
84
// so that if there is some fancy massaging due to a
85
// functionEntry in
86
// the dictionary at least the type information is already complete.
87
is >> *
this
;
88
89
// For if MUST_READ_IF_MODIFIED
90
addWatch
();
91
}
92
93
94
// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
95
96
Foam::dictionary
Foam::IOdictionary::readContents
(
const
IOobject
&
io
)
97
{
98
IOobject
rio(
io
,
IOobjectOption::NO_REGISTER
);
99
if
(rio.readOpt() ==
IOobjectOption::MUST_READ_IF_MODIFIED
)
100
{
101
rio.readOpt(
IOobjectOption::MUST_READ
);
102
}
103
104
IOdictionary reader(rio);
105
106
return
dictionary
(std::move(static_cast<dictionary&>(reader)));
107
}
108
109
110
// ************************************************************************* //
dict
dictionary dict
Definition:
searchingEngine.H:11
Foam::baseIOdictionary
baseIOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO function...
Definition:
baseIOdictionary.H:52
Foam::IOdictionary::IOdictionary
IOdictionary(const IOobject &io, const dictionary *fallback=nullptr)
Construct given an IOobject and optional fallback dictionary content.
Definition:
IOdictionary.C:30
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition:
dictionary.H:129
Time.H
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition:
Istream.H:57
Foam::IOstreamOption::ASCII
"ascii" (normal default)
Definition:
IOstreamOption.H:73
Foam::IOdictionary::readContents
static dictionary readContents(const IOobject &io)
Read and return contents. The IOobject will not be registered.
Definition:
IOdictionary.C:89
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition:
IOdictionary.H:50
Foam::dictionary::operator=
void operator=(const dictionary &rhs)
Copy assignment.
Definition:
dictionary.C:868
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:63
Foam::IOobjectOption::MUST_READ_IF_MODIFIED
Definition:
IOobjectOption.H:71
Pstream.H
objectRegistry.H
Foam::IOobjectOption::MUST_READ
Reading required.
Definition:
IOobjectOption.H:63
IOdictionary.H
Foam::regIOobject::addWatch
virtual void addWatch()
Add file watch on object (if registered and READ_IF_MODIFIED)
Definition:
regIOobject.C:277
writeChecksFormatType::dictionary
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition:
IOobject.H:172
Foam::regIOobject::readHeaderOk
bool readHeaderOk(const IOstreamOption::streamFormat fmt, const word &typeName)
Helper: check readOpt flags and read if necessary.
Definition:
regIOobjectRead.C:32
Foam::IOobjectOption::NO_REGISTER
Do not request registration (bool: false)
Definition:
IOobjectOption.H:99
src
OpenFOAM
db
IOobjects
IOdictionary
IOdictionary.C
Generated by
1.8.14