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

ENH: Updates to function object documentation

Browse Source
This commit is contained in:
andy
2012-07-23 15:23:35 +01:00
parent e6a41726e2
commit a17b0c75c6
30 changed files with 74 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H
View File

@ -24,7 +24,8 @@ License
Class
Foam::fieldAverage
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Calculates the field averages given list of fieldAverageItems, e.g.

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

@ -24,7 +24,8 @@ License
class
Foam::fieldCoordinateSystemTransform
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Transforms fields from global cartesian co-ordinates to local co-ordinate

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

@ -24,7 +24,8 @@ License
Class
Foam::fieldMinMax
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Calculates scalar minimim and maximum field values.

3
src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H
View File

@ -24,7 +24,8 @@ License
Class
Foam::fieldValue
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Base class for field value -based function objects.

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

@ -24,7 +24,8 @@ License
Class
Foam::nearWallFields
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Samples near-patch volFields

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

@ -24,7 +24,8 @@ License
Class
Foam::processorField
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Writes a scalar field whose value is the local processor ID. Output

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

@ -24,7 +24,8 @@ License
Class
Foam::readFields
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Reads fields from the time folders and adds them to the mesh database

3
src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -24,7 +24,8 @@ License
Class
Foam::regionSizeDistribution
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Looks up a field, interpolates it to the faces and determines a connected

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

@ -24,7 +24,8 @@ License
Class
Foam::streamLine
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.

2
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H
View File

@ -24,7 +24,7 @@ License
Class
Foam::surfaceInterpolateFields
\ingroup grpFieldFunctionObjects
Group grpFieldFunctionObjects
Description
Linear interpolates volFields to surfaceFields

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

@ -24,7 +24,8 @@ License
Class
Foam::turbulenceFields
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Stores turbulence fields on the mesh database for further manipulation.

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

@ -24,7 +24,8 @@ License
Class
Foam::wallBoundedStreamLine
\ingroup grpFieldFunctionObjects
Group
grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.