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

ENH: Updated function object documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

24
src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
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