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/IO/partialWrite/partialWrite.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::partialWrite Foam::partialWrite
\ingroup grpIOFunctionObjects Group
grpIOFunctionObjects
Description Description
Allows some fields/registered objects to be written more often than others. Allows some fields/registered objects to be written more often than others.

3
src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::removeRegisteredObject Foam::removeRegisteredObject
\ingroup grpIOFunctionObjects Group
grpIOFunctionObjects
Description Description
Removes registered IO objects if present in the database Removes registered IO objects if present in the database

3
src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::writeRegisteredObject Foam::writeRegisteredObject
\ingroup grpIOFunctionObjects Group
grpIOFunctionObjects
Description Description
Takes over the writing of registered IO objects Takes over the writing of registered IO objects

3
src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::cloudInfo Foam::cloudInfo
\ingroup grpCloudFunctionObjects Group
grpCloudFunctionObjects
Description Description
This function object outputs lagrangian cloud information to a file. The This function object outputs lagrangian cloud information to a file. The

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

@ -24,7 +24,8 @@ License
Class Class
Foam::fieldAverage Foam::fieldAverage
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Calculates the field averages given list of fieldAverageItems, e.g. 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 class
Foam::fieldCoordinateSystemTransform Foam::fieldCoordinateSystemTransform
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Transforms fields from global cartesian co-ordinates to local co-ordinate 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 Class
Foam::fieldMinMax Foam::fieldMinMax
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Calculates scalar minimim and maximum field values. Calculates scalar minimim and maximum field values.

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

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

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

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

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

@ -24,7 +24,8 @@ License
Class Class
Foam::processorField Foam::processorField
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Writes a scalar field whose value is the local processor ID. Output 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 Class
Foam::readFields Foam::readFields
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Reads fields from the time folders and adds them to the mesh database 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 Class
Foam::regionSizeDistribution Foam::regionSizeDistribution
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Looks up a field, interpolates it to the faces and determines a connected 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 Class
Foam::streamLine Foam::streamLine
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Generation of streamlines. Samples along track of passive particle. 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 Class
Foam::surfaceInterpolateFields Foam::surfaceInterpolateFields
\ingroup grpFieldFunctionObjects Group grpFieldFunctionObjects
Description Description
Linear interpolates volFields to surfaceFields Linear interpolates volFields to surfaceFields

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

@ -24,7 +24,8 @@ License
Class Class
Foam::turbulenceFields Foam::turbulenceFields
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Stores turbulence fields on the mesh database for further manipulation. 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 Class
Foam::wallBoundedStreamLine Foam::wallBoundedStreamLine
\ingroup grpFieldFunctionObjects Group
grpFieldFunctionObjects
Description Description
Generation of streamlines. Samples along track of passive particle. Generation of streamlines. Samples along track of passive particle.

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

@ -24,7 +24,8 @@ License
Class Class
Foam::forceCoeffs Foam::forceCoeffs
\ingroup grpForcesFunctionObjects Group
grpForcesFunctionObjects
Description Description
Derived from the forces function object, creates a specialisation to Derived from the forces function object, creates a specialisation to

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

@ -24,7 +24,8 @@ License
Class Class
Foam::forces Foam::forces
\ingroup grpForcesFunctionObjects Group
grpForcesFunctionObjects
Description Description
Calculates the forces and moments by integrating the pressure and Calculates the forces and moments by integrating the pressure and

3
src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::abortCalculation Foam::abortCalculation
\ingroup grpJobControlFunctionObjects Group
grpJobControlFunctionObjects
Description Description
Watches for presence of the named file in the $FOAM_CASE directory Watches for presence of the named file in the $FOAM_CASE directory

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

@ -24,7 +24,8 @@ License
Class Class
Foam::systemCall Foam::systemCall
\ingroup grpFunctionObjects Group
grpFunctionObjects
Description Description
Executes system calls, entered in the form of a string list Executes system calls, entered in the form of a string list

3
src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::codedFunctionObject Foam::codedFunctionObject
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
functionObject using dynamic code compilation. functionObject using dynamic code compilation.

3
src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::dsmcFields Foam::dsmcFields
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Calculate intensive fields: Calculate intensive fields:

18
src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H
View File

@ -24,18 +24,28 @@ License
Class Class
Foam::pressureCoefficient Foam::pressureCoefficient
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Calculates pressure coefficient, \f$c_p\f$ Calculates pressure coefficient, \f$c_p\f$
\f[ \f[
c_p = p/p_{dyn,inf} c_p = \frac{p}{p_{dyn,inf}}
\f]
where:
\f[
p_{dyn,inf} = 0.5 \rho |U_{inf}|^2
\f] \f]
where: where
\vartable
c_p | pressure coefficient
p | pressure [bar]
\rho | density [kg/m3]
U | velocity [m/s]
\endvartable
p_dyn,inf = 0.5*rho*mag(U_inf)^2
SourceFiles SourceFiles
pressureCoefficient.C pressureCoefficient.C

3
src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::staticPressure Foam::staticPressure
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Converts kinematic pressure to static pressure, from the name of the Converts kinematic pressure to static pressure, from the name of the

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

@ -24,7 +24,8 @@ License
Class Class
Foam::timeActivatedFileUpdate Foam::timeActivatedFileUpdate
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Performs a file copy/replacement once a specified time has been reached. Performs a file copy/replacement once a specified time has been reached.

3
src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::yPlusLES Foam::yPlusLES
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Evaluates and outputs turbulence y+ for LES models. Values written to Evaluates and outputs turbulence y+ for LES models. Values written to

3
src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H
View File

@ -24,7 +24,8 @@ License
Class Class
Foam::yPlusRAS Foam::yPlusRAS
\ingroup grpUtilitiesFunctionObjects Group
grpUtilitiesFunctionObjects
Description Description
Evaluates and outputs turbulence y+ for RAS models. Values written to Evaluates and outputs turbulence y+ for RAS models. Values written to

7
src/sampling/probes/probes.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class Class
Foam::probes Foam::probes
Group
grpFunctionObjects
Description Description
Set of locations to sample. Set of locations to sample.
@ -34,7 +34,6 @@ Description
SourceFiles SourceFiles
probes.C probes.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

7
src/sampling/sampledSet/sampledSet/sampledSet.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class Class
Foam::sampledSet Foam::sampledSet
Group
grpFunctionObjects
Description Description
Holds list of sampling points which is filled at construction time. Holds list of sampling points which is filled at construction time.
Various implementations of this base class to e.g. get sampling points Various implementations of this base class to e.g. get sampling points
@ -38,7 +38,6 @@ Description
SourceFiles SourceFiles
sampledSet.C sampledSet.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

7
src/sampling/sampledSurface/sampledSurface/sampledSurface.H
View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class Class
Foam::sampledSurface Foam::sampledSurface
Group
grpFunctionObjects
Description Description
An abstract class for surfaces with sampling. An abstract class for surfaces with sampling.
@ -46,7 +46,6 @@ Description
SourceFiles SourceFiles
sampledSurface.C sampledSurface.C
sampledSurfaceTemplates.C sampledSurfaceTemplates.C
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/