226 lines
6.0 KiB
C++
226 lines
6.0 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration | Website: https://openfoam.org
|
|
\\ / A nd | Copyright (C) 2013-2019 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 turbulence fields on the mesh database for further manipulation.
|
|
|
|
Fields are stored as copies of the original, with the prefix
|
|
"tubulenceModel:", e.g.:
|
|
|
|
\verbatim
|
|
turbulenceModel:R
|
|
\endverbatim
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
turbulenceFields1
|
|
{
|
|
type turbulenceFields;
|
|
libs ("libfieldFunctionObjects.so");
|
|
...
|
|
fields
|
|
(
|
|
R
|
|
devRhoReff
|
|
);
|
|
}
|
|
\endverbatim
|
|
|
|
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
|
|
\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)
|
|
mut | turbulence viscosity (compressible)
|
|
muEff | effective turbulence viscosity (compressible)
|
|
alphat | turbulence thermal diffusivity (compressible)
|
|
alphaEff | effective turbulence thermal diffusivity (compressible)
|
|
R | Reynolds stress tensor
|
|
devReff | Deviatoric part of the effective Reynolds stress
|
|
devRhoReff | Divergence of the Reynolds stress
|
|
\endplaintable
|
|
|
|
See also
|
|
Foam::functionObjects::fvMeshFunctionObject
|
|
Foam::functionObjects::timeControl
|
|
|
|
SourceFiles
|
|
turbulenceFields.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_turbulenceFields_H
|
|
#define functionObjects_turbulenceFields_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,
|
|
mut,
|
|
muEff,
|
|
alphat,
|
|
alphaEff,
|
|
R,
|
|
devRhoReff
|
|
};
|
|
static const NamedEnum<compressibleField, 9> compressibleFieldNames_;
|
|
|
|
enum class incompressibleField
|
|
{
|
|
k,
|
|
epsilon,
|
|
omega,
|
|
nut,
|
|
nuEff,
|
|
R,
|
|
devReff
|
|
};
|
|
static const NamedEnum<incompressibleField, 7> incompressibleFieldNames_;
|
|
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Fields to load
|
|
wordHashSet fieldSet_;
|
|
|
|
//- Optional field prefix to avoid name clashes
|
|
// Defaults to null
|
|
word prefix_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
static const word& modelName();
|
|
|
|
//- Process the turbulence field
|
|
template<class Type>
|
|
void processField
|
|
(
|
|
const word& fieldName,
|
|
const tmp<GeometricField<Type, fvPatchField, volMesh>>& tvalue
|
|
);
|
|
|
|
//- Return omega calculated from k and epsilon
|
|
template<class Model>
|
|
tmp<volScalarField> omega(const Model& model) const;
|
|
|
|
|
|
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&);
|
|
|
|
//- Calculate turbulence fields
|
|
virtual bool execute();
|
|
|
|
//- Do nothing.
|
|
// The turbulence fields are registered and written automatically
|
|
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
|
|
|
|
// ************************************************************************* //
|