ENH: Documentation updates

This commit is contained in:
andy
2013-06-13 12:58:03 +01:00
parent 15994afca1
commit ea94da2168
6 changed files with 26 additions and 27 deletions

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,14 +57,14 @@ functions
{
myFunctionObject // user-defined name of function object entry
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
timeStart 0;
timeEnd 10;
outputControl outputTime;
outputInterval 1;
type functionObjectType;
functionObjectLibs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
timeStart 0;
timeEnd 10;
outputControl outputTime;
outputInterval 1;
...
}
}
@ -74,7 +74,7 @@ Where:
\table
Property | Description | Required | Default value
type | type of function object | yes |
libs | libraries containing object implementation | yes |
functionObjectLibs | libraries containing object implementation | yes |
region | name of region for multi-region cases | no |
enabled | on/off switch | no | yes
timeStart| start time | no |