fvOptionIO.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 | Copyright (C) 2011-2017 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 "fvOption.H"
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
31 {
32  os << indent << name_ << nl
34 }
35 
36 
38 {
39  os << decrIndent << indent << token::END_BLOCK << endl;
40 }
41 
42 
44 {
45  os.writeKeyword("type") << type() << token::END_STATEMENT << nl;
46  os.writeKeyword("active") << active_ << token::END_STATEMENT << nl << nl;
47 
48  os << indent << word(type() + "Coeffs");
49  coeffs_.write(os);
50 }
51 
52 
54 {
55  dict.readIfPresent("active", active_);
56 
57  coeffs_ = dict.optionalSubDict(modelType_ + "Coeffs");
58 
59  return true;
60 }
61 
62 
63 // ************************************************************************* //
Switch active_
Source active flag.
Definition: fvOption.H:88
void write(Ostream &, const bool subDict=true) const
Write dictionary, normally with sub-dictionary formatting.
Definition: dictionaryIO.C:172
dictionary dict
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:223
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
const dictionary & optionalSubDict(const word &) const
Find and return a sub-dictionary if found.
Definition: dictionary.C:759
const word name_
Source name.
Definition: fvOption.H:73
A class for handling words, derived from string.
Definition: word.H:59
const word modelType_
Model type.
Definition: fvOption.H:76
virtual void writeFooter(Ostream &) const
Write the source footer information.
Definition: fvOptionIO.C:37
bool readIfPresent(const word &, T &, bool recursive=false, bool patternMatch=true) const
Find an entry if present, and assign to T.
virtual bool read(const dictionary &dict)
Read source dictionary.
Definition: fvOptionIO.C:53
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:262
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:237
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:54
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:485
virtual void writeData(Ostream &) const
Write the source properties.
Definition: fvOptionIO.C:43
virtual void writeHeader(Ostream &) const
Write the source header information.
Definition: fvOptionIO.C:30
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:230
dictionary coeffs_
Dictionary containing source coefficients.
Definition: fvOption.H:85