IOdictionaryIO.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) 2011-2020 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 "IOdictionary.H"
27 
28 // * * * * * * * * * * * * * * * Members Functions * * * * * * * * * * * * * //
29 
31 {
32  is >> *this;
33 
34  if (writeDictionaries && Pstream::master() && !is.bad())
35  {
36  Sout<< nl
37  << "--- IOdictionary " << name()
38  << ' ' << objectPath() << ":" << nl;
40  writeData(Sout);
41  Sout<< "--- End of IOdictionary " << name() << nl << endl;
42  }
43 
44  return !is.bad();
45 }
46 
47 
49 {
50  dictionary::write(os, false);
51  return os.good();
52 }
53 
54 
55 // ************************************************************************* //
void write(Ostream &, const bool subDict=true) const
Write dictionary, normally with sub-dictionary formatting.
Definition: dictionaryIO.C:207
static bool writeDictionaries
Definition: IOdictionary.H:74
bool bad() const
Return true if stream is corrupted.
Definition: IOstream.H:348
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
static bool master(const label communicator=0)
Am I the master process.
Definition: UPstream.H:423
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:330
const fileName & name() const
Return the dictionary name.
Definition: dictionary.H:109
OSstream Sout(cout, "Sout")
Definition: IOstreams.H:51
virtual bool writeData(Ostream &) const
WriteData function required for regIOobject write operation.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
static const char nl
Definition: Ostream.H:260
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
bool writeHeader(Ostream &) const
Write header.
fileName objectPath() const
Return complete path + object name.
Definition: IOobject.H:419