9140984cf4
Currently these deleted function declarations are still in the private section of the class declarations but will be moved by hand to the public section over time as this is too complex to automate reliably.
154 lines
4.0 KiB
C++
154 lines
4.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::yPlus
|
|
|
|
Description
|
|
Evaluates and outputs turbulence y+ for models. Values written to
|
|
time directories as field 'yPlus'.
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
yPlus1
|
|
{
|
|
type yPlus;
|
|
libs ("libfieldFunctionObjects.so");
|
|
...
|
|
}
|
|
\endverbatim
|
|
|
|
Usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: yPlus | yes |
|
|
\endtable
|
|
|
|
Note
|
|
Writing field 'yPlus' is done by default, but it can be overridden by
|
|
defining an empty \c objects list. For details see writeLocalObjects.
|
|
|
|
See also
|
|
Foam::functionObject
|
|
Foam::functionObjects::fvMeshFunctionObject
|
|
Foam::functionObjects::logFiles
|
|
Foam::functionObjects::writeLocalObjects
|
|
Foam::functionObjects::timeControl
|
|
|
|
SourceFiles
|
|
yPlus.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_yPlus_H
|
|
#define functionObjects_yPlus_H
|
|
|
|
#include "fvMeshFunctionObject.H"
|
|
#include "logFiles.H"
|
|
#include "writeLocalObjects.H"
|
|
#include "volFieldsFwd.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class turbulenceModel;
|
|
|
|
namespace functionObjects
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class yPlus Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class yPlus
|
|
:
|
|
public fvMeshFunctionObject,
|
|
public logFiles,
|
|
public writeLocalObjects
|
|
{
|
|
// Private Member Functions
|
|
|
|
//- File header information
|
|
virtual void writeFileHeader(const label i);
|
|
|
|
//- Calculate y+
|
|
tmp<volScalarField> calcYPlus
|
|
(
|
|
const turbulenceModel& turbModel
|
|
);
|
|
|
|
//- Disallow default bitwise copy construct
|
|
yPlus(const yPlus&) = delete;
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const yPlus&) = delete;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("yPlus");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from Time and dictionary
|
|
yPlus
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~yPlus();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Read the yPlus data
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Calculate the yPlus field
|
|
virtual bool execute();
|
|
|
|
//- Write the yPlus field
|
|
virtual bool write();
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|