thermophysicalProperties.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) 2017 OpenFOAM Foundation
9  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(thermophysicalProperties, 0);
36  defineRunTimeSelectionTable(thermophysicalProperties,);
37  defineRunTimeSelectionTable(thermophysicalProperties, dictionary);
38 }
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 :
44  W_(W)
45 {}
46 
47 
49 :
50  W_(dict.get<scalar>("W"))
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
55 
58 (
59  const word& name
60 )
61 {
62  DebugInFunction << "Constructing thermophysicalProperties" << endl;
63 
64  auto* ctorPtr = ConstructorTable(name);
65 
66  if (!ctorPtr)
67  {
69  (
70  "thermophysicalProperties",
71  name,
72  *ConstructorTablePtr_
73  ) << exit(FatalError);
74  }
75 
76  return autoPtr<thermophysicalProperties>(ctorPtr());
77 }
78 
79 
82 (
83  const dictionary& dict
84 )
85 {
86  DebugInFunction << "Constructing thermophysicalProperties" << endl;
87 
88  const word& modelType = dict.dictName();
89 
90  auto* ctorPtr = dictionaryConstructorTable(modelType);
91 
92  if (!ctorPtr)
93  {
95  (
96  dict,
97  "thermophysicalProperties",
98  modelType,
99  *dictionaryConstructorTablePtr_
100  ) << exit(FatalIOError);
101  }
102 
103  return autoPtr<thermophysicalProperties>(ctorPtr(dict));
104 }
105 
106 
107 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
108 
110 {
111  dict.readIfPresent("W", W_);
112 }
113 
114 
116 {
117  os << W_;
118 }
119 
120 
121 // * * * * * * * * * * * * * * * Ostream Operator * * * * * * * * * * * * * //
122 
124 {
125  l.writeData(os);
126  return os;
127 }
128 
129 
130 // ************************************************************************* //
thermophysicalProperties.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::thermophysicalProperties::New
static autoPtr< thermophysicalProperties > New(const word &name)
Return a pointer to a new thermophysicalProperties created from name.
Definition: thermophysicalProperties.C:58
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition: boundaryPatch.C:83
Foam::thermophysicalProperties
Base-class for thermophysical properties of solids, liquids and gases providing an interface compatib...
Definition: thermophysicalProperties.H:55
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::thermophysicalProperties::thermophysicalProperties
thermophysicalProperties(scalar W)
Construct from molecular weight.
Definition: thermophysicalProperties.C:42
DebugInFunction
#define DebugInFunction
Report an information message using Foam::Info.
Definition: messageStream.H:388
Foam::thermophysicalProperties::writeData
virtual void writeData(Ostream &os) const =0
Write the function coefficients.
Definition: thermophysicalProperties.C:115
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
FatalErrorInLookup
#define FatalErrorInLookup(lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalError.
Definition: error.H:457
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::thermophysicalProperties::readIfPresent
void readIfPresent(const dictionary &dict)
Read and set the properties present it the given dictionary.
Definition: thermophysicalProperties.C:109
Foam::PtrListOps::get
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::dictionary::readIfPresent
bool readIfPresent(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:405
Foam::dictionary::dictName
word dictName() const
The local dictionary name (final part of scoped name)
Definition: dictionaryI.H:60