ENH: Updated function object documentation

This commit is contained in:
andy
2012-08-20 12:24:40 +01:00
parent 7a6880ad14
commit 77189860de
7 changed files with 136 additions and 14 deletions

View File

@ -28,10 +28,33 @@ Group
grpIOFunctionObjects
Description
Allows some fields/registered objects to be written more often than others.
This function object allows user-selected fields/registered objects to be
written at a custom write interval. It operates by deleting all entries
except those selected after writing.
Works in the opposite way: deletes at intermediate times all
but selected fields.
Example of function object specification:
\verbatim
partialWrite1
{
type partialWrite;
functionObjectLibs ("libIOFunctionObjects.so");
...
objectNames (p U T);
writeInterval 100;
}
\endverbatim
\heading Function object usage
\table
Property | Description | Required | Default value
type | type name: partialWrite | yes |
objectNames | objects to write | yes |
writeInterval | write interval | yes |
\endtable
SeeAlso
Foam::functionObject
Foam::OutputFilterFunctionObject
SourceFiles
partialWrite.C
@ -58,7 +81,7 @@ class dictionary;
class mapPolyMesh;
/*---------------------------------------------------------------------------*\
Class partialWrite Declaration
Class partialWrite Declaration
\*---------------------------------------------------------------------------*/
class partialWrite

View File

@ -28,7 +28,29 @@ Group
grpIOFunctionObjects
Description
Removes registered IO objects if present in the database
This function object removes registered objects if present in the database
Example of function object specification:
\verbatim
removeRegisteredObject1
{
type removeRegisteredObject;
functionObjectLibs ("libIOFunctionObjects.so");
...
objectNames (obj1 obj2);
}
\endverbatim
\heading Function object usage
\table
Property | Description | Required | Default value
type | type name: removeRegisteredObject | yes |
objectNames | objects to remove | yes |
\endtable
SeeAlso
Foam::functionObject
Foam::OutputFilterFunctionObject
SourceFiles
removeRegisteredObject.C

View File

@ -28,7 +28,30 @@ Group
grpIOFunctionObjects
Description
Takes over the writing of registered IO objects
This function object takes-over the writing of objects registered to the
database.
Example of function object specification:
\verbatim
writeRegisteredObject1
{
type writeRegisteredObject;
functionObjectLibs ("libIOFunctionObjects.so");
...
objectNames (obj1 obj2);
}
\endverbatim
\heading Function object usage
\table
Property | Description | Required | Default value
type | type name: writeRegisteredObject | yes |
objectNames | objects to write | yes |
\endtable
SeeAlso
Foam::functionObject
Foam::OutputFilterFunctionObject
SourceFiles
writeRegisteredObject.C