DOC: solverInfo FO: improve header-file documentation

- TUT: solverInfo FO: add an example to pisoFoam/cavity
This commit is contained in:
Kutalmis Bercin
2020-12-17 15:26:23 +00:00
committed by Andrew Heather
parent 02129b0846
commit b4724c37ad
5 changed files with 100 additions and 42 deletions

View File

@ -0,0 +1,42 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v2012 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
solverInfo1
{
// Mandatory entries
type solverInfo;
libs (utilityFunctionObjects);
fields
(
k
epsilon
p
U
)
// Optional entries
writeResidualFields true;
// Optional (inherited) entries
writePrecision 16;
writeToFile true;
useUserTime true;
region region0;
enabled true;
log true;
timeStart 0;
timeEnd 1000;
executeControl timeStep;
executeInterval 1;
writeControl writeTime;
writeInterval -1;
}
// ************************************************************************* //

View File

@ -47,6 +47,7 @@ runTimeModifiable true;
functions
{
// field function objects
#include "FOfieldAverage"
#include "FOadd"
#include "FOblendingFactor"
@ -94,6 +95,9 @@ functions
#include "FOwriteCellVolumes"
#include "FOyPlus"
#include "FOzeroGradient"
// utility function objects
#include "FOsolverInfo"
}