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-2023 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  const word& name,
35  const dictionary& dict
36 )
37 :
38  Thermo(name, dict)
39 {
40  const dictionary& transportDict = dict.subDict("transport");
41 
42  mu_ = transportDict.lookup<scalar>("mu");
43 
44  const bool foundPr = transportDict.found("Pr");
45  const bool foundKappa = transportDict.found("kappa");
46 
47  if (foundPr == foundKappa)
48  {
50  << "Either Pr or kappa must be specified, but not both."
51  << exit(FatalIOError);
52  }
53 
54  constPr_ = foundPr;
55  rPr_ = constPr_ ? 1/transportDict.lookup<scalar>("Pr") : NaN;
56  kappa_ = constPr_ ? NaN : transportDict.lookup<scalar>("kappa");
57 }
58 
59 
60 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
61 
62 template<class Thermo>
64 {
65  os << this->name() << endl;
66  os << token::BEGIN_BLOCK << incrIndent << nl;
67 
68  Thermo::write(os);
69 
70  dictionary dict("transport");
71  dict.add("mu", mu_);
72  if (constPr_)
73  {
74  dict.add("Pr", 1.0/rPr_);
75  }
76  else
77  {
78  dict.add("kappa", kappa_);
79  }
80 
81  os << indent << dict.dictName() << dict;
82 
83  os << decrIndent << token::END_BLOCK << nl;
84 }
85 
86 
87 // * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
88 
89 template<class Thermo>
90 Foam::Ostream& Foam::operator<<(Ostream& os, const constTransport<Thermo>& ct)
91 {
92  ct.write(os);
93  return os;
94 }
95 
96 
97 // ************************************************************************* //
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
virtual Ostream & write(const char)=0
Write character.
constTransport(const Thermo &t, const scalar mu, const bool constPr, const scalar rPr, const scalar kappa)
Construct from components.
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:121
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:860
bool add(entry *, bool mergeEntry=false)
Add a new entry.
Definition: dictionary.C:1169
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:659
@ BEGIN_BLOCK
Definition: token.H:110
@ END_BLOCK
Definition: token.H:111
A class for handling words, derived from string.
Definition: word.H:62
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:318
static Type NaN()
Return a primitive with all components set to NaN.
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Ostream & decrIndent(Ostream &os)
Decrement the indent level.
Definition: Ostream.H:235
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Ostream & incrIndent(Ostream &os)
Increment the indent level.
Definition: Ostream.H:228
IOerror FatalIOError
Ostream & operator<<(Ostream &, const ensightPart &)
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:221
static const char nl
Definition: Ostream.H:260
dictionary dict