faOptionIO.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-2020 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 "faOption.H"
29 
30 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31 
33 {
34  os.beginBlock(name_);
35 }
36 
37 
39 {
40  os.endBlock();
41 }
42 
43 
45 {
46  os.writeEntry("type", type());
47  os.writeEntry("active", active_);
48 
49  os << nl;
50  coeffs_.writeEntry(word(type() + "Coeffs"), os);
51 }
52 
53 
55 {
56  dict.readIfPresent("active", active_);
57 
58  coeffs_ = dict.optionalSubDict(modelType_ + "Coeffs");
59 
60  return true;
61 }
62 
63 
64 // ************************************************************************* //
Foam::fa::option::writeFooter
virtual void writeFooter(Ostream &) const
Write the source footer information.
Definition: faOptionIO.C:38
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fa::option::name_
const word name_
Source name.
Definition: faOption.H:146
Foam::fa::option::writeData
virtual void writeData(Ostream &) const
Write the source properties.
Definition: faOptionIO.C:44
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::fa::option::writeHeader
virtual void writeHeader(Ostream &) const
Write the source header information.
Definition: faOptionIO.C:32
faOption.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam::fa::option::read
virtual bool read(const dictionary &dict)
Read source dictionary.
Definition: faOptionIO.C:54
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56