Commit d88b9569 authored by Mark OLESEN's avatar Mark OLESEN Committed by Andrew Heather
Browse files

STYLE: adjust fluxSummary documentation

parent 722ebdb1
......@@ -64,6 +64,8 @@ Usage
log | Write flux data to standard output | no | yes
mode | Mode to generate faces to test | yes |
scaleFactor | Optional factor to scale result | no | 1
tolerance | Tolerance for the reference direction | no | 0.8
phi | Surface flux field | no | phi
\endtable
The mode is one of:
......@@ -75,6 +77,9 @@ Usage
Output data is written to files of the form \<timeDir\>/\<faceZoneName\>.dat
Note
For surface and direction, can use phi = 'U' for determining the fluxes.
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment