diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index bf0afd49a6..1d8d005f6c 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -24,7 +24,8 @@ License Class Foam::partialWrite -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Allows some fields/registered objects to be written more often than others. diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index c621047a0b..edd4e16bca 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -24,7 +24,8 @@ License Class Foam::removeRegisteredObject -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Removes registered IO objects if present in the database diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index d894fb392d..01d2c29037 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -24,7 +24,8 @@ License Class Foam::writeRegisteredObject -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Takes over the writing of registered IO objects diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index f45591d924..f0c56e71fb 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -24,7 +24,8 @@ License Class Foam::cloudInfo -\ingroup grpCloudFunctionObjects +Group + grpCloudFunctionObjects Description This function object outputs lagrangian cloud information to a file. The diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index ec00c29359..c85ef60678 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -24,7 +24,8 @@ License Class Foam::fieldAverage -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Calculates the field averages given list of fieldAverageItems, e.g. diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 618b5da574..bda640e009 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -24,7 +24,8 @@ License class Foam::fieldCoordinateSystemTransform -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Transforms fields from global cartesian co-ordinates to local co-ordinate diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 15e25484fe..96e87b5ff3 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -24,7 +24,8 @@ License Class Foam::fieldMinMax -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Calculates scalar minimim and maximum field values. diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index 2c12c2d024..2a67404c43 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -24,7 +24,8 @@ License Class Foam::fieldValue -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Base class for field value -based function objects. diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 151b8cd959..21c5bc7b09 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -24,7 +24,8 @@ License Class Foam::nearWallFields -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Samples near-patch volFields diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index c748e17fd1..3be2dbe298 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -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 diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 32cc119cbf..8cf5b7be29 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -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 diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 95cedb6517..149424fb27 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -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 diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index 7ee9abec12..e17f8cedf0 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -24,7 +24,8 @@ License Class Foam::streamLine -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Generation of streamlines. Samples along track of passive particle. diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index b91fd64632..44c0d54608 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -24,7 +24,7 @@ License Class Foam::surfaceInterpolateFields -\ingroup grpFieldFunctionObjects +Group grpFieldFunctionObjects Description Linear interpolates volFields to surfaceFields diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 9cabbd0eb1..3148b5448b 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -24,7 +24,8 @@ License Class Foam::turbulenceFields -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Stores turbulence fields on the mesh database for further manipulation. diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index a9d54a2ba8..14ab62724e 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -24,7 +24,8 @@ License Class Foam::wallBoundedStreamLine -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Generation of streamlines. Samples along track of passive particle. diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index f51f180d24..2d6055ba86 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -24,7 +24,8 @@ License Class Foam::forceCoeffs -\ingroup grpForcesFunctionObjects +Group + grpForcesFunctionObjects Description Derived from the forces function object, creates a specialisation to diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index d2c224abaa..1d1e525b58 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -24,7 +24,8 @@ License Class Foam::forces -\ingroup grpForcesFunctionObjects +Group + grpForcesFunctionObjects Description Calculates the forces and moments by integrating the pressure and diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 143b7b38b6..42da71f90c 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -24,7 +24,8 @@ License Class Foam::abortCalculation -\ingroup grpJobControlFunctionObjects +Group + grpJobControlFunctionObjects Description Watches for presence of the named file in the $FOAM_CASE directory diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index 9726836d80..bb26a7e1b9 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -24,7 +24,8 @@ License Class Foam::systemCall -\ingroup grpFunctionObjects +Group + grpFunctionObjects Description Executes system calls, entered in the form of a string list diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 8e2f1795ce..4a99468d09 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -24,7 +24,8 @@ License Class Foam::codedFunctionObject -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description functionObject using dynamic code compilation. diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index 0a037a2aec..512ac251c6 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -24,7 +24,8 @@ License Class Foam::dsmcFields -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Calculate intensive fields: diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index db5f1dcc4b..265ac0f656 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -24,18 +24,28 @@ License Class Foam::pressureCoefficient -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Calculates pressure coefficient, \f$c_p\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] - 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 pressureCoefficient.C diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 56586b256d..6b270e7353 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -24,7 +24,8 @@ License Class Foam::staticPressure -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Converts kinematic pressure to static pressure, from the name of the diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index afb63cb323..786e0f21fa 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -24,7 +24,8 @@ License Class Foam::timeActivatedFileUpdate -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Performs a file copy/replacement once a specified time has been reached. diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index 14a2ba895b..795e9aed89 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -24,7 +24,8 @@ License Class Foam::yPlusLES -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Evaluates and outputs turbulence y+ for LES models. Values written to diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 3e35bb4bfb..38085ae722 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -24,7 +24,8 @@ License Class Foam::yPlusRAS -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Evaluates and outputs turbulence y+ for RAS models. Values written to diff --git a/src/sampling/probes/probes.H b/src/sampling/probes/probes.H index 18200ddcd7..9634d626dd 100644 --- a/src/sampling/probes/probes.H +++ b/src/sampling/probes/probes.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::probes +Group + grpFunctionObjects + Description Set of locations to sample. @@ -34,7 +34,6 @@ Description SourceFiles probes.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSet/sampledSet/sampledSet.H b/src/sampling/sampledSet/sampledSet/sampledSet.H index 461e3c1ee3..51905951f9 100644 --- a/src/sampling/sampledSet/sampledSet/sampledSet.H +++ b/src/sampling/sampledSet/sampledSet/sampledSet.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::sampledSet +Group + grpFunctionObjects + Description Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points @@ -38,7 +38,6 @@ Description SourceFiles sampledSet.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H index fe820c1b5d..8a2bfa9fed 100644 --- a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H +++ b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::sampledSurface +Group + grpFunctionObjects + Description An abstract class for surfaces with sampling. @@ -46,7 +46,6 @@ Description SourceFiles sampledSurface.C sampledSurfaceTemplates.C -@} \*---------------------------------------------------------------------------*/