tabulatedWallFunction.H
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) 2011 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::tabulatedWallFunctions::tabulatedWallFunction
28
29Description
30 Base class for models that generate tabulated wall function data.
31
32SourceFiles
33 tabulatedWallFunction.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef tabulatedWallFunction_H
38#define tabulatedWallFunction_H
39
40#include "dictionary.H"
41#include "polyMesh.H"
43#include "Switch.H"
45
46// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48namespace Foam
49{
50namespace tabulatedWallFunctions
51{
52
53/*---------------------------------------------------------------------------*\
54 Class tabulatedWallFunction Declaration
55\*---------------------------------------------------------------------------*/
58{
59protected:
60
61 // Protected data
62
63 //- Main dictionary
64 const dictionary dict_;
65
66 //- Reference to the mesh database
67 const polyMesh& mesh_;
68
69 //- Coefficients dictionary
71
72 //- Name of inverted table
74
75 //- Inverted table
77
78
79public:
80
81 //- Run-time type information
82 TypeName("tabulatedWallFunction");
83
84 //- Declare runtime constructor selection table
86 (
87 autoPtr,
90 (
91 const dictionary& dict,
92 const polyMesh& mesh
93 ),
94 (dict, mesh)
95 );
96
97 //- Constructor
99 (
100 const dictionary& dict,
101 const polyMesh& mesh,
102 const word& name
103 );
104
105 //- Destructor
106 virtual ~tabulatedWallFunction();
107
108
109 //- Selector
111 (
112 const dictionary& dict,
113 const polyMesh& mesh
114 );
115
116
117 // Member Functions
118
119 // Access
120
121 //- Return the inverted table name
122 inline const word& invertedTableName() const;
123
124 //- Return the inverted table
126 invertedTable() const;
127
128
129 // I-O
130
131 //- Write
132 virtual void write();
133};
134
135
136// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137
138} // End namespace tabulatedWallFunctions
139} // End namespace Foam
140
141// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142
144
145// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146
147#endif
148
149// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
Base class for models that generate tabulated wall function data.
uniformInterpolationTable< scalar > invertedTable_
Inverted table.
const uniformInterpolationTable< scalar > & invertedTable() const
Return the inverted table.
const word & invertedTableName() const
Return the inverted table name.
declareRunTimeSelectionTable(autoPtr, tabulatedWallFunction, dictionary,(const dictionary &dict, const polyMesh &mesh),(dict, mesh))
Declare runtime constructor selection table.
const dictionary coeffDict_
Coefficients dictionary.
tabulatedWallFunction(const dictionary &dict, const polyMesh &mesh, const word &name)
Constructor.
const polyMesh & mesh_
Reference to the mesh database.
TypeName("tabulatedWallFunction")
Run-time type information.
static autoPtr< tabulatedWallFunction > New(const dictionary &dict, const polyMesh &mesh)
Selector.
Table with uniform interval in independent variable, with linear interpolation.
A class for handling words, derived from Foam::string.
Definition: word.H:68
dynamicFvMesh & mesh
Namespace for OpenFOAM.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73