mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: adjust fluxSummary documentation
This commit is contained in:
committed by
Andrew Heather
parent
722ebdb151
commit
d88b95697d
@ -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
|
||||
|
||||
Reference in New Issue
Block a user