Commit 029b1373 authored by Mark Olesen's avatar Mark Olesen
Browse files

DOC: document writeFile updateHeader flag (fixes #1942)

parent ab692caf
......@@ -47,12 +47,19 @@ Usage
where the entries mean:
\table
Property | Description | Type | Req'd | Dflt
writePrecision | Number of decimal points | label | no | \<system dflt\>
writeToFile | Flag to produce text file output | bool | no | true
useUserTime | Flag to use user time, e.g. degrees | bool | no | true
Property | Description | Type | Reqd | Dflt
writePrecision | Number of decimal points | int | no | \<system dflt\>
writeToFile | Produce text file output? | bool | no | true
useUserTime | Use user time (e.g. degrees)? | bool | no | true
updateHeader | Update header on mesh changes? | bool | no | true
\endtable
Note
The file header is normally updated whenver the mesh points or
topology changes. In some cases, the function object is actually
unaffected by these changes.
Use the \c updateHeader flag to override the default behaviour.
See also
- Foam::functionObject
- Foam::functionObjects::logFiles
......
Markdown is supported
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