functionObjects::turbulenceFields: improved documentation of optional prefix entry
See https://bugs.openfoam.org/view.php?id=4108
This commit is contained in:
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration | Website: https://openfoam.org
|
||||
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2013-2024 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -25,29 +25,8 @@ 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
|
||||
"momentumTransportModel:", e.g.:
|
||||
|
||||
\verbatim
|
||||
momentumTransportModel:R
|
||||
\endverbatim
|
||||
|
||||
Example of function object specification:
|
||||
\verbatim
|
||||
turbulenceFields1
|
||||
{
|
||||
type turbulenceFields;
|
||||
libs ("libfieldFunctionObjects.so");
|
||||
...
|
||||
fields
|
||||
(
|
||||
R
|
||||
devTau
|
||||
);
|
||||
}
|
||||
\endverbatim
|
||||
Stores derived turbulence fields on the mesh database for further
|
||||
manipulation.
|
||||
|
||||
Usage
|
||||
\table
|
||||
@ -74,6 +53,27 @@ Usage
|
||||
devTau | Divergence of the Reynolds stress (compressible)
|
||||
\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
|
||||
|
||||
Reference in New Issue
Block a user