View Issue Details

IDProjectCategoryView StatusLast Update
0002355OpenFOAMPatchpublic2016-11-26 19:57
ReporterwyldckatAssigned Tohenry 
PrioritynormalSeveritytextReproducibilityN/A
Status resolvedResolutionfixed 
Product Version 
Fixed in Version 
Summary0002355: Main function object description is missing "log" and has mislabelled "evaluate"
DescriptionWhile diagnosing issue #2353, I found through http://cpp.openfoam.org/v4/a10921.html#details - that the description in "src/OpenFOAM/db/functionObjects/functionObject/functionObject.H" is referring to "evaluate" instead of "execute" and is missing any description for "log".

Attached are the following files:

 - functionObject.H.patch - to make it a bit easier to inspect the changes online.

 - functionObject.H.4x - to replace the aforementioned file in OpenFOAM 4.x

 - functionObject.H.dev - to replace the aforementioned file in OpenFOAM 4.x


The changes are:

 - Added description for "log" to the main table.
 - Replaced "evaluate" references with "execute", which is the used name for the execute time controls.
 - Now refers to the "execute" and "write" phases, e.g. see row descriptions for each '.*Interval'.
 - In the time controls list, replaced 'writeInterval' with simply 'Interval', given that each has its own name.
 - Added paragraph at the end pointing out the somewhat obvious, namely what each phase is for.
TagsNo tags attached.

Relationships

related to 0002353 closedhenry yplus functionobject does not show the value on screen 

Activities

wyldckat

2016-11-26 18:04

updater  

functionObject.H.patch (2,968 bytes)
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
index cfe7e3a..58c9bbd 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
 
functionObject.H.patch (2,968 bytes)

wyldckat

2016-11-26 18:05

updater  

functionObject.H.4x (8,169 bytes)

wyldckat

2016-11-26 18:05

updater  

functionObject.H.dev (8,172 bytes)

wyldckat

2016-11-26 18:22

updater   ~0007336

Please also take the following typo fix 'minimim' --> 'minimum' along for the ride:

    sed -i -e 's=minimim=minimum=' src/functionObjects/field/fieldMinMax/fieldMinMax.H

works on both 4.x and dev.

henry

2016-11-26 19:57

manager   ~0007340

Resolved in OpenFOAM-4.x by commit fcb789a267fdb5f1426946157fcc4aa428fea408

Resolved in OpenFOAM-dev by commit e402e5d4b27e112c5c8f72b8c089603b07393956

Issue History

Date Modified Username Field Change
2016-11-26 18:04 wyldckat New Issue
2016-11-26 18:04 wyldckat Status new => assigned
2016-11-26 18:04 wyldckat Assigned To => henry
2016-11-26 18:04 wyldckat File Added: functionObject.H.patch
2016-11-26 18:05 wyldckat File Added: functionObject.H.4x
2016-11-26 18:05 wyldckat File Added: functionObject.H.dev
2016-11-26 18:05 wyldckat Relationship added related to 0002353
2016-11-26 18:22 wyldckat Note Added: 0007336
2016-11-26 19:57 henry Status assigned => resolved
2016-11-26 19:57 henry Resolution open => fixed
2016-11-26 19:57 henry Fixed in Version => 4.x
2016-11-26 19:57 henry Note Added: 0007340