From d88b95697d2af6fa340bcb78ef7d3f07d395fc7e Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Fri, 17 May 2019 11:46:51 +0100
Subject: [PATCH] STYLE: adjust fluxSummary documentation
---
src/functionObjects/field/fluxSummary/fluxSummary.H | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/functionObjects/field/fluxSummary/fluxSummary.H b/src/functionObjects/field/fluxSummary/fluxSummary.H
index f1e7f81deb7..17788597311 100644
--- a/src/functionObjects/field/fluxSummary/fluxSummary.H
+++ b/src/functionObjects/field/fluxSummary/fluxSummary.H
@@ -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
--
GitLab