From fb0b7644660749e6bc0f33b1817aca18a5ef1ac5 Mon Sep 17 00:00:00 2001 From: Andrew Heather Date: Thu, 20 Oct 2016 11:08:50 +0100 Subject: [PATCH] STYLE: Documentation updates --- src/functionObjects/field/CourantNo/CourantNo.H | 4 ++-- .../field/DESModelRegions/DESModelRegions.H | 1 + src/functionObjects/field/PecletNo/PecletNo.H | 2 +- src/functionObjects/field/Q/Q.H | 2 +- .../field/XiReactionRate/XiReactionRate.H | 3 ++- .../field/blendingFactor/blendingFactor.H | 3 ++- src/functionObjects/field/ddt2/ddt2.H | 3 ++- .../field/externalCoupled/externalCoupled.H | 2 ++ src/functionObjects/field/fieldAverage/fieldAverage.H | 4 ++-- .../fieldCoordinateSystemTransform.H | 3 ++- src/functionObjects/field/fieldMinMax/fieldMinMax.H | 3 ++- .../fieldValues/fieldValueDelta/fieldValueDelta.H | 3 ++- .../fieldValues/surfaceFieldValue/surfaceFieldValue.H | 3 ++- .../field/fieldValues/volFieldValue/volFieldValue.H | 3 ++- src/functionObjects/field/fluxSummary/fluxSummary.H | 1 + src/functionObjects/field/histogram/histogram.H | 3 ++- src/functionObjects/field/mapFields/mapFields.H | 1 + .../field/nearWallFields/nearWallFields.H | 3 ++- src/functionObjects/field/pressure/pressure.H | 3 ++- .../field/processorField/processorField.H | 3 ++- src/functionObjects/field/readFields/readFields.H | 3 ++- .../regionSizeDistribution/regionSizeDistribution.H | 5 ++--- src/functionObjects/field/streamLine/streamLine.H | 3 ++- .../field/surfaceInterpolate/surfaceInterpolate.H | 3 ++- .../field/turbulenceFields/turbulenceFields.H | 3 ++- src/functionObjects/field/valueAverage/valueAverage.H | 1 + src/functionObjects/field/vorticity/vorticity.H | 1 + .../wallBoundedStreamLine/wallBoundedStreamLine.H | 3 ++- src/functionObjects/field/wallHeatFlux/wallHeatFlux.H | 3 ++- .../field/wallShearStress/wallShearStress.H | 3 ++- .../field/writeCellCentres/writeCellCentres.H | 3 ++- .../field/writeCellVolumes/writeCellVolumes.H | 3 ++- src/functionObjects/field/yPlus/yPlus.H | 2 +- src/functionObjects/field/zeroGradient/zeroGradient.H | 3 ++- src/functionObjects/forces/forceCoeffs/forceCoeffs.H | 3 ++- src/functionObjects/forces/forces/forces.H | 3 ++- src/functionObjects/lagrangian/cloudInfo/cloudInfo.H | 6 +++--- .../lagrangian/dsmcFields/dsmcFields.H | 6 +++--- .../icoUncoupledKinematicCloud.H | 3 ++- .../solvers/scalarTransport/scalarTransport.H | 4 ++-- .../codedFunctionObject/codedFunctionObject.H | 1 + .../removeRegisteredObject/removeRegisteredObject.H | 3 ++- src/functionObjects/utilities/residuals/residuals.H | 11 ++++------- .../utilities/setTimeStep/setTimeStepFunctionObject.H | 4 ++-- src/functionObjects/utilities/systemCall/systemCall.H | 3 ++- .../utilities/thermoCoupleProbes/thermoCoupleProbes.H | 7 ++++--- .../timeActivatedFileUpdate/timeActivatedFileUpdate.H | 3 ++- .../utilities/writeObjects/writeObjects.H | 3 ++- 48 files changed, 93 insertions(+), 59 deletions(-) diff --git a/src/functionObjects/field/CourantNo/CourantNo.H b/src/functionObjects/field/CourantNo/CourantNo.H index a6e030fa91..26c467525e 100644 --- a/src/functionObjects/field/CourantNo/CourantNo.H +++ b/src/functionObjects/field/CourantNo/CourantNo.H @@ -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 | diff --git a/src/functionObjects/field/DESModelRegions/DESModelRegions.H b/src/functionObjects/field/DESModelRegions/DESModelRegions.H index aeb6a5d3ed..c715d3710f 100644 --- a/src/functionObjects/field/DESModelRegions/DESModelRegions.H +++ b/src/functionObjects/field/DESModelRegions/DESModelRegions.H @@ -47,6 +47,7 @@ Usage } \endverbatim + Where the entries comprise: \table Property | Description | Required | Default value type | type name: DESModelRegions| yes | diff --git a/src/functionObjects/field/PecletNo/PecletNo.H b/src/functionObjects/field/PecletNo/PecletNo.H index 4b66202abf..7e474ad07a 100644 --- a/src/functionObjects/field/PecletNo/PecletNo.H +++ b/src/functionObjects/field/PecletNo/PecletNo.H @@ -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 | diff --git a/src/functionObjects/field/Q/Q.H b/src/functionObjects/field/Q/Q.H index a40e71f758..ca753f641d 100644 --- a/src/functionObjects/field/Q/Q.H +++ b/src/functionObjects/field/Q/Q.H @@ -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 | diff --git a/src/functionObjects/field/XiReactionRate/XiReactionRate.H b/src/functionObjects/field/XiReactionRate/XiReactionRate.H index 0d25ed3be7..7e2fb564c6 100644 --- a/src/functionObjects/field/XiReactionRate/XiReactionRate.H +++ b/src/functionObjects/field/XiReactionRate/XiReactionRate.H @@ -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 | diff --git a/src/functionObjects/field/blendingFactor/blendingFactor.H b/src/functionObjects/field/blendingFactor/blendingFactor.H index 14438ed430..05d7a5a77d 100644 --- a/src/functionObjects/field/blendingFactor/blendingFactor.H +++ b/src/functionObjects/field/blendingFactor/blendingFactor.H @@ -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 | diff --git a/src/functionObjects/field/ddt2/ddt2.H b/src/functionObjects/field/ddt2/ddt2.H index ab790ecf08..4cf62c3add 100644 --- a/src/functionObjects/field/ddt2/ddt2.H +++ b/src/functionObjects/field/ddt2/ddt2.H @@ -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 | diff --git a/src/functionObjects/field/externalCoupled/externalCoupled.H b/src/functionObjects/field/externalCoupled/externalCoupled.H index 8032711add..0fc912f09b 100644 --- a/src/functionObjects/field/externalCoupled/externalCoupled.H +++ b/src/functionObjects/field/externalCoupled/externalCoupled.H @@ -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) diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index 7e292c79c3..0fd49c9bd6 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -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 | diff --git a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index e7c8a4d88d..f08a245925 100644 --- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -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 | diff --git a/src/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/functionObjects/field/fieldMinMax/fieldMinMax.H index eb65e22da5..5196740be8 100644 --- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -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 | diff --git a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H index 97bc937784..82ff99acfb 100644 --- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H +++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H @@ -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 | diff --git a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H index c17e6513fe..b34a9b6544 100644 --- a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H +++ b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H @@ -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 | diff --git a/src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H b/src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H index adb7d4dcd9..531ac71483 100644 --- a/src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H +++ b/src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H @@ -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 | diff --git a/src/functionObjects/field/fluxSummary/fluxSummary.H b/src/functionObjects/field/fluxSummary/fluxSummary.H index 0300b65c9f..9da37cb17a 100644 --- a/src/functionObjects/field/fluxSummary/fluxSummary.H +++ b/src/functionObjects/field/fluxSummary/fluxSummary.H @@ -54,6 +54,7 @@ Usage } \endverbatim + Where the entries comprise: \table Property | Description | Required | Default value type | type name: fluxSummary | yes | diff --git a/src/functionObjects/field/histogram/histogram.H b/src/functionObjects/field/histogram/histogram.H index 0cd803c668..4dd2982a48 100644 --- a/src/functionObjects/field/histogram/histogram.H +++ b/src/functionObjects/field/histogram/histogram.H @@ -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 | diff --git a/src/functionObjects/field/mapFields/mapFields.H b/src/functionObjects/field/mapFields/mapFields.H index 3a68fa3789..299a6f5165 100644 --- a/src/functionObjects/field/mapFields/mapFields.H +++ b/src/functionObjects/field/mapFields/mapFields.H @@ -46,6 +46,7 @@ Usage fields ("U.*" p); } + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: mapFields | yes | diff --git a/src/functionObjects/field/nearWallFields/nearWallFields.H b/src/functionObjects/field/nearWallFields/nearWallFields.H index 9c2e468c3a..9a2850c20a 100644 --- a/src/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/functionObjects/field/nearWallFields/nearWallFields.H @@ -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 | diff --git a/src/functionObjects/field/pressure/pressure.H b/src/functionObjects/field/pressure/pressure.H index 7b0023339b..a3978f1f5d 100644 --- a/src/functionObjects/field/pressure/pressure.H +++ b/src/functionObjects/field/pressure/pressure.H @@ -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 | diff --git a/src/functionObjects/field/processorField/processorField.H b/src/functionObjects/field/processorField/processorField.H index 411a773c02..807d8f14c8 100644 --- a/src/functionObjects/field/processorField/processorField.H +++ b/src/functionObjects/field/processorField/processorField.H @@ -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 | diff --git a/src/functionObjects/field/readFields/readFields.H b/src/functionObjects/field/readFields/readFields.H index f0146557d4..f026063e9f 100644 --- a/src/functionObjects/field/readFields/readFields.H +++ b/src/functionObjects/field/readFields/readFields.H @@ -31,6 +31,7 @@ Description Reads fields from the time directories and adds them to the mesh database for further post-processing. +Usage Example of function object specification: \verbatim readFields1 @@ -42,7 +43,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: readFields | yes | diff --git a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index f82320a103..46b84fd38b 100644 --- a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -35,8 +35,6 @@ Description based on where the field is below the threshold value. These regions ("droplets") can now be analysed. - - Regions: - print the regions connected to a user-defined set of patches. (in spray calculation these form the liquid core) @@ -59,6 +57,7 @@ Description downstream of the injector determined by origin, direction and maxDiameter up to maxDownstream +Usage Example of function object specification: \verbatim regionSizeDistribution1 @@ -102,7 +101,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: regionSizeDistribution |yes| diff --git a/src/functionObjects/field/streamLine/streamLine.H b/src/functionObjects/field/streamLine/streamLine.H index 65885527fe..1787795b27 100644 --- a/src/functionObjects/field/streamLine/streamLine.H +++ b/src/functionObjects/field/streamLine/streamLine.H @@ -31,6 +31,7 @@ Description Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field. +Usage Example of function object specification: \verbatim streamLine1 @@ -64,7 +65,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: streamLine | yes | diff --git a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H index f30f0d2f99..136c6e39d6 100644 --- a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H +++ b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H @@ -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 surfaceInterpolate1 @@ -49,7 +50,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: nearWallFields | yes | diff --git a/src/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/functionObjects/field/turbulenceFields/turbulenceFields.H index fca6bea2ad..5798fc3f75 100644 --- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -37,6 +37,7 @@ Description turbulenceModel:R \endverbatim +Usage Example of function object specification: \verbatim turbulenceFields1 @@ -52,7 +53,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: turbulenceFields | yes | diff --git a/src/functionObjects/field/valueAverage/valueAverage.H b/src/functionObjects/field/valueAverage/valueAverage.H index ff797caca7..ecb9ebe5f2 100644 --- a/src/functionObjects/field/valueAverage/valueAverage.H +++ b/src/functionObjects/field/valueAverage/valueAverage.H @@ -47,6 +47,7 @@ Usage } \endverbatim + Where the entries comprise: \table Property | Description | Required | Default value type | type name: valueAverage | yes | diff --git a/src/functionObjects/field/vorticity/vorticity.H b/src/functionObjects/field/vorticity/vorticity.H index e78f72676b..dca18276f5 100644 --- a/src/functionObjects/field/vorticity/vorticity.H +++ b/src/functionObjects/field/vorticity/vorticity.H @@ -43,6 +43,7 @@ Usage } \endverbatim + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: vorticity | yes | diff --git a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index f2139ba5fa..e8609eb77d 100644 --- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -32,6 +32,7 @@ Description particle track, transported by a user-specified velocity field, constrained to a patch. +Usage Example of function object specification: \verbatim wallBoundedStreamLine1 @@ -67,7 +68,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: wallBoundedStreamLine| yes | diff --git a/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H b/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H index 7e621b7bb0..58d9c3a679 100644 --- a/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H +++ b/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H @@ -34,6 +34,7 @@ Description All wall patches are included by default; to restrict the calculation to certain patches, use the optional 'patches' entry. +Usage Example of function object specification: \verbatim wallHeatFlux1 @@ -45,7 +46,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: wallHeatFlux | yes | diff --git a/src/functionObjects/field/wallShearStress/wallShearStress.H b/src/functionObjects/field/wallShearStress/wallShearStress.H index 162882754a..5c513887be 100644 --- a/src/functionObjects/field/wallShearStress/wallShearStress.H +++ b/src/functionObjects/field/wallShearStress/wallShearStress.H @@ -45,6 +45,7 @@ Description model. All wall patches are included by default; to restrict the calculation to certain patches, use the optional 'patches' entry. +Usage Example of function object specification: \verbatim wallShearStress1 @@ -56,7 +57,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: wallShearStress | yes | diff --git a/src/functionObjects/field/writeCellCentres/writeCellCentres.H b/src/functionObjects/field/writeCellCentres/writeCellCentres.H index 42ee31f1a4..2c3aca1b18 100644 --- a/src/functionObjects/field/writeCellCentres/writeCellCentres.H +++ b/src/functionObjects/field/writeCellCentres/writeCellCentres.H @@ -31,6 +31,7 @@ Description Writes the cell-centres volVectorField and the three component fields as volScalarFields. +Usage Example of function object specification: \verbatim writeCellCentres @@ -41,7 +42,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: writeCellCentres | yes | diff --git a/src/functionObjects/field/writeCellVolumes/writeCellVolumes.H b/src/functionObjects/field/writeCellVolumes/writeCellVolumes.H index 56bc4ffe22..d1db19be84 100644 --- a/src/functionObjects/field/writeCellVolumes/writeCellVolumes.H +++ b/src/functionObjects/field/writeCellVolumes/writeCellVolumes.H @@ -30,6 +30,7 @@ Group Description Writes the cell-volumes volScalarField. +Usage Example of function object specification: \verbatim writeCellVolumes @@ -40,7 +41,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: writeCellVolumes | yes | diff --git a/src/functionObjects/field/yPlus/yPlus.H b/src/functionObjects/field/yPlus/yPlus.H index 8f119bb61a..7dcd641028 100644 --- a/src/functionObjects/field/yPlus/yPlus.H +++ b/src/functionObjects/field/yPlus/yPlus.H @@ -44,7 +44,7 @@ Usage } \endverbatim - + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: yPlus | yes | diff --git a/src/functionObjects/field/zeroGradient/zeroGradient.H b/src/functionObjects/field/zeroGradient/zeroGradient.H index 4cf6298aa2..2651761a57 100644 --- a/src/functionObjects/field/zeroGradient/zeroGradient.H +++ b/src/functionObjects/field/zeroGradient/zeroGradient.H @@ -34,6 +34,7 @@ Description The result can be used, for example, to post-process near-wall field values. +Usage Example of function object specification: \verbatim zeroGrad @@ -46,7 +47,7 @@ Description } \endverbatim - \heading Function object usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: zeroGradient | yes | diff --git a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H index 451e5848aa..78fa3a68e1 100644 --- a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -45,6 +45,7 @@ Description - CdBin.dat : drag coefficient bins - ClBin.dat : lift coefficient bins +Usage Example of function object specification: \verbatim forceCoeffs1 @@ -71,7 +72,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: forces | yes | diff --git a/src/functionObjects/forces/forces/forces.H b/src/functionObjects/forces/forces/forces.H index 0bc8ab3954..41d4aa6b6f 100644 --- a/src/functionObjects/forces/forces/forces.H +++ b/src/functionObjects/forces/forces/forces.H @@ -48,6 +48,7 @@ Description - localForceBin.dat : force bins in local co-ordinate system - localMomentBin.dat : moment bins in local co-ordinate system +Usage Example of function object specification: \verbatim forces1 @@ -68,7 +69,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: forces | yes | diff --git a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H index 23fea3854e..8660d7d708 100644 --- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H +++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H @@ -34,12 +34,13 @@ Description - total current number of parcels - total current mass of parcels +Usage Example of function object specification: \verbatim cloudInfo1 { type cloudInfo; - libs ("libcloudFunctionObjects.so"); + libs ("liblagrangianFunctionObjects.so"); ... clouds ( @@ -49,8 +50,7 @@ Description } \endverbatim - -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: cloudInfo | yes | diff --git a/src/functionObjects/lagrangian/dsmcFields/dsmcFields.H b/src/functionObjects/lagrangian/dsmcFields/dsmcFields.H index 396c843164..4a2a676e6a 100644 --- a/src/functionObjects/lagrangian/dsmcFields/dsmcFields.H +++ b/src/functionObjects/lagrangian/dsmcFields/dsmcFields.H @@ -35,18 +35,18 @@ Description - overallT from averaged extensive fields from a DSMC calculation. - +Usage Example of function object specification to calculate DSMC fields: \verbatim dsmcFields1 { type dsmcFields; - libs ("libutilityFunctionObjects.so"); + libs ("liblagrangianFunctionObjects.so"); ... } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: dsmcFields | yes | diff --git a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H index 5f94116d1c..16becbb9f0 100644 --- a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H +++ b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H @@ -43,6 +43,7 @@ Description The kinematicCloud properties are read from the constant/kinematicCloudProperties dictionary in the usual manner. +Usage Example of function object specification: \verbatim tracks @@ -52,7 +53,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: icoUncoupledKinematicCloud | yes | diff --git a/src/functionObjects/solvers/scalarTransport/scalarTransport.H b/src/functionObjects/solvers/scalarTransport/scalarTransport.H index e6020af39c..5cb15d3d39 100644 --- a/src/functionObjects/solvers/scalarTransport/scalarTransport.H +++ b/src/functionObjects/solvers/scalarTransport/scalarTransport.H @@ -36,7 +36,7 @@ Description - The diffusivity can be set manually using the 'D' entry, or retrieved from the turbulence model (if applicable). - +Usage Example of function object specification to solve a scalar transport equation: \verbatim @@ -55,7 +55,7 @@ Description } \endverbatim - \heading Function object usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: scalarTransport | yes | diff --git a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 3360fc11cb..cb8b76feb0 100644 --- a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -41,6 +41,7 @@ Description codeWrite : c++; upon functionObject::write() codeEnd : c++; upon functionObject::end(); +Usage Example of function object specification: \verbatim difference diff --git a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H index ce36d0f066..9a4024e3fd 100644 --- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H +++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H @@ -30,6 +30,7 @@ Group Description Removes registered objects if present in the database. +Usage Example of function object specification: \verbatim removeRegisteredObject1 @@ -41,7 +42,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: removeRegisteredObject | yes | diff --git a/src/functionObjects/utilities/residuals/residuals.H b/src/functionObjects/utilities/residuals/residuals.H index be5e9275e8..f249f830f9 100644 --- a/src/functionObjects/utilities/residuals/residuals.H +++ b/src/functionObjects/utilities/residuals/residuals.H @@ -30,18 +30,15 @@ Group Description Writes out the initial residual for specified fields. +Usage Example of function object specification: \verbatim residuals { type residuals; - writeControl timeStep; - writeInterval 1; - fields - ( - U - p - ); + libs ("libutilityFunctionObjects.so"); + ... + fields (U p); } \endverbatim diff --git a/src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H b/src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H index d3ce16442c..149023c90c 100644 --- a/src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H +++ b/src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H @@ -34,7 +34,7 @@ Description functionObjects. Supports 'enabled' flag but none of the other options 'timeStart', 'timeEnd', 'writeControl' etc. - +Usage Example of function object specification to manipulate the time step: \verbatim setTimeStep1 @@ -45,7 +45,7 @@ Description } \endverbatim - \heading Function object usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: setTimeStep | yes | diff --git a/src/functionObjects/utilities/systemCall/systemCall.H b/src/functionObjects/utilities/systemCall/systemCall.H index 556c2c2c8c..a83848f211 100644 --- a/src/functionObjects/utilities/systemCall/systemCall.H +++ b/src/functionObjects/utilities/systemCall/systemCall.H @@ -35,6 +35,7 @@ Description - every output time - end of the calculation +Usage Example of function object specification: \verbatim systemCall1 @@ -59,7 +60,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: systemCall | yes | diff --git a/src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H b/src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H index b56ccdc62f..e237014402 100644 --- a/src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H +++ b/src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H @@ -36,11 +36,15 @@ Description Nu = 2.0 + \left(0.4 Re^{0.5} + 0.06 Re^{2/3}\right)*Pr^{0.4} \f] +Usage Example of function object specification: \verbatim probes { type thermoCoupleProbes; + libs ("libutilityFunctionObjects.so"); + writeControl timeStep; + writeInterval 1; solver rodas23; absTol 1e-12; @@ -56,9 +60,6 @@ Description radiationField G; - libs ("libutilityFunctionObjects.so"); - writeControl timeStep; - writeInterval 1; probeLocations ( (0.5 0.5 0.5) diff --git a/src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index 5750f33b85..74194e322c 100644 --- a/src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -30,6 +30,7 @@ Group Description Performs a file copy/replacement once a specified time has been reached. +Usage Example usage to update the fvSolution dictionary at various times throughout the calculation: \verbatim @@ -51,7 +52,7 @@ Description } \endverbatim - \heading Function object usage + Where the entries comprise: \table Property | Description | Required | Default value type | Type name: timeActivatedFileUpdate | yes | diff --git a/src/functionObjects/utilities/writeObjects/writeObjects.H b/src/functionObjects/utilities/writeObjects/writeObjects.H index a39190077a..0858772e1f 100644 --- a/src/functionObjects/utilities/writeObjects/writeObjects.H +++ b/src/functionObjects/utilities/writeObjects/writeObjects.H @@ -48,6 +48,7 @@ Description anyWrite | any option of the previous two \endvartable +Usage Example of function object specification: \verbatim writeObjects1 @@ -60,7 +61,7 @@ Description } \endverbatim -Usage + Where the entries comprise: \table Property | Description | Required | Default value type | type name: writeObjects | yes |