mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: Documentation updates
This commit is contained in:
@ -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 |
|
||||
|
||||
@ -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 |
|
||||
|
||||
@ -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 |
|
||||
|
||||
Reference in New Issue
Block a user