research/OpenFOAM-4.x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

functionObjects: Updated documentation

Browse source 
Patch contributed by Bruno Santos
Resolves bug-report http://bugs.openfoam.org/view.php?id=2138
This commit is contained in:
Henry Weller 2016-07-03 23:17:54 +01:00
parent a70846e229
commit da871b3bc5
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
View file

@ -28,16 +28,16 @@ Group
grpUtilitiesFunctionObjects grpUtilitiesFunctionObjects
Description Description
This function object removes registered objects if present in the database Removes registered objects if present in the database.
Example of function object specification: Example of function object specification:
\verbatim \verbatim
removeRegisteredObject1 removeRegisteredObject1
{ {
type removeRegisteredObject; type removeRegisteredObject;
libs ("libutilityFunctionObjects.so"); libs ("libutilityFunctionObjects.so");
... ...
objectNames (obj1 obj2); objects (obj1 obj2);
} }
\endverbatim \endverbatim
@ -45,7 +45,7 @@ Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
type | type name: removeRegisteredObject | yes | type | type name: removeRegisteredObject | yes |
objectNames | objects to remove | yes | objects | objects to remove | yes |
\endtable \endtable
See also See also

8
src/functionObjects/utilities/writeObjects/writeObjects.H
View file

@ -28,8 +28,8 @@ Group
grpUtilitiesFunctionObjects grpUtilitiesFunctionObjects
Description Description
This function object allows specification of different writing frequency Allows specification of different writing frequency of objects registered to
of objects registered to the database. the database.
It has similar functionality as the main time database through the It has similar functionality as the main time database through the
writeControl setting: writeControl setting:
@ -48,7 +48,7 @@ Description
libs ("libutilityFunctionObjects.so"); libs ("libutilityFunctionObjects.so");
exclusiveWriting true; exclusiveWriting true;
... ...
objectNames (obj1 obj2); objects (obj1 obj2);
} }
\endverbatim \endverbatim
@ -56,7 +56,7 @@ Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
type | type name: writeObjects | yes | type | type name: writeObjects | yes |
objectNames | objects to write | yes | objects | objects to write | yes |
exclusiveWriting | Takes over object writing | no | yes exclusiveWriting | Takes over object writing | no | yes
\endtable \endtable