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: doxygen documentation updates

Browse Source
This commit is contained in:
andy
2012-07-12 17:12:52 +01:00
parent c40bc965ed
commit a80d4d9b69
152 changed files with 1131 additions and 555 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class
Foam::partialWrite
\ingroup grpIOFunctionObjects
Description
Allows some fields/registered objects to be written more often than others.
@ -36,7 +35,6 @@ Description
SourceFiles
partialWrite.C
IOpartialWrite.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,19 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class
Foam::removeRegisteredObject
\ingroup grpIOFunctionObjects
Description
Removes registered IO objects if present in the database
SourceFiles
removeRegisteredObject.C
IOremoveRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,19 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpIOFunctionObjects
@{
Class
Foam::writeRegisteredObject
\ingroup grpIOFunctionObjects
Description
Takes over the writing of registered IO objects
SourceFiles
writeRegisteredObject.C
IOwriteRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpCloudFunctionObjects
@{
Class
Foam::cloudInfo
\ingroup grpCloudFunctionObjects
Description
This function object outputs lagrangian cloud information to a file. The
current outputs include:
@ -36,7 +35,6 @@ Description
SourceFiles
cloudInfo.C
IOcloudInfo.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::fieldAverage
\ingroup grpFieldFunctionObjects
Description
Calculates the field averages given list of fieldAverageItems, e.g.
@ -83,7 +82,6 @@ Description
SourceFiles
fieldAverage.C
fieldAverageTemplates.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
class
Foam::fieldCoordinateSystemTransform
\ingroup grpFieldFunctionObjects
Description
Transforms fields from global cartesian co-ordinates to local co-ordinate
system
@ -35,7 +34,6 @@ SourceFiles
fieldCoordinateSystemTransform.C
fieldCoordinateSystemTransformTemplates.C
IOfieldCoordinateSystemTransform.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::fieldMinMax
\ingroup grpFieldFunctionObjects
Description
Calculates scalar minimim and maximum field values.
@ -39,7 +38,6 @@ Description
SourceFiles
fieldMinMax.C
IOfieldMinMax.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::fieldValue
\ingroup grpFieldFunctionObjects
Description
Base class for field value -based function objects.
SourceFiles
fieldValue.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::nearWallFields
\ingroup grpFieldFunctionObjects
Description
Samples near-patch volFields
@ -56,7 +55,6 @@ Description
SourceFiles
nearWallFields.C
IOnearWallFields.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::processorField
\ingroup grpFieldFunctionObjects
Description
Writes a scalar field whose value is the local processor ID. Output
field name is processorID.
@ -34,7 +33,6 @@ Description
SourceFiles
processorField.C
IOprocessorField.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::readFields
\ingroup grpFieldFunctionObjects
Description
Reads fields from the time folders and adds them to the mesh database
for further post-processing.
@ -34,7 +33,6 @@ Description
SourceFiles
readFields.C
IOreadFields.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::regionSizeDistribution
\ingroup grpFieldFunctionObjects
Description
Looks up a field, interpolates it to the faces and determines a connected
region from a patch where the field is above a certain value.
@ -36,7 +35,6 @@ Description
SourceFiles
regionSizeDistribution.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::streamLine
\ingroup grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.
SourceFiles
streamLine.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::surfaceInterpolateFields
\ingroup grpFieldFunctionObjects
Description
Linear interpolates volFields to surfaceFields
@ -52,7 +51,6 @@ Description
SourceFiles
surfaceInterpolateFields.C
IOsurfaceInterpolateFields.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::turbulenceFields
\ingroup grpFieldFunctionObjects
Description
Stores turbulence fields on the mesh database for further manipulation.
@ -37,7 +36,6 @@ Description
SourceFiles
turbulenceFields.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFieldFunctionObjects
@{
Class
Foam::wallBoundedStreamLine
\ingroup grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.
SourceFiles
wallBoundedStreamLine.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpForcesFunctionObjects
@{
Class
Foam::forceCoeffs
\ingroup grpForcesFunctionObjects
Description
Derived from the forces function object, creates a specialisation to
calculate lift and drag forces.
@ -34,7 +33,6 @@ Description
SourceFiles
forceCoeffs.C
IOforceCoeffs.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpForcesFunctionObjects
@{
Class
Foam::forces
\ingroup grpForcesFunctionObjects
Description
Calculates the forces and moments by integrating the pressure and
skin-friction forces over a given list of patches.
@ -54,7 +53,6 @@ Note
SourceFiles
forces.C
IOforces.H
@}
\*---------------------------------------------------------------------------*/

69
src/postProcessing/functionObjects/functionObjects.dox Normal file
View File

@ -0,0 +1,69 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pagePostProcessing Post-processing
\section secFunctionObjects Function objects
OpenFOAM includes a variety of \ref grpFunctionObjects that can be applied during
the calculation, or afterwards using the execFlowFunctionObjects utility. The
range of uses include:
- \ref grpCloudFunctionObjects
- \ref grpFieldFunctionObjects
- \ref grpForcesFunctionObjects
- \ref grpIOFunctionObjects
- \ref grpJobControlFunctionObjects
- \ref grpUtilitiesFunctionObjects
<br>
\subsection secFieldFunctionObjectUsage Using function objects
To employ function objects, additional entries are required in the
$FOAM_CASE/system/controlDict input dictionary. Each object is listed in a
\c functions sub-dictionary entry, e.g.
\verbatim
functions
{
myFunctionObject
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
outputControl outputTime; // output or timeStep
outputInterval 1; // only necessary for outputControl=timeStep
...
}
}
\endverbatim
The sub-dictionary name \c myFunctionObject is chosen by the user, and is
often used as the name of the output folder of any generated data. The \c type
entry defines the type of function object properties that follow. Since the
function objects are packaged into separate libraries, the user must tell the
code where to find the function object implementation, identified using the
\c libs entry.
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpJobControlFunctionObjects
@{
Class
Foam::abortCalculation
\ingroup grpJobControlFunctionObjects
Description
Watches for presence of the named file in the $FOAM_CASE directory
and aborts the calculation if it is present.
@ -39,7 +38,6 @@ Description
SourceFiles
abortCalculation.C
IOabortCalculation.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,19 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpFunctionObjects
@{
Class
Foam::systemCall
\ingroup grpFunctionObjects
Description
Executes system calls, entered in the form of a string list
SourceFiles
systemCall.C
IOsystemCall.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::codedFunctionObject
\ingroup grpUtilitiesFunctionObjects
Description
functionObject using dynamic code compilation.
SourceFiles
codedFunctionObject.C
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::dsmcFields
\ingroup grpUtilitiesFunctionObjects
Description
Calculate intensive fields:
- UMean
@ -38,7 +37,6 @@ Description
SourceFiles
dsmcFields.C
IOdsmcFields.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::pressureCoefficient
\ingroup grpUtilitiesFunctionObjects
Description
Calculates pressure coefficient, \f$c_p\f$
@ -41,7 +40,6 @@ Description
SourceFiles
pressureCoefficient.C
IOpressureCoefficient.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::staticPressure
\ingroup grpUtilitiesFunctionObjects
Description
Converts kinematic pressure to static pressure, from the name of the
pressure field, and density, i.e.
@ -36,7 +35,6 @@ Description
SourceFiles
staticPressure.C
IOstaticPressure.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,39 +21,38 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::timeActivatedFileUpdate
\ingroup grpUtilitiesFunctionObjects
Description
Performs a file copy/replacement once a specified time has been reached.
Example usage to update the fvSolution dictionary at various times
throughout the calculation:
fileUpdate1
{
type timeActivatedFileUpdate;
functionObjectLibs ("libutilityFunctionObjects.so");
outputControl timeStep;
outputInterval 1;
fileToUpdate "$FOAM_CASE/system/fvSolution";
timeVsFile
(
(-1 "$FOAM_CASE/system/fvSolution.0")
(0.10 "$FOAM_CASE/system/fvSolution.10")
(0.20 "$FOAM_CASE/system/fvSolution.20")
(0.35 "$FOAM_CASE/system/fvSolution.35")
);
}
\verbatim
fileUpdate1
{
type timeActivatedFileUpdate;
functionObjectLibs ("libutilityFunctionObjects.so");
outputControl timeStep;
outputInterval 1;
fileToUpdate "$FOAM_CASE/system/fvSolution";
timeVsFile
(
(-1 "$FOAM_CASE/system/fvSolution.0")
(0.10 "$FOAM_CASE/system/fvSolution.10")
(0.20 "$FOAM_CASE/system/fvSolution.20")
(0.35 "$FOAM_CASE/system/fvSolution.35")
);
}
\endverbatim
SourceFiles
timeActivatedFileUpdate.C
IOtimeActivatedFileUpdate.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::yPlusLES
\ingroup grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for LES models. Values written to
time folders as field 'yPlusLES'
@ -34,7 +33,6 @@ Description
SourceFiles
yPlusLES.C
IOyPlusLES.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::yPlusRAS
\ingroup grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for RAS models. Values written to
time folders as field 'yPlusRAS'
@ -34,7 +33,6 @@ Description
SourceFiles
yPlusRAS.C
IOyPlusRAS.H
@}
\*---------------------------------------------------------------------------*/