zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: Documentation updates

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

2
src/functionObjects/field/CourantNo/CourantNo.H
View File

@ -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 |

1
src/functionObjects/field/DESModelRegions/DESModelRegions.H
View File

@ -47,6 +47,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: DESModelRegions| yes |

2
src/functionObjects/field/PecletNo/PecletNo.H
View File

@ -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 |

2
src/functionObjects/field/Q/Q.H
View File

@ -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 |

3
src/functionObjects/field/XiReactionRate/XiReactionRate.H
View File

@ -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 |

3
src/functionObjects/field/blendingFactor/blendingFactor.H
View File

@ -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 |

3
src/functionObjects/field/ddt2/ddt2.H
View File

@ -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 |

2
src/functionObjects/field/externalCoupled/externalCoupled.H
View File

@ -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)

4
src/functionObjects/field/fieldAverage/fieldAverage.H
View File

@ -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 |

3
src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
View File

@ -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 |

3
src/functionObjects/field/fieldMinMax/fieldMinMax.H
View File

@ -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 |

3
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
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 |

3
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
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 |

3
src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H
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 |

1
src/functionObjects/field/fluxSummary/fluxSummary.H
View File

@ -54,6 +54,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: fluxSummary | yes |

3
src/functionObjects/field/histogram/histogram.H
View File

@ -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 |

1
src/functionObjects/field/mapFields/mapFields.H
View File

@ -46,6 +46,7 @@ Usage
fields ("U.*" p);
}
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: mapFields | yes |

3
src/functionObjects/field/nearWallFields/nearWallFields.H
View File

@ -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 |

3
src/functionObjects/field/pressure/pressure.H
View File

@ -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 |

3
src/functionObjects/field/processorField/processorField.H
View File

@ -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 |

3
src/functionObjects/field/readFields/readFields.H
View File

@ -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 |

5
src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -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|

3
src/functionObjects/field/streamLine/streamLine.H
View File

@ -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 |

3
src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
View File

@ -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 |

3
src/functionObjects/field/turbulenceFields/turbulenceFields.H
View File

@ -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 |

1
src/functionObjects/field/valueAverage/valueAverage.H
View File

@ -47,6 +47,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: valueAverage | yes |

1
src/functionObjects/field/vorticity/vorticity.H
View File

@ -43,6 +43,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: vorticity | yes |

3
src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
View File

@ -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 |

3
src/functionObjects/field/wallHeatFlux/wallHeatFlux.H
View File

@ -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 |

3
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -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 |

3
src/functionObjects/field/writeCellCentres/writeCellCentres.H
View File

@ -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 |

3
src/functionObjects/field/writeCellVolumes/writeCellVolumes.H
View File

@ -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 |

2
src/functionObjects/field/yPlus/yPlus.H
View File

@ -44,7 +44,7 @@ Usage
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | Type name: yPlus | yes |

3
src/functionObjects/field/zeroGradient/zeroGradient.H
View File

@ -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 |

3
src/functionObjects/forces/forceCoeffs/forceCoeffs.H
View File

@ -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 |

3
src/functionObjects/forces/forces/forces.H
View File

@ -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 |

6
src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
View File

@ -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 |

6
src/functionObjects/lagrangian/dsmcFields/dsmcFields.H
View File

@ -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 |

3
src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
View File

@ -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 |

4
src/functionObjects/solvers/scalarTransport/scalarTransport.H
View File

@ -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 |

1
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -41,6 +41,7 @@ Description
codeWrite : c++; upon functionObject::write()
codeEnd : c++; upon functionObject::end();
Usage
Example of function object specification:
\verbatim
difference

3
src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
View File

@ -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 |

11
src/functionObjects/utilities/residuals/residuals.H
View File

@ -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

4
src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H
View File

@ -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 |

3
src/functionObjects/utilities/systemCall/systemCall.H
View File

@ -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 |

7
src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H
View File

@ -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)

3
src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
View File

@ -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 |

3
src/functionObjects/utilities/writeObjects/writeObjects.H
View File

@ -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 |