constTransport.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-2021 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 "constTransport.H"
27 #include "IOstreams.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Thermo>
33 :
34  Thermo(dict)
35 {
36  const dictionary& transportDict = dict.subDict("transport");
37 
38  mu_ = transportDict.lookup<scalar>("mu");
39 
40  const bool foundPr = transportDict.found("Pr");
41  const bool foundKappa = transportDict.found("kappa");
42 
43  if (foundPr == foundKappa)
44  {
46  << "Either Pr or kappa must be specified, but not both."
47  << exit(FatalIOError);
48  }
49 
50  constPr_ = foundPr;
51  rPr_ = constPr_ ? 1/transportDict.lookup<scalar>("Pr") : NaN;
52  kappa_ = constPr_ ? NaN : transportDict.lookup<scalar>("kappa");
53 }
54 
55 
56 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
57 
58 template<class Thermo>
60 {
61  os << this->name() << endl;
62  os << token::BEGIN_BLOCK << incrIndent << nl;
63 
64  Thermo::write(os);
65 
66  dictionary dict("transport");
67  dict.add("mu", mu_);
68  if (constPr_)
69  {
70  dict.add("Pr", 1.0/rPr_);
71  }
72  else
73  {
74  dict.add("kappa", kappa_);
75  }
76 
77  os << indent << dict.dictName() << dict;
78 
79  os << decrIndent << token::END_BLOCK << nl;
80 }
81 
82 
83 // * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
84 
85 template<class Thermo>
86 Foam::Ostream& Foam::operator<<(Ostream& os, const constTransport<Thermo>& ct)
87 {
88  ct.write(os);
89  return os;
90 }
91 
92 
93 // ************************************************************************* //
dictionary dict
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:663
virtual Ostream & write(const char)=0
Write character.
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:221
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Transport package with constant properties.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
bool add(entry *, bool mergeEntry=false)
Add a new entry.
Definition: dictionary.C:1153
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:121
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:1002
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
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
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:235
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:318
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:228
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:864
IOerror FatalIOError