From ea94da21686858b0a486d64b58b66dc655250751 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 13 Jun 2013 12:58:03 +0100 Subject: [PATCH] ENH: Documentation updates --- .../XiGModels/basicXiSubG/basicXiSubG.H | 14 ++++++------- .../XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H | 5 ++--- .../searchableSurface/searchablePlate.H | 8 ++++---- .../functionObjects/doc/functionObjects.dox | 20 +++++++++---------- ...silonLowReWallFunctionFvPatchScalarField.H | 2 +- .../mutURoughWallFunctionFvPatchScalarField.H | 4 ++-- 6 files changed, 26 insertions(+), 27 deletions(-) diff --git a/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H b/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H index 109354319e..aaf4620e3c 100644 --- a/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H +++ b/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,8 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::XiGModel::basicSubGrid - + Foam::XiGModels::basicSubGrid Description @@ -39,13 +38,14 @@ Description and the removal: - \f[ - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}} - \frac{\Xi_{sub}-1}{\Xi_{sub}} \f] + \f[ + - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}} + \frac{\Xi_{sub}-1}{\Xi_{sub}} + \f] Finally, \f$ G_{sub} \f$ is added to generation rate \f$ G_{in} \f$ due to the turbulence. - SourceFiles basicSubGrid.C @@ -64,7 +64,7 @@ namespace XiGModels { /*---------------------------------------------------------------------------*\ - Class basicSubGrid Declaration + Class basicSubGrid Declaration \*---------------------------------------------------------------------------*/ class basicSubGrid diff --git a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H index 4c7095a6ed..1a4bb1ec0b 100644 --- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H +++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::XiEqModel::SCOPEXiEq + Foam::XiEqModels::SCOPEXiEq Description Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation @@ -120,7 +120,6 @@ public: //- Update properties from given dictionary virtual bool read(const dictionary& XiEqProperties); - }; diff --git a/src/meshTools/searchableSurface/searchablePlate.H b/src/meshTools/searchableSurface/searchablePlate.H index 671f3785f6..86b0785077 100644 --- a/src/meshTools/searchableSurface/searchablePlate.H +++ b/src/meshTools/searchableSurface/searchablePlate.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ namespace Foam // Forward declaration of classes /*---------------------------------------------------------------------------*\ - Class searchablePlate Declaration + Class searchablePlate Declaration \*---------------------------------------------------------------------------*/ class searchablePlate @@ -112,7 +112,7 @@ public: ( const IOobject& io, const point& origin, - const point& span + const vector& span ); //- Construct from dictionary (used by searchableSurface) @@ -122,6 +122,7 @@ public: const dictionary& dict ); + //- Destructor virtual ~searchablePlate(); @@ -254,7 +255,6 @@ public: notImplemented("searchablePlate::writeData(Ostream&) const"); return false; } - }; diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox index 64073c2a3f..94eb32bc47 100644 --- a/src/postProcessing/functionObjects/doc/functionObjects.dox +++ b/src/postProcessing/functionObjects/doc/functionObjects.dox @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,14 +57,14 @@ functions { myFunctionObject // user-defined name of function object entry { - type functionObjectType; - libs ("libMyFunctionObjectlib.so"); - region defaultRegion; - enabled yes; - timeStart 0; - timeEnd 10; - outputControl outputTime; - outputInterval 1; + type functionObjectType; + functionObjectLibs ("libMyFunctionObjectlib.so"); + region defaultRegion; + enabled yes; + timeStart 0; + timeEnd 10; + outputControl outputTime; + outputInterval 1; ... } } @@ -74,7 +74,7 @@ Where: \table Property | Description | Required | Default value type | type of function object | yes | - libs | libraries containing object implementation | yes | + functionObjectLibs | libraries containing object implementation | yes | region | name of region for multi-region cases | no | enabled | on/off switch | no | yes timeStart| start time | no | diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H index c2f7cf178f..bac27237c3 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::iompressible::epsilonLowReWallFunctionFvPatchScalarField + Foam::compressible::epsilonLowReWallFunctionFvPatchScalarField Group grpCmpWallFunctions diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H index 12beef6338..ea1aaa184f 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::compressible:::mutURoughWallFunctionFvPatchScalarField + Foam::compressible::mutURoughWallFunctionFvPatchScalarField Group grpCmpWallFunctions