ENH: Updated function object documentation

This commit is contained in:
andy
2012-08-13 14:29:42 +01:00
parent 93e7d6e392
commit 536c4aa210
2 changed files with 53 additions and 20 deletions

View File

@ -28,7 +28,7 @@ Group
grpCloudFunctionObjects
Description
This function object outputs lagrangian cloud information to a file. The
This function object outputs Lagrangian cloud information to a file. The
current outputs include:
- total current number of parcels
- total current mass of parcels
@ -37,13 +37,9 @@ Description
\verbatim
cloudInfo1
{
// Type of functionObject
type cloudInfo;
// Where to load it from (if not already in solver)
type cloudInfo;
functionObjectLibs ("libcloudFunctionObjects.so");
// Clouds to process
clouds
(
kinematicCloud1
@ -52,6 +48,21 @@ Description
}
\endverbatim
\heading Function object usage
\table
Property | Description | Required | Default value
type | type name: cloudInfo | yes |
clouds | list of clouds names to process |yes |
\endtable
The output data of each cloud is written to a file named \<cloudName\>.dat
SeeAlso
functionObject.H
OutputFilterFunctionObject.H
SourceFiles
cloudInfo.C
IOcloudInfo.H