Commit fb0b7644 authored by Andrew Heather's avatar Andrew Heather
Browse files

STYLE: Documentation updates

parent 95347013
......@@ -32,7 +32,7 @@ Description
volScalarField. The field is stored on the mesh database so that it can
be retrieved and used for other applications.
Usage
Usage
Example of function object specification to calculate the Courant number:
\verbatim
CourantNo1
......@@ -43,7 +43,7 @@ Usage
}
\endverbatim
\heading Function object usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: CourantNo | yes |
......
......@@ -47,6 +47,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: DESModelRegions| yes |
......
......@@ -41,7 +41,7 @@ Usage
}
\endverbatim
\heading Function object usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: Peclet | yes |
......
......@@ -51,7 +51,7 @@ Usage
}
\endverbatim
\heading Function object usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: Q | yes |
......
......@@ -31,6 +31,7 @@ Description
Writes the turbulent flame-speed and reaction-rate volScalarFields for the
Xi-based combustion models.
Usage
Example of function object specification:
\verbatim
XiReactionRate
......@@ -41,7 +42,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: XiReactionRate | yes |
......
......@@ -49,6 +49,7 @@ Description
Additional reporting is written to the standard output, providing
statistics as to the number of cells used by each scheme.
Usage
Example of function object specification to calculate the blending factor:
\verbatim
blendingFactor1
......@@ -63,7 +64,7 @@ Description
}
\endverbatim
\heading Function object usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: blendingFactor | yes |
......
......@@ -34,6 +34,7 @@ Description
The result can be used further for determining variance or RMS values
(for example).
Usage
Example of function object specification:
\verbatim
dpdt2
......@@ -46,7 +47,7 @@ Description
}
\endverbatim
\heading Function object usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: ddt2 | yes |
......
......@@ -98,7 +98,9 @@ Usage
\endverbatim
This reads/writes (on the master processor) the directory:
comms/region0_region1/TPatchGroup/
with contents:
patchPoints (collected points)
patchFaces (collected faces)
......
......@@ -64,7 +64,7 @@ Description
periodicRestart option and setting \c restartPeriod to the required
averaging period.
Example of function object specification:
Usage
\verbatim
fieldAverage1
{
......@@ -98,7 +98,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fieldAverage | yes |
......
......@@ -32,6 +32,7 @@ Description
co-ordinates to a local co-ordinate system. The fields are run-time
modifiable.
Usage
Example of function object specification:
\verbatim
fieldCoordinateSystemTransform1
......@@ -56,7 +57,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fieldCoordinateSystemTransform | yes |
......
......@@ -35,6 +35,7 @@ Description
component value or the magnitude is reported. When operating in parallel,
the processor owning the value is also given.
Usage
Example of function object specification:
\verbatim
fieldMinMax1
......@@ -50,7 +51,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fieldMinMax | yes |
......
......@@ -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 |
......
......@@ -54,6 +54,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fluxSummary | yes |
......
......@@ -30,6 +30,7 @@ Group
Description
Write the volume-weighted histogram of a volScalarField.
Usage
Example:
\verbatim
histogram1
......@@ -46,7 +47,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: histogram | yes |
......
......@@ -46,6 +46,7 @@ Usage
fields ("U.*" p);
}
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: mapFields | yes |
......
......@@ -38,6 +38,7 @@ Description
- to calculate a new field as a post-processing step or
- since the fields are registered, used in another functionObject
Usage
Example of function object specification:
\verbatim
nearWallFields1
......@@ -59,7 +60,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: nearWallFields | yes |
......
......@@ -76,6 +76,7 @@ Description
Total pressure coefficient | yes | yes
\endtable
Usage
Example of function object specification to calculate pressure coefficient:
\verbatim
pressure1
......@@ -88,7 +89,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: pressure | yes |
......
......@@ -31,6 +31,7 @@ Description
Writes a scalar field whose value is the local processor ID. The output
field name is 'processorID'.
Usage
Example of function object specification:
\verbatim
processorField1
......@@ -41,7 +42,7 @@ Description
}
\endverbatim
Usage
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: processorField | yes |
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment