STYLE: Documentation updates

This commit is contained in:
Andrew Heather
2016-10-20 11:08:50 +01:00
parent 95347013a8
commit fb0b764466
48 changed files with 93 additions and 59 deletions

View File

@ -33,6 +33,7 @@ Description
The operation is applied to all results of each fieldValue object.
Accordingly, each object must generate the same number and type of results.
Usage
Example of function object specification:
\verbatim
fieldValueDelta1
@ -52,7 +53,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fieldValueDelta | yes |

View File

@ -37,6 +37,7 @@ Description
For example, to calculate the volumetric or mass flux across a patch,
apply the 'sum' operator to the flux field (typically \c phi)
Usage
Examples of function object specification:
\verbatim
movingWallPatch
@ -74,7 +75,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: surfaceFieldValue | yes |

View File

@ -33,6 +33,7 @@ Description
Given a list of user-specified fields and a 'volRegion', a number of
operations can be performed, such as sums, averages and integrations.
Usage
Example of function object specification:
\verbatim
volFieldValue1
@ -58,7 +59,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: volFieldValue | yes |