Doxygen documentation: Standardized the 'See also' heading

2025-12-08 06:57:46 +00:00 · 2016-06-17 17:31:34 +01:00
parent 2ca0a6f362
commit 8a5304edf6
288 changed files with 343 additions and 343 deletions
--- 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.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/Lambda2/Lambda2.H
+++ b/src/functionObjects/field/Lambda2/Lambda2.H
@ -32,7 +32,7 @@ Description
    of the sum of the square of the symmetrical and anti-symmetrical parts of
    the velocity gradient tensor.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/MachNo/MachNo.H
+++ b/src/functionObjects/field/MachNo/MachNo.H
@ -31,7 +31,7 @@ Description
    This function object calculates and writes the Mach number as a
    volScalarField.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/PecletNo/PecletNo.H
+++ b/src/functionObjects/field/PecletNo/PecletNo.H
@ -31,7 +31,7 @@ Description
    This function object calculates and outputs the Peclet number as a
    surfaceScalarField.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/Q/Q.H
+++ b/src/functionObjects/field/Q/Q.H
@ -35,7 +35,7 @@ Description
        Q = 0.5(sqr(tr(\nabla U)) - tr(((\nabla U) \cdot (\nabla U))))
    \f]

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/blendingFactor/blendingFactor.H
+++ b/src/functionObjects/field/blendingFactor/blendingFactor.H
@ -32,7 +32,7 @@ Description
    the bended convection schemes.  The output is a volume field (cells) whose
    value is calculated via the maximum blending factor for any cell face.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/components/components.H
+++ b/src/functionObjects/field/components/components.H
@ -33,7 +33,7 @@ Description
    The operation can be applied to any volume or surface fields generating a
    volume or surface scalar fields for each component.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/div/div.H
+++ b/src/functionObjects/field/div/div.H
@ -32,7 +32,7 @@ Description
    limited to surfaceScalarFields and volVectorFields, and the output is a
    volScalarField.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/enstrophy/enstrophy.H
+++ b/src/functionObjects/field/enstrophy/enstrophy.H
@ -30,7 +30,7 @@ Group
 Description
    This function object calculates the enstrophy of the velocity.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/fieldAverage/fieldAverage.H
+++ b/src/functionObjects/field/fieldAverage/fieldAverage.H
@ -108,7 +108,7 @@ Usage
 Note
    To employ the \c prime2Mean option, the \c mean option must be selecetd.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject
    Foam::functionObject

--- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
+++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
@ -62,7 +62,7 @@ Usage
        coordinateSystem | local co-ordinate system | yes    |
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject
    Foam::coordinateSystem

--- a/src/functionObjects/field/fieldExpression/fieldExpression.H
+++ b/src/functionObjects/field/fieldExpression/fieldExpression.H
@ -29,7 +29,7 @@ Group

 Description

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H
+++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H
@ -65,7 +65,7 @@ Usage

    Output data is written to the file \<timeDir\>/fieldMinMax.dat

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles

--- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
+++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
@ -65,7 +65,7 @@ Usage
       average       | average
    \endplaintable

-SeeAlso
+See also
    Foam::fieldValue

 SourceFiles
--- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
+++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
@ -122,7 +122,7 @@ Note
        - take care when using isoSurfaces - these might have duplicate
          triangles and so integration might be wrong

-SeeAlso
+See also
    Foam::fieldValues
    Foam::functionObject

--- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H
+++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H
@ -90,7 +90,7 @@ Usage
       CoV           | coefficient of variation: standard deviation/mean
    \endplaintable

-SeeAlso
+See also
    Foam::fieldValues
    Foam::functionObject

--- a/src/functionObjects/field/flowType/flowType.H
+++ b/src/functionObjects/field/flowType/flowType.H
@ -41,7 +41,7 @@ Description
         1 = planar extensional flow
    \endverbatim

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/grad/grad.H
+++ b/src/functionObjects/field/grad/grad.H
@ -32,7 +32,7 @@ Description
    limited to scalar and vector volume or surface fields, and the output is a
    volume vector or tensor field.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/histogram/histogram.H
+++ b/src/functionObjects/field/histogram/histogram.H
@ -57,7 +57,7 @@ Usage
        setFormat    | Output format           | yes         |
    \endtable

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFile

--- a/src/functionObjects/field/mag/mag.H
+++ b/src/functionObjects/field/mag/mag.H
@ -33,7 +33,7 @@ Description
    The operation can be applied to any volume or surface fields generating a
    volume or surface scalar field.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/magSqr/magSqr.H
+++ b/src/functionObjects/field/magSqr/magSqr.H
@ -33,7 +33,7 @@ Description
    The operation can be applied to any volume or surface field generating a
    volume or surface scalar field.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/nearWallFields/nearWallFields.H
+++ b/src/functionObjects/field/nearWallFields/nearWallFields.H
@ -60,7 +60,7 @@ Usage
        distance | distance from patch to sample | yes     |
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/pressure/pressure.H
+++ b/src/functionObjects/field/pressure/pressure.H
@ -104,7 +104,7 @@ Usage
        rhoInf       | Freestream density for coefficient calculation  | no |
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/processorField/processorField.H
+++ b/src/functionObjects/field/processorField/processorField.H
@ -47,7 +47,7 @@ Usage
        type         | type name: processorField | yes       |
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/randomise/randomise.H
+++ b/src/functionObjects/field/randomise/randomise.H
@ -33,7 +33,7 @@ Description

    The operation can be applied to any volume field.

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/readFields/readFields.H
+++ b/src/functionObjects/field/readFields/readFields.H
@ -53,7 +53,7 @@ Usage
        fields       | list of fields to read  |  no         |
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
+++ b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
@ -94,7 +94,7 @@ Usage
        coordinateSystem | transformation for vector fields | no         |
    \endtable

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFile

--- a/src/functionObjects/field/streamLine/streamLine.H
+++ b/src/functionObjects/field/streamLine/streamLine.H
@ -87,7 +87,7 @@ Note
    When specifying the track resolution, the \c trackLength OR \c nSubCycle
    option should be used

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::timeControl
    Foam::sampledSet
--- a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
+++ b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
@ -57,7 +57,7 @@ Usage
    \endtable


-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject
    Foam::functionObjects::timeControl

--- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H
+++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H
@ -76,7 +76,7 @@ Usage
        devRhoReff  | Divergence of the Reynolds stress
    \endplaintable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject
    Foam::functionObjects::timeControl

--- a/src/functionObjects/field/vorticity/vorticity.H
+++ b/src/functionObjects/field/vorticity/vorticity.H
@ -30,7 +30,7 @@ Group
 Description
    This function object calculates the vorticity, the curl of the velocity.

-SeeAlso
+See also
    Foam::functionObjects::fieldExpression
    Foam::functionObjects::fvMeshFunctionObject

--- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
+++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
@ -88,7 +88,7 @@ Note
    When specifying the track resolution, the \c trackLength OR \c nSubCycle
    option should be used

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::timeControl
    Foam::sampledSet
--- a/src/functionObjects/field/wallShearStress/wallShearStress.H
+++ b/src/functionObjects/field/wallShearStress/wallShearStress.H
@ -64,7 +64,7 @@ Usage
        patches  | list of patches to process | no         | all wall patches
    \endtable

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles
    Foam::functionObjects::pressureTools
--- a/src/functionObjects/field/yPlus/yPlus.H
+++ b/src/functionObjects/field/yPlus/yPlus.H
@ -31,7 +31,7 @@ Description
    Evaluates and outputs turbulence y+ for  models.  Values written to
    time directories as field 'yPlus'

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles
    Foam::functionObjects::timeControl
--- a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H
+++ b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H
@ -79,7 +79,7 @@ Usage
        cumulative   | bin data accumulated with incresing distance | yes |
    \endtable

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::timeControl
    Foam::functionObjects::forces
--- a/src/functionObjects/forces/forces/forces.H
+++ b/src/functionObjects/forces/forces/forces.H
@ -99,7 +99,7 @@ Note
        }
    \endverbatim

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles
    Foam::functionObjects::timeControl
--- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
+++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
@ -59,7 +59,7 @@ Usage

    The output data of each cloud is written to a file named \<cloudName\>.dat

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles

--- a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
+++ b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
@ -60,7 +60,7 @@ Usage
        kinematicCloud | Name of the kinematicCloud | no        | kinematicCloud
    \endtable

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- 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).

-SeeAlso
+See also
    Foam::functionObjects::fvMeshFunctionObject

 SourceFiles
--- a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
+++ b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
@ -62,7 +62,7 @@ Description
    \endverbatim


-SeeAlso
+See also
    Foam::functionObject
    Foam::codedBase

--- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
+++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
@ -48,7 +48,7 @@ Usage
        objectNames  | objects to remove       | yes         |
    \endtable

-SeeAlso
+See also
    Foam::functionObject

 SourceFiles
--- a/src/functionObjects/utilities/residuals/residuals.H
+++ b/src/functionObjects/utilities/residuals/residuals.H
@ -49,7 +49,7 @@ Description
    For vector/tensor fields, e.g. U, where an equation is solved for each
    component, the largest residual of each component is written out.

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::writeFiles
    Foam::functionObjects::timeControl
--- a/src/functionObjects/utilities/systemCall/systemCall.H
+++ b/src/functionObjects/utilities/systemCall/systemCall.H
@ -74,7 +74,7 @@ Note
    \c allowSystemOperations must be set to '1'; otherwise, system calls will
    not be allowed.

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::timeControl

--- a/src/functionObjects/utilities/writeObjects/writeObjects.H
+++ b/src/functionObjects/utilities/writeObjects/writeObjects.H
@ -63,7 +63,7 @@ Usage
    \c exclusiveWriting disables automatic writing (i.e through database) of the
    objects to avoid duplicate writing.

-SeeAlso
+See also
    Foam::functionObject
    Foam::functionObjects::timeControl