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: residuals function object - added header documentation

Browse Source
This commit is contained in:
Andrew Heather
2018-06-20 12:26:49 +01:00
parent 8608834d48
commit cbb1ff8680
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/functionObjects/utilities/residuals/residuals.H
View File

@ -42,9 +42,17 @@ Usage
} }
\endverbatim \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\>/ Output data is written to the dir postProcessing/residuals/\<timeDir\>/
For vector/tensor fields, e.g. U, where an equation is solved for each 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 See also
Foam::functionObject Foam::functionObject