zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Function object documentation updates for evaluateControl

Browse Source
This commit is contained in:
Andrew Heather
2015-10-06 14:53:56 +01:00
parent f9ce017f21
commit e8c239ed2f
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/postProcessing/functionObjects/doc/functionObjects.dox
View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -63,6 +63,8 @@ functions
enabled yes; enabled yes;
timeStart 0; timeStart 0;
timeEnd 10; timeEnd 10;
evaluateControl timeStep;
evaluateInterval 1;
outputControl outputTime; outputControl outputTime;
outputInterval 1; outputInterval 1;
... ...
@ -78,7 +80,9 @@ Where:
region | name of region for multi-region cases | no | region | name of region for multi-region cases | no |
enabled | on/off switch | no | yes enabled | on/off switch | no | yes
timeStart| start time | no | timeStart| start time | no |
timeEnd | end time | no | timeEnd | end time | no |
evaluateControl | when to evaluate: either 'outputTime' or 'timeStep'| no | timeStep
evaluateInterval| steps between evaluation when evaluateControl=timeStep | no | 1
outputControl | when to output: either 'outputTime' or 'timeStep'| no | timeStep outputControl | when to output: either 'outputTime' or 'timeStep'| no | timeStep
outputInterval| steps between output when outputControl=timeStep | no | 1 outputInterval| steps between output when outputControl=timeStep | no | 1
\endtable \endtable
@ -88,7 +92,7 @@ typically used as the name of the output directory for any derived data. The
\c type entry defines the type of function object properties that follow. \c type entry defines the type of function object properties that follow.
Since the function objects are packaged into separate libraries, the user must Since the function objects are packaged into separate libraries, the user must
tell the code where to find the function object implementation, identified tell the code where to find the function object implementation, identified
using the \c libs entry. using the \c functionObjectLibs entry.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/