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

STYLE: adjust fluxSummary documentation

Browse Source
This commit is contained in:
Mark Olesen
2019-05-17 11:46:51 +01:00
committed by Andrew Heather
parent 722ebdb151
commit d88b95697d
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/functionObjects/field/fluxSummary/fluxSummary.H
View File

@ -64,6 +64,8 @@ Usage
log | Write flux data to standard output | no | yes log | Write flux data to standard output | no | yes
mode | Mode to generate faces to test | yes | mode | Mode to generate faces to test | yes |
scaleFactor | Optional factor to scale result | no | 1 scaleFactor | Optional factor to scale result | no | 1
tolerance | Tolerance for the reference direction | no | 0.8
phi | Surface flux field | no | phi
\endtable \endtable
The mode is one of: The mode is one of:
@ -75,6 +77,9 @@ Usage
Output data is written to files of the form \<timeDir\>/\<faceZoneName\>.dat 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 See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile Foam::functionObjects::writeFile