From e402e5d4b27e112c5c8f72b8c089603b07393956 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sat, 26 Nov 2016 18:42:25 +0000
Subject: [PATCH] functionObject.H: Updated documentation
Patch contributed by Bruno Santos
Resolves patch request http://bugs.openfoam.org/view.php?id=2355
---
.../functionObject/functionObject.H | 29 ++++++++++++-------
.../field/fieldMinMax/fieldMinMax.H | 2 +-
2 files changed, 20 insertions(+), 11 deletions(-)
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
index 40a626c30f..4d52ac2186 100644
--- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
+++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
@@ -64,23 +64,24 @@ Description
libs | Libraries containing implementation | yes |
region | Name of region for multi-region cases | no |
enabled | On/off switch | no | yes
+ log | Log information to standard output | no | yes
timeStart| Start time | no |
timeEnd | End time | no |
- evaluateControl | See time controls below | no | timeStep
- evaluateInterval | Steps between output | no |
- writeControl | See time controls below | no | timeStep
- writeInterval | Steps between output | no |
+ executeControl | See time controls below | no | timeStep
+ executeInterval | Steps between each execute phase | no |
+ writeControl | See time controls below | no | timeStep
+ writeInterval | Steps between each write phase | no |
\endtable
Time controls:
\table
Option | Description
- timeStep | Execute/write every 'writeInterval' time-steps
- writeTime | Execute/write every 'writeInterval' output times
- adjustableRunTime | Execute/write every 'writeInterval' run time period
- runTime | Execute/write every 'writeInterval' run time period
- clockTime | Execute/write every 'writeInterval' clock time period
- cpuTime | Execute/write every 'writeInterval' CPU time period
+ timeStep | Execute/write every 'Interval' time-steps
+ writeTime | Execute/write every 'Interval' output times
+ adjustableRunTime | Execute/write every 'Interval' run time period
+ runTime | Execute/write every 'Interval' run time period
+ clockTime | Execute/write every 'Interval' clock time period
+ cpuTime | Execute/write every 'Interval' CPU time period
none | Execute/write every time-step
\endtable
@@ -91,6 +92,14 @@ Description
libraries and the \c libs entry is used to specify which library should be
loaded.
+ Each function object has two separate run phases:
+
+ - The \c execute phase is meant to be used for updating calculations
+ or for management tasks.
+ - The \c write phase is meant for writing the calculated data to disk.
+
+ For each phase the respective time controls are provided, as listed above.
+
Class
Foam::functionObject
diff --git a/src/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/functionObjects/field/fieldMinMax/fieldMinMax.H
index 158656c435..69fc1b214d 100644
--- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H
+++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H
@@ -28,7 +28,7 @@ Group
grpFieldFunctionObjects
Description
- Calculates the value and location of scalar minimim and maximum for a list
+ Calculates the value and location of scalar minimum and maximum for a list
of user-specified fields.
For variables with a rank greater than zero, either the min/max of a
--
GitLab