Skip to content
Snippets Groups Projects
Commit cbb1ff86 authored by Andrew Heather's avatar Andrew Heather
Browse files

STYLE: residuals function object - added header documentation

parent 8608834d
Branches
Tags
No related merge requests found
......@@ -42,9 +42,17 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: residua ls | yes |
fields | List of fields to process | yes |
writeFields | Write the residual fields | no | no
\endtable
Output data is written to the dir postProcessing/residuals/\<timeDir\>/
For vector/tensor fields, e.g. U, where an equation is solved for each
component, the largest residual of each component is written out.
component, the largest residual of each component is written.
See also
Foam::functionObject
......
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