File size: 5,948 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::turbulenceFields
Description
Stores derived turbulence fields on the mesh database for further
manipulation.
Usage
\table
Property | Description | Required | Default value
type | Type name: processorField | yes |
fields | Fields to store (see below) | yes |
prefix | If true prefix fields | no | no
phase | phase name | no |
\endtable
Where \c fields can include:
\plaintable
k | turbulence kinetic energy
epsilon | turbulence kinetic energy dissipation rate
omega | turbulence specific dissipation rate
nut | turbulence viscosity (incompressible)
nuEff | effective turbulence viscosity (incompressible)
nut | turbulence viscosity (compressible)
nuEff | effective turbulence viscosity (compressible)
kappaEff | effective turbulence thermal diffusivity (compressible)
R | Reynolds stress tensor
\endplaintable
If the optional \c prefix entry is set true the turbulence fields are stored
with the prefix "momentumTransportModel:", e.g.:
\verbatim
momentumTransportModel:R
\endverbatim
Example of function object specification:
\verbatim
turbulenceFields1
{
type turbulenceFields;
libs ("libfieldFunctionObjects.so");
...
fields
(
R
devTau
);
}
\endverbatim
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::timeControl
SourceFiles
turbulenceFields.C
\*---------------------------------------------------------------------------*/
#ifndef turbulenceFields_functionObject_H
#define turbulenceFields_functionObject_H
#include "fvMeshFunctionObject.H"
#include "HashSet.H"
#include "NamedEnum.H"
#include "volFieldsFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class turbulenceFields Declaration
\*---------------------------------------------------------------------------*/
class turbulenceFields
:
public fvMeshFunctionObject
{
public:
enum class compressibleField
{
k,
epsilon,
omega,
nut,
nuEff,
kappaEff,
R
};
static const NamedEnum<compressibleField, 7> compressibleFieldNames_;
enum class incompressibleField
{
k,
epsilon,
omega,
nut,
nuEff,
R
};
static const NamedEnum<incompressibleField, 6> incompressibleFieldNames_;
protected:
// Protected data
//- Fields to load
wordHashSet fieldSet_;
//- Optional field prefix to avoid name clashes
// Defaults to null
word prefix_;
//- Optional phase name
word phaseName_;
// Protected Member Functions
word modelName();
//- Process the turbulence field
template<class Type>
void processField
(
const word& fieldName,
const tmp<VolField<Type>>& tvalue
);
public:
//- Runtime type information
TypeName("turbulenceFields");
// Constructors
//- Construct from Time and dictionary
turbulenceFields
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
turbulenceFields(const turbulenceFields&) = delete;
//- Destructor
virtual ~turbulenceFields();
// Member Functions
//- Read the controls
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Calculate turbulence fields
virtual bool execute();
//- Write the turbulence fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const turbulenceFields&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "turbulenceFieldsTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|