From 11720721728ce3af0064111ae55731b4807b3695 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 10:20:02 +0100 Subject: [PATCH 001/109] STYLE: argList - minor change to doxygen doc --- src/OpenFOAM/global/argList/argList.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/OpenFOAM/global/argList/argList.H b/src/OpenFOAM/global/argList/argList.H index 4ec3bd4075..4cc354d2cb 100644 --- a/src/OpenFOAM/global/argList/argList.H +++ b/src/OpenFOAM/global/argList/argList.H @@ -26,7 +26,7 @@ Class Description Extract command arguments and options from the supplied - \a argc and @a argv parameters. + \a argc and \a argv parameters. Sequences with "(" ... ")" are transformed into a stringList. For example, From 3f646a44ab80cb87ee6f3fe0610e823321d71b03 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 11:36:40 +0100 Subject: [PATCH 002/109] STYLE: minor code formatting --- .../radiationCoupledBase/radiationCoupledBase.H | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/radiationCoupledBase/radiationCoupledBase.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/radiationCoupledBase/radiationCoupledBase.H index a60c23d4c5..548a83262c 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/radiationCoupledBase/radiationCoupledBase.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/radiationCoupledBase/radiationCoupledBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,12 +55,14 @@ namespace Foam class radiationCoupledBase { public: - //- Type of supplied emissivity - enum emissivityMethodType - { - SOLIDTHERMO, - LOOKUP - }; + + //- Type of supplied emissivity + enum emissivityMethodType + { + SOLIDTHERMO, + LOOKUP + }; + private: @@ -72,6 +74,7 @@ private: //- Underlying patch const fvPatch& patch_; + protected: // Protected data From 489b2debd9eaa3319cf2b72ec2c32611bc0e0aed Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 11:52:00 +0100 Subject: [PATCH 003/109] ENH: Enhanced documentation for MArshak radiation boundary conditions --- .../MarshakRadiationMixedFvPatchScalarField.H | 19 ++++++++++++++++--- ...akRadiationFixedTMixedFvPatchScalarField.H | 19 ++++++++++++++++--- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H index a8ba8cbfc8..29173820b3 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,21 @@ Class Foam::MarshakRadiationFvPatchScalarField Description - Marshak boundary for radiation G field - - radiation temperature taken from patch value + A 'mixed' boundary condition that implements a Marshak condition for the + incident radiation field (usually written as G) + + The radiation temperature is retrieved from the mesh database, using a + user specified temperature field name. + + Example of the boundary condition specification: + \verbatim + inlet + { + type MarshakRadiation; + T T; // name of temperature field + value uniform 0; // optional value entry + } + \endverbatim SourceFiles MarshakRadiationFvPatchScalarField.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H index 97bde41076..eca5babefa 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,21 @@ Class Foam::MarshakRadiationFixedTMixedFvPatchScalarField Description - Marshak boundary for radiation G field - - radiation temperature specified + A 'mixed' boundary condition that implements a Marshak condition for the + incident radiation field (usually written as G) + + The radiation temperature field across the patch is supplied by the user + using the \c Trad entry. + + Example of the boundary condition specification: + \verbatim + inlet + { + type MarshakRadiationFixedT; + Trad uniform 1000; // radiation temperature field + value uniform 0; // place holder + } + \endverbatim SourceFiles MarshakRadiationFixedTMixedFvPatchScalarField.C From c2723a8ac39237946f657db321c395f37da2a1c8 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 11:59:54 +0100 Subject: [PATCH 004/109] ENH: updates to radiation Marshak boundary conditions --- .../radiationModels/Make/files | 4 +- ...C => MarshakRadiationFvPatchScalarField.C} | 6 +-- ...H => MarshakRadiationFvPatchScalarField.H} | 0 ...ationFixedTemperatureFvPatchScalarField.C} | 46 +++++++++---------- ...ationFixedTemperatureFvPatchScalarField.H} | 38 ++++++++------- 5 files changed, 47 insertions(+), 47 deletions(-) rename src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/{MarshakRadiationMixedFvPatchScalarField.C => MarshakRadiationFvPatchScalarField.C} (97%) rename src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/{MarshakRadiationMixedFvPatchScalarField.H => MarshakRadiationFvPatchScalarField.H} (100%) rename src/thermophysicalModels/radiationModels/derivedFvPatchFields/{MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.C => MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.C} (75%) rename src/thermophysicalModels/radiationModels/derivedFvPatchFields/{MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H => MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H} (80%) diff --git a/src/thermophysicalModels/radiationModels/Make/files b/src/thermophysicalModels/radiationModels/Make/files index c86d8aa8d3..9822712105 100644 --- a/src/thermophysicalModels/radiationModels/Make/files +++ b/src/thermophysicalModels/radiationModels/Make/files @@ -26,8 +26,8 @@ submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionE /* Boundary conditions */ -derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.C -derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.C +derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C +derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.C derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C derivedFvPatchFields/radiationCoupledBase/radiationCoupledBase.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.C b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C similarity index 97% rename from src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.C rename to src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C index 9068904d50..9bd7d0f827 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.C +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -23,12 +23,10 @@ License \*---------------------------------------------------------------------------*/ -#include "MarshakRadiationMixedFvPatchScalarField.H" +#include "MarshakRadiationFvPatchScalarField.H" #include "addToRunTimeSelectionTable.H" #include "fvPatchFieldMapper.H" #include "volFields.H" - -#include "fvc.H" #include "radiationModel.H" #include "physicoChemicalConstants.H" diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H similarity index 100% rename from src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H rename to src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.C b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.C similarity index 75% rename from src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.C rename to src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.C index 711ac43bd9..d98d0c56f5 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.C +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -23,19 +23,17 @@ License \*---------------------------------------------------------------------------*/ -#include "MarshakRadiationFixedTMixedFvPatchScalarField.H" +#include "MarshakRadiationFixedTemperatureFvPatchScalarField.H" #include "addToRunTimeSelectionTable.H" #include "fvPatchFieldMapper.H" #include "volFields.H" - -#include "fvc.H" #include "radiationModel.H" #include "physicoChemicalConstants.H" // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::MarshakRadiationFixedTMixedFvPatchScalarField:: -MarshakRadiationFixedTMixedFvPatchScalarField +Foam::MarshakRadiationFixedTemperatureFvPatchScalarField:: +MarshakRadiationFixedTemperatureFvPatchScalarField ( const fvPatch& p, const DimensionedField& iF @@ -51,10 +49,10 @@ MarshakRadiationFixedTMixedFvPatchScalarField } -Foam::MarshakRadiationFixedTMixedFvPatchScalarField:: -MarshakRadiationFixedTMixedFvPatchScalarField +Foam::MarshakRadiationFixedTemperatureFvPatchScalarField:: +MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField& ptf, + const MarshakRadiationFixedTemperatureFvPatchScalarField& ptf, const fvPatch& p, const DimensionedField& iF, const fvPatchFieldMapper& mapper @@ -71,8 +69,8 @@ MarshakRadiationFixedTMixedFvPatchScalarField {} -Foam::MarshakRadiationFixedTMixedFvPatchScalarField:: -MarshakRadiationFixedTMixedFvPatchScalarField +Foam::MarshakRadiationFixedTemperatureFvPatchScalarField:: +MarshakRadiationFixedTemperatureFvPatchScalarField ( const fvPatch& p, const DimensionedField& iF, @@ -95,10 +93,10 @@ MarshakRadiationFixedTMixedFvPatchScalarField } -Foam::MarshakRadiationFixedTMixedFvPatchScalarField:: -MarshakRadiationFixedTMixedFvPatchScalarField +Foam::MarshakRadiationFixedTemperatureFvPatchScalarField:: +MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField& ptf + const MarshakRadiationFixedTemperatureFvPatchScalarField& ptf ) : mixedFvPatchScalarField(ptf), @@ -112,10 +110,10 @@ MarshakRadiationFixedTMixedFvPatchScalarField {} -Foam::MarshakRadiationFixedTMixedFvPatchScalarField:: -MarshakRadiationFixedTMixedFvPatchScalarField +Foam::MarshakRadiationFixedTemperatureFvPatchScalarField:: +MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField& ptf, + const MarshakRadiationFixedTemperatureFvPatchScalarField& ptf, const DimensionedField& iF ) : @@ -132,7 +130,7 @@ MarshakRadiationFixedTMixedFvPatchScalarField // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::autoMap +void Foam::MarshakRadiationFixedTemperatureFvPatchScalarField::autoMap ( const fvPatchFieldMapper& m ) @@ -142,7 +140,7 @@ void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::autoMap } -void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::rmap +void Foam::MarshakRadiationFixedTemperatureFvPatchScalarField::rmap ( const fvPatchScalarField& ptf, const labelList& addr @@ -150,14 +148,14 @@ void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::rmap { mixedFvPatchScalarField::rmap(ptf, addr); - const MarshakRadiationFixedTMixedFvPatchScalarField& mrptf = - refCast(ptf); + const MarshakRadiationFixedTemperatureFvPatchScalarField& mrptf = + refCast(ptf); Trad_.rmap(mrptf.Trad_, addr); } -void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::updateCoeffs() +void Foam::MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs() { if (this->updated()) { @@ -190,7 +188,7 @@ void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::updateCoeffs() } -void Foam::MarshakRadiationFixedTMixedFvPatchScalarField::write +void Foam::MarshakRadiationFixedTemperatureFvPatchScalarField::write ( Ostream& os ) const @@ -208,7 +206,7 @@ namespace Foam makePatchTypeField ( fvPatchScalarField, - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ); } diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H similarity index 80% rename from src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H rename to src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index eca5babefa..2dea136f86 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedT/MarshakRadiationFixedTMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::MarshakRadiationFixedTMixedFvPatchScalarField + Foam::MarshakRadiationFixedTemperatureFvPatchScalarField Description A 'mixed' boundary condition that implements a Marshak condition for the @@ -42,12 +42,12 @@ Description \endverbatim SourceFiles - MarshakRadiationFixedTMixedFvPatchScalarField.C + MarshakRadiationFixedTemperatureFvPatchScalarField.C \*---------------------------------------------------------------------------*/ -#ifndef MarshakRadiationFixedTMixedFvPatchField_H -#define MarshakRadiationFixedTMixedFvPatchField_H +#ifndef MarshakRadiationFixedTemperatureFvPatchScalarField_H +#define MarshakRadiationFixedTemperatureFvPatchScalarField_H #include "mixedFvPatchFields.H" #include "radiationCoupledBase.H" @@ -58,10 +58,10 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class MarshakRadiationFixedTMixedFvPatchScalarField Declaration + Class MarshakRadiationFixedTemperatureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ -class MarshakRadiationFixedTMixedFvPatchScalarField +class MarshakRadiationFixedTemperatureFvPatchScalarField : public mixedFvPatchScalarField, public radiationCoupledBase @@ -76,20 +76,20 @@ class MarshakRadiationFixedTMixedFvPatchScalarField public: //- Runtime type information - TypeName("MarshakRadiationFixedT"); + TypeName("MarshakRadiationFixedTemperature"); // Constructors //- Construct from patch and internal field - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ( const fvPatch&, const DimensionedField& ); //- Construct from patch, internal field and dictionary - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ( const fvPatch&, const DimensionedField&, @@ -98,18 +98,18 @@ public: //- Construct by mapping given MarshakRadiationFvPatchField onto a new // patch - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField&, + const MarshakRadiationFixedTemperatureFvPatchScalarField&, const fvPatch&, const DimensionedField&, const fvPatchFieldMapper& ); //- Construct as copy - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField& + const MarshakRadiationFixedTemperatureFvPatchScalarField& ); //- Construct and return a clone @@ -117,14 +117,14 @@ public: { return tmp ( - new MarshakRadiationFixedTMixedFvPatchScalarField(*this) + new MarshakRadiationFixedTemperatureFvPatchScalarField(*this) ); } //- Construct as copy setting internal field reference - MarshakRadiationFixedTMixedFvPatchScalarField + MarshakRadiationFixedTemperatureFvPatchScalarField ( - const MarshakRadiationFixedTMixedFvPatchScalarField&, + const MarshakRadiationFixedTemperatureFvPatchScalarField&, const DimensionedField& ); @@ -136,7 +136,11 @@ public: { return tmp ( - new MarshakRadiationFixedTMixedFvPatchScalarField(*this, iF) + new MarshakRadiationFixedTemperatureFvPatchScalarField + ( + *this, + iF + ) ); } From 13d9a409075589f66ba956498d88372289ce2320 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 12:29:31 +0100 Subject: [PATCH 005/109] ENH: Update to Aachen bomb tutorial input --- .../sprayFoam/aachenBomb/constant/sprayCloudProperties | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tutorials/lagrangian/sprayFoam/aachenBomb/constant/sprayCloudProperties b/tutorials/lagrangian/sprayFoam/aachenBomb/constant/sprayCloudProperties index b3072a5363..8c2494e676 100644 --- a/tutorials/lagrangian/sprayFoam/aachenBomb/constant/sprayCloudProperties +++ b/tutorials/lagrangian/sprayFoam/aachenBomb/constant/sprayCloudProperties @@ -60,8 +60,10 @@ constantProperties pMin 1000; minParticleMass 1e-15; - rho0 1000; T0 320; + + // place holders for rho0 and T0 - reset from liquid props using T0 + rho0 1000; Cp0 4187; youngsModulus 1e9; From 718507fc47acbc72949f7da989202fdf73995aab Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 15:34:54 +0100 Subject: [PATCH 006/109] ENH: Boundary condition doxygen documentation updates --- .../SRFFreestreamVelocityFvPatchVectorField.H | 35 ++++++++++-- .../SRFVelocityFvPatchVectorField.H | 37 +++++++++++-- .../activeBaffleVelocityFvPatchVectorField.H | 54 ++++++++++++++----- ...ureForceBaffleVelocityFvPatchVectorField.H | 45 +++++++++++++--- .../derived/advective/advectiveFvPatchField.H | 14 ++--- .../MarshakRadiationFvPatchScalarField.H | 12 ++--- ...iationFixedTemperatureFvPatchScalarField.H | 12 ++--- ...ayatillekeWallFunctionFvPatchScalarField.H | 20 +++++-- 8 files changed, 180 insertions(+), 49 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index 7b7b18b63e..e29d0a0864 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,33 @@ Class Foam::SRFVelocityFvPatchVectorField Description - Freestream velocity patch to be used with SRF model - to apply the appropriate rotation transformation in time and space. + Freestream velocity condition to be used in conjunction with the single + rotating frame (SRF) model (see: SRFModel class) + + Given the free stream velocity in the absolute frame, the condition + applies the appropriate rotation transformation in time and space to + determine the local velocity using: + + \f[ + Up = cos(theta)*UInf + sin(theta)*(n^UInf) - Up_srf + \f] + + where + \var Up = patch velocity [m/s] + \var UInf = free stream velocity in the absolute frame [m/s] + \var theta = swept angle [rad] + \var n = axis direction of the SRF + \var Up_srf = SRF velocity of the patch + + Example of the boundary condition specification: + \verbatim + myPatch + { + type SRFFreestreamVelocity; + UInf (0 0 0); // free stream velocity + value uniform (0 0 0); // optional value entry + } + \endverbatim SourceFiles SRFVelocityFvPatchVectorField.C @@ -44,7 +69,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class SRFFreestreamVelocityFvPatchVectorField Declaration + Class SRFFreestreamVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class SRFFreestreamVelocityFvPatchVectorField @@ -53,7 +78,7 @@ class SRFFreestreamVelocityFvPatchVectorField { // Private data - //- Velocity of the free stream in the absolute frame + //- Velocity of the free stream in the absolute frame [m/s] vector UInf_; diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 829f2444be..376f8ae27e 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,38 @@ Class Foam::SRFVelocityFvPatchVectorField Description - Velocity patch to be used with SRF model + Velocity condition to be used in conjunction with the single + rotating frame (SRF) model (see: SRFModel class) + + Given the free stream velocity in the absolute frame, the condition + applies the appropriate rotation transformation in time and space to + determine the local velocity. + + The optional \c relative flag switches the behaviour of the patch + such that: + + \li relative = yes: inlet velocity applied 'as is': + + \f[ + Up = U_in + \f] + + \li relative = no : SRF velocity is subtracted from the inlet velocity: + + \f[ + Up = U_in - U_srf + \f] + + Example of the boundary condition specification: + \verbatim + myPatch + { + type SRFVelocity; + relative yes; // relative motion to the SRF? + inletValue uniform (0 0 0); // inlet velocity + value uniform (0 0 0); // initial value + } + \endverbatim SourceFiles SRFVelocityFvPatchVectorField.C @@ -57,7 +88,7 @@ class SRFVelocityFvPatchVectorField //- Is the supplied inlet value relative to the SRF Switch relative_; - //- Inlet value + //- Inlet value [m/s] vectorField inletValue_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 19281b5220..aa5f5f077b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,44 @@ Class Foam::activeBaffleVelocityFvPatchVectorField Description - Boundary condition that modifies mesh areas based on velocity. + This boundary condition is applied to the flow velocity, to simulate the + opening of a baffle due to local flow conditions, by merging the behaviours + of wall and cyclic conditions. + + The baffle joins two mesh regions, where the open fraction determines + the interpolation weights applied to each cyclic- and neighbour-patch + contribution. + + We determine whether the baffle is opening or closing from the sign of + the net force across the baffle, from which the baffle open fraction is + updated using: + + \f[ + x = x_old + dt/DT*sign(F_net) + \f] + + where + \var x = baffle open fraction [0-1] + \var x_old = baffle open fraction on previous evaluation + \var dt = simulation time step + \var DT = time taken to open the baffle + \var F_net = net force across the baffle + + The open fraction is then applied to scale the patch areas. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type activeBaffleVelocity; + p p; // name of pressure field (default = p) + cyclicPatch cyclic1; // name of cyclic patch + orientation 1; // 1 or -1 used to switch flow direction + openFraction 0.2; // current opatch open fraction [0-1] + openingTime 5.0; // time taken to open the baffle + maxOpenFractionDelta 0.1; // max open fraction change/timestep + } + \endverbatim SourceFiles activeBaffleVelocityFvPatchVectorField.C @@ -44,7 +81,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class activeBaffleVelocityFvPatch Declaration + Class activeBaffleVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class activeBaffleVelocityFvPatchVectorField @@ -163,17 +200,10 @@ public: // Mapping functions //- Map (and resize as needed) from self given a mapping object - virtual void autoMap - ( - const fvPatchFieldMapper& - ); + virtual void autoMap(const fvPatchFieldMapper&); //- Reverse map the given fvPatchField onto this fvPatchField - virtual void rmap - ( - const fvPatchVectorField&, - const labelList& - ); + virtual void rmap(const fvPatchVectorField&, const labelList&); //- Update the coefficients associated with the patch field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 2e5b6982fe..05bac8a277 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,11 +25,43 @@ Class Foam::activePressureForceBaffleVelocityFvPatchVectorField Description - Bounday which emulates the operation of a release pressure panel. + This boundary condition is applied to the flow velocity, to simulate the + opening of a baffle due to local flow conditions, by merging the behaviours + of wall and cyclic conditions. - The boundary condition modifies mesh areas based on difference - of pressure or force face beween both sides of the panel. Once opened the - panel continues to open at a fixed rate. + The baffle joins two mesh regions, where the open fraction determines + the interpolation weights applied to each cyclic- and neighbour-patch + contribution. + + Once opened the baffle continues to open at a fixed rate using + + \f[ + x = x_old + dt/DT + \f] + + where + \var x = baffle open fraction [0-1] + \var x_old = baffle open fraction on previous evaluation + \var dt = simulation time step + \var DT = time taken to open the baffle + + The open fraction is then applied to scale the patch areas. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type activePressureForceBaffleVelocity; + p p; // name of pressure field (default = p) + cyclicPatch cyclic1; // name of cyclic patch + orientation 1; // 1 or -1 used to switch flow direction + openFraction 0.2; // current opatch open fraction [0-1] + openingTime 5.0; // time taken to open the baffle + maxOpenFractionDelta 0.1; // max open fraction change/timestep + minThresholdValue 0.01; // minimum open fraction for activation + forceBased false; // force (true) or pressue (false) + } + \endverbatim SourceFiles activePressureForceBaffleVelocityFvPatchVectorField.C @@ -48,7 +80,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class activePressureForceBaffleVelocityFvPatch Declaration + Class activePressureForceBaffleVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class activePressureForceBaffleVelocityFvPatchVectorField @@ -102,6 +134,7 @@ class activePressureForceBaffleVelocityFvPatchVectorField //- Baffle is activated bool baffleActivated_; + public: //- Runtime type information diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 0734a95682..b9e46ea66f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -31,15 +31,15 @@ Description The standard (Euler, backward, CrankNicholson) time schemes are supported. Additionally an optional mechanism to relax the value at the boundary to a specified far-field value is provided which is - switched on by specifying the relaxation length-scale lInf and the - far-field value fieldInf. + switched on by specifying the relaxation length-scale \c lInf and the + far-field value \c fieldInf. The flow/wave speed at the outlet is provided by the virtual function advectionSpeed() the default implementation of which requires the name of - the flux field (phi) and optionally the density (rho) if the mass-flux - rather than the volumetric-flux is given. + the flux field \c (phi) and optionally the density \c (rho) if the + mass-flux rather than the volumetric-flux is given. \verbatim - outlet + myPatch { type advective; phi phi; @@ -50,7 +50,7 @@ Description \endverbatim The flow/wave speed at the outlet can be changed by deriving a specialised - BC from this class and overriding advectionSpeed() e.g. in + BC from this class and over-riding advectionSpeed() e.g. in waveTransmissiveFvPatchField the advectionSpeed() calculates and returns the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition. @@ -71,7 +71,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class advectiveFvPatch Declaration + Class advectiveFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index 29173820b3..bb159c3b8b 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -33,12 +33,12 @@ Description Example of the boundary condition specification: \verbatim - inlet - { - type MarshakRadiation; - T T; // name of temperature field - value uniform 0; // optional value entry - } + myPatch + { + type MarshakRadiation; + T T; // name of temperature field + value uniform 0; // optional value entry + } \endverbatim SourceFiles diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index 2dea136f86..32b003ccd0 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -33,12 +33,12 @@ Description Example of the boundary condition specification: \verbatim - inlet - { - type MarshakRadiationFixedT; - Trad uniform 1000; // radiation temperature field - value uniform 0; // place holder - } + myPatch + { + type MarshakRadiationFixedT; + Trad uniform 1000; // radiation temperature field + value uniform 0; // place holder + } \endverbatim SourceFiles diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index b36779b35c..a3cf15a47b 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,20 @@ Class alphatJayatillekeWallFunctionFvPatchScalarField Description - Thermal wall function for turbulent thermal diffusivity based on the - Jayatilleke thermal wall function + Thermal wall function for turbulent thermal diffusivity (usually + \c alphaSgs) based on the Jayatilleke model. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type alphaSgsJayatillekeWallFunction; + Prt 0.85; // turbulent Prandtl number (default = 0.85) + kappa 0.41; // Von Karman constant (default = 0.41) + E 9.8; // E coefficient (default = 9.8) + value uniform 0; // optional value entry + } + \endverbatim SourceFiles alphatJayatillekeWallFunctionFvPatchScalarField.C @@ -48,7 +60,7 @@ namespace RASModels { /*---------------------------------------------------------------------------*\ - Class alphatJayatillekeWallFunctionFvPatchScalarField Declaration + Class alphatJayatillekeWallFunctionFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class alphatJayatillekeWallFunctionFvPatchScalarField From 620519dd31ddf1825c80c1dd1c4ae9086d642d9b Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 15:36:04 +0100 Subject: [PATCH 007/109] ENH: Updates to active baffle BCs - output messages and write --- .../activeBaffleVelocityFvPatchVectorField.C | 1 + ...tivePressureForceBaffleVelocityFvPatchVectorField.C | 10 ++++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C index 86cd31df92..6bbc455afa 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C @@ -292,6 +292,7 @@ void Foam::activeBaffleVelocityFvPatchVectorField::updateCoeffs() void Foam::activeBaffleVelocityFvPatchVectorField::write(Ostream& os) const { fvPatchVectorField::write(os); + writeEntryIfDifferent(os, "p", "p", pName_) os.writeKeyword("cyclicPatch") << cyclicPatchName_ << token::END_STATEMENT << nl; os.writeKeyword("orientation") diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C index 2e65230aae..c69b5871f0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C @@ -92,7 +92,7 @@ activePressureForceBaffleVelocityFvPatchVectorField ) : fixedValueFvPatchVectorField(p, iF), - pName_("p"), + pName_(dict.lookupOrDefault("p", "p")), cyclicPatchName_(dict.lookup("cyclicPatch")), cyclicPatchLabel_(p.patch().boundaryMesh().findPatchID(cyclicPatchName_)), orientation_(readLabel(dict.lookup("orientation"))), @@ -278,6 +278,8 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs() { valueDiff -=p[nbrFaceCells[facei]]*mag(initCyclicSf_[facei]); } + + Info<< "Force difference = " << valueDiff << endl; } else //pressure based { @@ -290,6 +292,8 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs() { valueDiff -= p[nbrFaceCells[facei]]; } + + Info<< "Pressure difference = " << valueDiff << endl; } if ((mag(valueDiff) > mag(minThresholdValue_) || baffleActivated_)) @@ -316,7 +320,6 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs() } Info<< "Open fraction = " << openFraction_ << endl; - Info<< "Pressure difference = " << valueDiff << endl; vectorField::subField Sfw = patch().patch().faceAreas(); vectorField newSfw((1 - openFraction_)*initWallSf_); @@ -351,6 +354,7 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField:: write(Ostream& os) const { fvPatchVectorField::write(os); + writeEntryIfDifferent(os, "p", "p", pName_) os.writeKeyword("cyclicPatch") << cyclicPatchName_ << token::END_STATEMENT << nl; os.writeKeyword("orientation") @@ -361,8 +365,6 @@ write(Ostream& os) const << maxOpenFractionDelta_ << token::END_STATEMENT << nl; os.writeKeyword("openFraction") << openFraction_ << token::END_STATEMENT << nl; - os.writeKeyword("p") - << pName_ << token::END_STATEMENT << nl; os.writeKeyword("minThresholdValue") << minThresholdValue_ << token::END_STATEMENT << nl; os.writeKeyword("forceBased") From a83647f6fd3741904f56a824320d5ef9d3066f19 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 16:50:30 +0100 Subject: [PATCH 008/109] ENH: Boundary condition doxygen documentation updates --- .../basic/calculated/calculatedFvPatchField.H | 17 ++++- .../buoyantPressureFvPatchScalarField.H | 39 +++++++++-- ...alphatFilmWallFunctionFvPatchScalarField.H | 21 +++++- .../alphatWallFunctionFvPatchScalarField.H | 27 ++++++-- ...ndaryLayerInletEpsilonFvPatchScalarField.H | 55 ++++++++++------ ...daryLayerInletVelocityFvPatchVectorField.H | 64 ++++++++++++------- 6 files changed, 165 insertions(+), 58 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index afb676b229..c3f249287b 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,18 @@ Class Foam::calculatedFvPatchField Description - Foam::calculatedFvPatchField + This boundary condition is not designed to be evaluated; it is assmued + that the value is assigned via field assignment, and not via a call to + e.g. \c updateCoeffs or \c evaluate. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type calculated; + value uniform (0 0 0); // optional value entry + } + \endverbatim SourceFiles calculatedFvPatchField.C @@ -43,7 +54,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class calculatedFvPatch Declaration + Class calculatedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 79d9eaa543..e239f77976 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,10 +25,41 @@ Class Foam::buoyantPressureFvPatchScalarField Description - Set the pressure gradient boundary condition appropriately for buoyant flow. + This boundary condition sets the pressure gradient appropriately for + buoyant flow. - If the variable name is "pd" assume it is p - rho*g.h and set the gradient - appropriately. Otherwise assume the variable is the static pressure. + If the variable name is one of: + \li pd + \li p_rgh + \li ph_rgh + we assume that the pressure variable is \f$ p - rho*g.h\f$ and the gradient + set using: + \f[ + grad(pressure) = -snGrad(rho)*(g.h) + \f] + where + \var snGrad = surface-normal gradient operator + \var rho = density [kg/m3] + \var g = acceleration due to gravity [m/s2] + \var h = patch face centres [m] + + Otherwise we assume that it is the static pressure, and the gradient + calculated using: + \f[ + grad(pressure) = rho*(g.n) + \f] + where + \var n = patch face normal vectors + + Example of the boundary condition specification: + \verbatim + myPatch + { + type buoyantPressure; + rho rho; // optional density field name (default = rho) + value uniform 0; + } + \endverbatim SourceFiles buoyantPressureFvPatchScalarField.C diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index 25ec241979..e01028532a 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,23 @@ Class Foam::compressible::RASModels::alphatFilmWallFunctionFvPatchScalarField Description - Turbulent thermal diffusivity boundary conditions for use with surface - film models. + Turbulent thermal diffusivity boundary condition for use with surface + film models. This condition varies from the standard wall function by + taking into account any mass released from the film model. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type alphatFilmWallFunction; + B 5.5; // B coefficient (default = 5.5) + yPlusCrit 11.05; // critical y+ (default = 11.05) + Cmu 0.09; // Cmu coefficient (default = 0.09) + kappa 0.41; // kappa coefficient (default = 0.41) + Prt 0.85; // turbulent Prandtl number (default = 0.85) + value uniform 0; // optional value entry + } + \endverbatim SourceFiles alphatFilmWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 8681a33afd..0e6b27275d 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,8 +27,25 @@ Class Description Boundary condition for turbulent thermal diffusivity when using wall functions - - replicates OpenFOAM v1.5 (and earlier) behaviour - - Turbulent Prandtl number defaults to 0.85 if unspecified + + \li replicates OpenFOAM v1.5 (and earlier) behaviour + + Turbulent thermal diffusivity calculated using: + + \f[ + alphat = mut/Prt + \f] + + Example of the boundary condition specification: + \verbatim + myPatch + { + type alphatWallFunction; + mut mut; // turbulent viscosity field (default = mut) + Prt 0.85; // turbulent Prandtl number (default = 085) + value uniform 0; // optional value entry + } + \endverbatim SourceFiles alphatWallFunctionFvPatchScalarField.C @@ -59,10 +76,10 @@ class alphatWallFunctionFvPatchScalarField { // Private data - //- Name of turbulent viscosity field + //- Name of turbulent viscosity field (default = mut) word mutName_; - //- Turbulent Prandtl number + //- Turbulent Prandtl number (default = 0.85) scalar Prt_; diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 7eded6ae1e..964ff6286b 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -26,38 +26,53 @@ Class atmBoundaryLayerInletEpsilonFvPatchScalarField Description - Boundary condition specifies a epsilon inlet for the atmospheric boundary - layer (ABL). This boundaty is to be used in conjunction with - ABLInletVelocity. + This boundary condition specifies an inlet value for the turbulence + dissipation \c epsilon, appropriate for atmospheric boundary layers (ABL), + and designed to be used in conjunction with the \c ABLInletVelocity inlet + velocity boundary condition. - \verbatim - epsilon = Ustar^3 / (K(z - zGround + z0)) + \f[ + epsilon = Ustar^3 / (K(z - zGround + z0)) + \f] where: - Ustar is the frictional velocity - K is karman's constant - z is the verical coordinate - z0 is the surface roughness lenght - zGround minium vlaue in z direction - + \var Ustar = frictional velocity + \var K = Karman's constant + \var z = vertical co-ordinate [m] + \var z0 = surface roughness length [m] + \var zGround = minimum vlaue in z direction [m] and: - Ustar = K Uref/ln((Zref + z0)/z0) + \f[ + Ustar = K Uref/ln((Zref + z0)/z0) + \f] where: - Uref is the reference velocity at Zref - Zref is the reference height. + \var Uref = reference velocity at Zref [m/s] + \var Zref = reference height [m] + Example of the boundary condition specification: + \verbatim + myPatch + { + type atmBoundaryLayerInletEpsilon; + z 1.0; // vertical co-ordinate [m] + kappa 0.41; // kappa coefficient (default = 0.41) + Uref 1.0; // reference velocity [m/s] + Href 0.0; // reference height [m] + z0 uniform 0.0; // surface roughness length [m] + zGround uniform 0.0; // minimum z co-ordinate [m] + } \endverbatim Reference: - D.M. Hargreaves and N.G. Wright - "On the use of the k-epsilon model in commercial CFD software to model the - neutral atmospheric boundary layer" - Journal of Wind Engineering and Industrial Aerodynamics 95(2007) 355-369. + D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model + in commercial CFD software to model the neutral atmospheric boundary + layer", Journal of Wind Engineering and Industrial Aerodynamics + 95(2007), pp 355-369. SourceFiles atmBoundaryLayerInletEpsilonFvPatchScalarField.C @@ -96,13 +111,13 @@ class atmBoundaryLayerInletEpsilonFvPatchScalarField //- Reference velocity const scalar Uref_; - //- Reference hight + //- Reference height const scalar Href_; //- Surface roughness length scalarField z0_; - //- Minimum corrdinate value in z direction + //- Minimum co-ordinate value in z direction scalarField zGround_; //- Frictional velocity diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 16c05dcee5..21b57a5ac4 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -26,42 +26,60 @@ Class atmBoundaryLayerInletVelocityFvPatchVectorField Description - Boundary condition specifies a atmospheric boundary layer (ABL) - velocity inlet profile given the friction velocity value, - flow direction n and direction of the parabolic coordinate z. + This boundary condition specifies a velocity inlet profile appropriate + for atmospheric boundary layers (ABL). The profile is derived from the + friction velocity, flow direction and the direction of the parabolic + co-ordinate \c z. - \verbatim - U = (Ustar/K) ln((z - zGround + z0)/z0) + \f[ + U = (Ustar/K) ln((z - zGround + z0)/z0) + \f] where: - Ustar is the frictional velocity - K is karman's constant - z0 is the surface roughness lenght - z is the verical coordinate - zGround is the minumum coordinate value in z direction. + \var Ustar = frictional velocity + \var K = Karman's constant + \var z = vertical co-ordinate [m] + \var z0 = surface roughness length [m] + \var zGround = minimum vlaue in z direction [m] and: - Ustar = K Uref/ln((Zref + z0)/z0) + \f[ + Ustar = K Uref/ln((Zref + z0)/z0) + \f] where: - Uref is the reference velocity at Zref - Zref is the reference height. - - \endverbatim + \var Uref = reference velocity at Zref [m/s] + \var Zref = reference height [m] Reference: - D.M. Hargreaves and N.G. Wright - "On the use of the k-epsilon model in commercial CFD software to model the - neutral atmospheric boundary layer" - Journal of Wind Engineering and Industrial Aerodynamics 95(2007) 355-369. + D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model + in commercial CFD software to model the neutral atmospheric boundary + layer", Journal of Wind Engineering and Industrial Aerodynamics + 95(2007), pp 355-369. -NOTE: D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the k-epsilon - model should be changed from 1.3 to 1.11 for consistency. - The roughness height (Er) is given by Er = 20 z0 following the same - reference + \note + D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the + k-epsilon model should be changed from 1.3 to 1.11 for consistency. + The roughness height (Er) is given by Er = 20 z0 following the same + reference. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type atmBoundaryLayerInletVelocity; + n (0 1 0); // flow direction + z 1.0; // vertical co-ordinate [m] + kappa 0.41; // kappa coefficient (default = 0.41) + Uref 1.0; // reference velocity [m/s] + Href 0.0; // reference height [m] + z0 uniform 0.0; // surface roughness length [m] + zGround uniform 0.0; // minimum z co-ordinate [m] + } + \endverbatim SourceFiles atmBoundaryLayerInletVelocityFvPatchVectorField.C From fd658a4a47cc5b0fca23550f7821da4b9b271671 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 16:51:53 +0100 Subject: [PATCH 009/109] ENH: took code out of Foam namespace and apply Foam:: prefix instead --- .../basic/calculated/calculatedFvPatchField.C | 40 +++++++++---------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C index 1f179134fe..444a3ea86a 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,19 +28,17 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -namespace Foam -{ - template -const word& fvPatchField::calculatedType() +const Foam::word& Foam::fvPatchField::calculatedType() { return calculatedFvPatchField::typeName; } + // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // template -calculatedFvPatchField::calculatedFvPatchField +Foam::calculatedFvPatchField::calculatedFvPatchField ( const fvPatch& p, const DimensionedField& iF @@ -51,7 +49,7 @@ calculatedFvPatchField::calculatedFvPatchField template -calculatedFvPatchField::calculatedFvPatchField +Foam::calculatedFvPatchField::calculatedFvPatchField ( const calculatedFvPatchField& ptf, const fvPatch& p, @@ -64,7 +62,7 @@ calculatedFvPatchField::calculatedFvPatchField template -calculatedFvPatchField::calculatedFvPatchField +Foam::calculatedFvPatchField::calculatedFvPatchField ( const fvPatch& p, const DimensionedField& iF, @@ -77,7 +75,7 @@ calculatedFvPatchField::calculatedFvPatchField template -calculatedFvPatchField::calculatedFvPatchField +Foam::calculatedFvPatchField::calculatedFvPatchField ( const calculatedFvPatchField& ptf ) @@ -87,7 +85,7 @@ calculatedFvPatchField::calculatedFvPatchField template -calculatedFvPatchField::calculatedFvPatchField +Foam::calculatedFvPatchField::calculatedFvPatchField ( const calculatedFvPatchField& ptf, const DimensionedField& iF @@ -99,7 +97,8 @@ calculatedFvPatchField::calculatedFvPatchField template template -tmp > fvPatchField::NewCalculatedType +Foam::tmp > +Foam::fvPatchField::NewCalculatedType ( const fvPatchField& pf ) @@ -132,7 +131,8 @@ tmp > fvPatchField::NewCalculatedType // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // template -tmp > calculatedFvPatchField::valueInternalCoeffs +Foam::tmp > +Foam::calculatedFvPatchField::valueInternalCoeffs ( const tmp& ) const @@ -155,7 +155,8 @@ tmp > calculatedFvPatchField::valueInternalCoeffs template -tmp > calculatedFvPatchField::valueBoundaryCoeffs +Foam::tmp > +Foam::calculatedFvPatchField::valueBoundaryCoeffs ( const tmp& ) const @@ -177,7 +178,8 @@ tmp > calculatedFvPatchField::valueBoundaryCoeffs } template -tmp > calculatedFvPatchField::gradientInternalCoeffs() const +Foam::tmp > +Foam::calculatedFvPatchField::gradientInternalCoeffs() const { FatalErrorIn ( @@ -197,7 +199,8 @@ tmp > calculatedFvPatchField::gradientInternalCoeffs() const } template -tmp > calculatedFvPatchField::gradientBoundaryCoeffs() const +Foam::tmp > +Foam::calculatedFvPatchField::gradientBoundaryCoeffs() const { FatalErrorIn ( @@ -217,17 +220,12 @@ tmp > calculatedFvPatchField::gradientBoundaryCoeffs() const } -// Write template -void calculatedFvPatchField::write(Ostream& os) const +void Foam::calculatedFvPatchField::write(Ostream& os) const { fvPatchField::write(os); this->writeEntry("value", os); } -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -} // End namespace Foam - // ************************************************************************* // From 3dedf15abfc9f9d251f2fde42d04a80d172b8f7b Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 17:11:23 +0100 Subject: [PATCH 010/109] ENH: Updated waveSurfacePressure BC to allow for different time integration schemes --- .../waveSurfacePressureFvPatchScalarField.C | 174 ++++++++++-------- .../waveSurfacePressureFvPatchScalarField.H | 81 ++++---- 2 files changed, 141 insertions(+), 114 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C index 56a81e0f61..b094aff2b3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenCFD Ltd. \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,6 +29,34 @@ License #include "volFields.H" #include "surfaceFields.H" #include "uniformDimensionedFields.H" +#include "EulerDdtScheme.H" +#include "CrankNicholsonDdtScheme.H" +#include "backwardDdtScheme.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + template<> + const char* Foam::NamedEnum + < + Foam::waveSurfacePressureFvPatchScalarField::timeSchemeType, + 3 + >::names[] = + { + fv::EulerDdtScheme::typeName.c_str(), + fv::CrankNicholsonDdtScheme::typeName.c_str(), + fv::backwardDdtScheme::typeName.c_str() + }; +} + + +const Foam::NamedEnum +< + Foam::waveSurfacePressureFvPatchScalarField::timeSchemeType, + 3 +> Foam::waveSurfacePressureFvPatchScalarField::timeSchemeTypeNames_; + // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // @@ -41,10 +69,8 @@ waveSurfacePressureFvPatchScalarField : fixedValueFvPatchScalarField(p, iF), phiName_("phi"), - rhoName_("rho"), zetaName_("zeta"), - zeta0_(p.size(), vector::zero), - curTimeIndex_(-1) + rhoName_("rho") {} @@ -58,10 +84,8 @@ waveSurfacePressureFvPatchScalarField : fixedValueFvPatchScalarField(p, iF), phiName_(dict.lookupOrDefault("phi", "phi")), - rhoName_(dict.lookupOrDefault("rho", "rho")), zetaName_(dict.lookupOrDefault("zeta", "zeta")), - zeta0_(p.size(), vector::zero), - curTimeIndex_(-1) + rhoName_(dict.lookupOrDefault("rho", "rho")) { fvPatchField::operator= ( @@ -81,10 +105,8 @@ waveSurfacePressureFvPatchScalarField : fixedValueFvPatchScalarField(ptf, p, iF, mapper), phiName_(ptf.phiName_), - rhoName_(ptf.rhoName_), zetaName_(ptf.zetaName_), - zeta0_(ptf.zeta0_), - curTimeIndex_(-1) + rhoName_(ptf.rhoName_) {} @@ -96,10 +118,8 @@ waveSurfacePressureFvPatchScalarField : fixedValueFvPatchScalarField(wspsf), phiName_(wspsf.phiName_), - rhoName_(wspsf.rhoName_), zetaName_(wspsf.zetaName_), - zeta0_(wspsf.zeta0_), - curTimeIndex_(wspsf.curTimeIndex_) + rhoName_(wspsf.rhoName_) {} @@ -112,40 +132,13 @@ waveSurfacePressureFvPatchScalarField : fixedValueFvPatchScalarField(wspsf, iF), phiName_(wspsf.phiName_), - rhoName_(wspsf.rhoName_), zetaName_(wspsf.zetaName_), - zeta0_(wspsf.zeta0_), - curTimeIndex_(wspsf.curTimeIndex_) + rhoName_(wspsf.rhoName_) {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -void Foam::waveSurfacePressureFvPatchScalarField::autoMap -( - const fvPatchFieldMapper& m -) -{ - fixedValueFvPatchScalarField::autoMap(m); - zeta0_.autoMap(m); -} - - -void Foam::waveSurfacePressureFvPatchScalarField::rmap -( - const fvPatchScalarField& ptf, - const labelList& addr -) -{ - fixedValueFvPatchScalarField::rmap(ptf, addr); - - const waveSurfacePressureFvPatchScalarField& wspsf = - refCast(ptf); - - zeta0_.rmap(wspsf.zeta0_, addr); -} - - void Foam::waveSurfacePressureFvPatchScalarField::updateCoeffs() { if (updated()) @@ -153,65 +146,90 @@ void Foam::waveSurfacePressureFvPatchScalarField::updateCoeffs() return; } - const scalar dt = db().time().deltaTValue(); - const scalar timeI = db().time().timeIndex(); - const scalar patchI = patch().index(); + const label patchI = patch().index(); + const scalar dt = db().time().deltaTValue(); + + // retrieve non-const access to zeta field from the database volVectorField& zeta = const_cast ( db().lookupObject(zetaName_) ); - vectorField& zetap = zeta.boundaryField()[patchI]; - if (curTimeIndex_ != timeI) - { - zeta0_ = zetap; - curTimeIndex_ = timeI; - } + // lookup d/dt scheme from database for zeta + const word ddtSchemeName(zeta.mesh().ddtScheme(zeta.name())); + timeSchemeType timeScheme(timeSchemeTypeNames_[ddtSchemeName]); - const surfaceScalarField& phi = - db().lookupObject(phiName_); - - const scalarField& phip = phi.boundaryField()[patchI]; - - const uniformDimensionedVectorField& g = - db().lookupObject("g"); + // retrieve the flux field from the database + const scalarField& phip = + patch().lookupPatchField(phiName_); + // cache the patch face-normal vectors tmp nf(patch().nf()); - if (phi.dimensions() == dimVelocity*dimArea) - { - zetap = zeta0_ + nf()*dt*phip/patch().magSf(); + // change in zeta due to flux + vectorField dZetap(dt*nf()*phip/patch().magSf()); - operator==(-g.value() & zetap); - } - else if (phi.dimensions() == dimDensity*dimVelocity*dimArea) + if (phi.dimensions() == dimDensity*dimVelocity*dimArea) { const scalarField& rhop = patch().lookupPatchField(rhoName_); - zetap = zeta0_ + nf()*dt*phip/rhop/patch().magSf(); - - operator==(-rhop*(g.value() & zetap)); + dZetap /= rhop; } - else + + switch (timeScheme) { - FatalErrorIn - ( - "waveSurfacePressureFvPatchScalarField::updateCoeffs()" - ) - << "dimensions of phi are incorrect" << nl - << " on patch " << this->patch().name() - << " of field " << this->dimensionedInternalField().name() - << " in file " << this->dimensionedInternalField().objectPath() - << exit(FatalError); + case tsEuler: + case tsCrankNicholson: + { + zetap = zeta.oldTime().boundaryField()[patchI] + dZetap; + + break; + } + case tsBackward: + { + scalar dt0 = db().time().deltaT0Value(); + + scalar c = 1.0 + dt/(dt + dt0); + scalar c00 = dt*dt/(dt0*(dt + dt0)); + scalar c0 = c + c00; + + zetap = + ( + c0*zeta.oldTime().boundaryField()[patchI] + - c00*zeta.oldTime().oldTime().boundaryField()[patchI] + + dZetap + )/c; + + break; + } + default: + { + FatalErrorIn + ( + "waveSurfacePressureFvPatchScalarField::updateCoeffs()" + ) << " Unsupported temporal differencing scheme : " + << ddtSchemeName << nl + << " on patch " << this->patch().name() + << " of field " << this->dimensionedInternalField().name() + << " in file " << this->dimensionedInternalField().objectPath() + << abort(FatalError); + } } - Info<< "min/max(zetap) = " << gMin(zetap & nf()) << ", " + + Info<< "min/max zetap = " << gMin(zetap & nf()) << ", " << gMax(zetap & nf()) << endl; + // update the surface pressure + const uniformDimensionedVectorField& g = + db().lookupObject("g"); + + operator==(-g.value() & zetap); + fixedValueFvPatchScalarField::updateCoeffs(); } @@ -220,8 +238,8 @@ void Foam::waveSurfacePressureFvPatchScalarField::write(Ostream& os) const { fvPatchScalarField::write(os); writeEntryIfDifferent(os, "phi", "phi", phiName_); - writeEntryIfDifferent(os, "rho", "rho", rhoName_); writeEntryIfDifferent(os, "zeta", "zeta", zetaName_); + writeEntryIfDifferent(os, "rho", "rho", zetaName_); writeEntry("value", os); } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index f80e25dae2..567b17dde7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenCFD Ltd. \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,22 +25,34 @@ Class Foam::waveSurfacePressureFvPatchScalarField Description - Applies the surface wave pressure, based on the wave height + This is a pressure boundary condition, whose value is calculated as + the hydrostatic pressure based on a given displacement: - p = -rho.g.zeta + \f[ + p = -rho*g*zeta + \f] - Where + where + \var g = acceleration due to gravity [m/s2] + \var zeta = wave amplitude [m] - p = pressure - kinematic of dynamic depending on the flux units - zeta = wave height vector [m] - g = acceleration due to gravity [m/s2] - - - Note: - - This boundary also updates the wave height boundary field, which - is accessed via lookup from the database + The wave amplitude is updated as part of the calculation, derived from the + local volumetric flux. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type waveSurfacePressure; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + zeta zeta; // name amplitude field (default = zeta) + value uniform 0; // place holder + } + \endverbatim + The density field is only required if the flux is mass-based as opposed to + volumetric-based. SourceFiles waveSurfacePressureFvPatchScalarField.C @@ -51,6 +63,7 @@ SourceFiles #define waveSurfacePressureFvPatchScalarField_H #include "fixedValueFvPatchFields.H" +#include "NamedEnum.H" // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // @@ -65,22 +78,34 @@ class waveSurfacePressureFvPatchScalarField : public fixedValueFvPatchScalarField { +public: + + // Public data + + //- Enumeration defining the available time schemes + enum timeSchemeType + { + tsEuler, + tsCrankNicholson, + tsBackward + }; + + +private: + // Private data //- Flux field name word phiName_; - //- Density field name (if compressible) - word rhoName_; - //- Wave height field name word zetaName_; - //- Old-time zeta patch value - vectorField zeta0_; + //- Density field for mass-based flux evaluations + word rhoName_; - //- Current time index used to store ms0_ - label curTimeIndex_; + //- Time scheme type names + static const NamedEnum timeSchemeTypeNames_; public: @@ -153,22 +178,6 @@ public: // Member functions - // Mapping functions - - //- Map (and resize as needed) from self given a mapping object - virtual void autoMap - ( - const fvPatchFieldMapper& - ); - - //- Reverse map the given fvPatchField onto this fvPatchField - virtual void rmap - ( - const fvPatchScalarField&, - const labelList& - ); - - // Evaluation functions //- Update the coefficients associated with the patch field From 13c6fed85bb3692f7a3edd4d76e904fd647378f0 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 17:29:20 +0100 Subject: [PATCH 011/109] STYLE: minor code formatting --- .../basic/coupled/coupledFvPatchField.H | 4 +-- .../codedFixedValueFvPatchField.H | 28 +++++++++---------- .../codedMixed/codedMixedFvPatchField.H | 10 +++---- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H index 8677c34ed3..eaf7bc51ea 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H @@ -25,7 +25,7 @@ Class Foam::coupledFvPatchField Description - Foam::coupledFvPatchField + Abstract base class for coupled patches. SourceFiles coupledFvPatchField.C @@ -45,7 +45,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class coupledFvPatch Declaration + Class coupledFvPatch Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 56fef9354e..e5aa2621ac 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,7 +34,7 @@ Description { type codedFixedValue; value uniform 0; - redirectType rampedFixedValue; // name of generated bc + redirectType rampedFixedValue; // name of generated BC code #{ @@ -54,17 +54,17 @@ Description \endverbatim A special form is if the 'code' section is not supplied. In this case - the code gets read from a (runTimeModifiable!) dictionary system/codeDict - which would have a corresponding entry + the code is read from a (runTimeModifiable!) dictionary system/codeDict + which would have a corresponding entry: \verbatim - rampedFixedValue - { - code - #{ - operator==(min(10, 0.1*this->db().time().value())); - #}; - } + rampedFixedValue + { + code + #{ + operator==(min(10, 0.1*this->db().time().value())); + #}; + } \endverbatim SeeAlso @@ -92,7 +92,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedFixedValueFvPatch Declaration + Class codedFixedValueFvPatch Declaration \*---------------------------------------------------------------------------*/ template @@ -110,6 +110,7 @@ class codedFixedValueFvPatchField mutable autoPtr > redirectPatchFieldPtr_; + // Private Member Functions const IOdictionary& dict() const; @@ -132,6 +133,7 @@ class codedFixedValueFvPatchField // Get the dictionary to initialize the codeContext virtual const dictionary& codeDict() const; + public: // Static data members @@ -209,8 +211,6 @@ public: } - - // Member functions //- Get reference to the underlying patch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 2b7c97478e..a24326317d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,7 +34,7 @@ Description { type codedMixed; value uniform 0; - redirectType rampedMixed; // name of generated bc + redirectType rampedMixed; // name of generated BC code #{ @@ -96,7 +96,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedMixedFvPatch Declaration + Class codedMixedFvPatch Declaration \*---------------------------------------------------------------------------*/ template @@ -114,6 +114,7 @@ class codedMixedFvPatchField mutable autoPtr > redirectPatchFieldPtr_; + // Private Member Functions const IOdictionary& dict() const; @@ -136,6 +137,7 @@ class codedMixedFvPatchField // Get the dictionary to initialize the codeContext virtual const dictionary& codeDict() const; + public: // Static data members @@ -213,8 +215,6 @@ public: } - - // Member functions //- Get reference to the underlying patchField From 9427c5d32d9e6100080bd2a23ca4bb5d209e56d9 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 17:37:38 +0100 Subject: [PATCH 012/109] ENH: took code out of Foam namespace and apply Foam:: prefix instead --- .../cyclicSlip/cyclicSlipFvPatchField.C | 21 ++++++------------- .../cyclicSlip/cyclicSlipFvPatchField.H | 18 ++++++++++++---- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.C b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.C index 2d995bdd6e..953a59b820 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.C +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,15 +25,10 @@ License #include "cyclicSlipFvPatchField.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -namespace Foam -{ - // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // template -cyclicSlipFvPatchField::cyclicSlipFvPatchField +Foam::cyclicSlipFvPatchField::cyclicSlipFvPatchField ( const fvPatch& p, const DimensionedField& iF @@ -44,7 +39,7 @@ cyclicSlipFvPatchField::cyclicSlipFvPatchField template -cyclicSlipFvPatchField::cyclicSlipFvPatchField +Foam::cyclicSlipFvPatchField::cyclicSlipFvPatchField ( const cyclicSlipFvPatchField& ptf, const fvPatch& p, @@ -57,7 +52,7 @@ cyclicSlipFvPatchField::cyclicSlipFvPatchField template -cyclicSlipFvPatchField::cyclicSlipFvPatchField +Foam::cyclicSlipFvPatchField::cyclicSlipFvPatchField ( const fvPatch& p, const DimensionedField& iF, @@ -69,7 +64,7 @@ cyclicSlipFvPatchField::cyclicSlipFvPatchField template -cyclicSlipFvPatchField::cyclicSlipFvPatchField +Foam::cyclicSlipFvPatchField::cyclicSlipFvPatchField ( const cyclicSlipFvPatchField& ptf ) @@ -79,7 +74,7 @@ cyclicSlipFvPatchField::cyclicSlipFvPatchField template -cyclicSlipFvPatchField::cyclicSlipFvPatchField +Foam::cyclicSlipFvPatchField::cyclicSlipFvPatchField ( const cyclicSlipFvPatchField& ptf, const DimensionedField& iF @@ -89,8 +84,4 @@ cyclicSlipFvPatchField::cyclicSlipFvPatchField {} -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -} // End namespace Foam - // ************************************************************************* // diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 89306747b8..350e71a618 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -25,7 +25,19 @@ Class Foam::cyclicSlipFvPatchField Description - Foam::cyclicSlipFvPatchField + This boundary condition is a light wrapper around the cyclicFvPatchField + condition, providing no new functionality. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type cyclicSlip; + } + \endverbatim + +SeeAlso + Foam::cyclicFvPatchField SourceFiles cyclicSlipFvPatchField.C @@ -44,7 +56,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class cyclicSlipFvPatch Declaration + Class cyclicSlipFvPatchField Declaration \*---------------------------------------------------------------------------*/ template @@ -52,7 +64,6 @@ class cyclicSlipFvPatchField : public cyclicFvPatchField { - // Private data public: @@ -119,7 +130,6 @@ public: new cyclicSlipFvPatchField(*this, iF) ); } - }; From 62889245007c415cfcd3d3fb7a212e51fc787f10 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 5 Jul 2012 18:01:20 +0100 Subject: [PATCH 013/109] ENH: Boundary condition doxygen documentation updates --- .../directionMixedFvPatchField.H | 6 +-- .../fixedGradient/fixedGradientFvPatchField.H | 26 +++++++++++-- .../constraint/cyclic/cyclicFvPatchField.H | 18 ++++++++- .../cyclicAMI/cyclicAMIFvPatchField.H | 17 +++++++- .../constraint/empty/emptyFvPatchField.H | 17 ++++++-- .../codedFixedValueFvPatchField.H | 2 +- .../codedMixed/codedMixedFvPatchField.H | 2 +- ...lindricalInletVelocityFvPatchVectorField.H | 19 ++++----- .../derived/fan/fanFvPatchField.H | 32 +++++++-------- .../fanPressureFvPatchScalarField.H | 14 ++++--- .../fixedFluxPressureFvPatchScalarField.H | 29 +++++++++++--- .../fixedInternalValueFvPatchField.H | 22 +++++++++-- .../derived/fixedJump/fixedJumpFvPatchField.H | 9 +++-- .../fixedNormalSlipFvPatchField.H | 15 +++++-- ...ysisTemperatureCoupledFvPatchScalarField.H | 35 +++++++++++++---- ...rolysisVelocityCoupledFvPatchVectorField.H | 33 +++++++++++++--- ...ilmHeightInletVelocityFvPatchVectorField.H | 33 ++++++++++++++-- ...allHeatFluxTemperatureFvPatchScalarField.H | 39 ++++++++++++------- .../epsilonWallFunctionFvPatchScalarField.H | 27 +++++++++++-- 19 files changed, 299 insertions(+), 96 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H index 0199838eab..b7298b5a18 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,7 @@ Class Foam::directionMixedFvPatchField Description - Foam::directionMixedFvPatchField + Base class for direction-mixed boundary conditions. SourceFiles directionMixedFvPatchField.C @@ -43,7 +43,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class directionMixedFvPatch Declaration + Class directionMixedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index cdf83f486a..4eeda602a2 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,27 @@ Class Foam::fixedGradientFvPatchField Description - Foam::fixedGradientFvPatchField + This boundary condition supplies a fixed gradient condition, such that + the patch values are calculated using: + + \f[ + values = int + gradient/delta + \f] + + where + \var values = patch values + \var int = internal field values + \var gradient = gradient (user-specified) + \var delta = inverse distance from patch face centre to cell centre + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedGradient; + gradient uniform 0; + } + \endverbatim SourceFiles fixedGradientFvPatchField.C @@ -43,7 +63,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedGradientFvPatch Declaration + Class fixedGradientFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index c3ba07477d..4ccafd8593 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -25,7 +25,21 @@ Class Foam::cyclicFvPatchField Description - Foam::cyclicFvPatchField + This boundary condition enforces a cyclic condition between a pair of + boundaries. + + \note + The patches must be topologically similar, i.e. if the owner patch is + transformed to the neighbour patch, the patches should be identical (or + very similar). + + Example of the boundary condition specification: + \verbatim + myPatch + { + type cyclic; + } + \endverbatim SourceFiles cyclicFvPatchField.C @@ -45,7 +59,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class cyclicFvPatch Declaration + Class cyclicFvPatch Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index 933a865f30..b80ac1fd54 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -25,7 +25,22 @@ Class Foam::cyclicAMIFvPatchField Description - Foam::cyclicAMIFvPatchField + This boundary condition enforces a cyclic condition between a pair of + boundaries, whereby communication between the patches is performed using + an arbitrary mesh interface (AMI) interpolation. + + \note + The outer boundary of the patch pairs must be similar, i.e. if the owner + patch is transformed to the neighbour patch, the outer perimiter of each + patch should be identical (or very similar). + + Example of the boundary condition specification: + \verbatim + myPatch + { + type cyclicAMI; + } + \endverbatim SourceFiles cyclicAMIFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index dd76378011..f3a52d9fcf 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,18 @@ Class Foam::emptyFvPatchField Description - Foam::emptyFvPatchField + This boundary condition provides an 'empty' condition for reduced + dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to + patches whose normal is aligned to geometric directions that do not + constitue solution directions. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type empty; + } + \endverbatim SourceFiles emptyFvPatchField.C @@ -44,7 +55,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class emptyFvPatch Declaration + Class emptyFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index e5aa2621ac..6bf3cb06ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -92,7 +92,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedFixedValueFvPatch Declaration + Class codedFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index a24326317d..c2841cd239 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -96,7 +96,7 @@ class dynamicCodeContext; class IOdictionary; /*---------------------------------------------------------------------------*\ - Class codedMixedFvPatch Declaration + Class codedMixedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index de15affbc7..d5c6f8e489 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -26,8 +26,9 @@ Class Foam::cylindricalInletVelocityFvPatchVectorField Description - Describes an inlet vector boundary condition in cylindrical coordinates - given a central axis, central point, rpm, axial and radial velocity. + This boundary condition describes an inlet vector boundary condition in + cylindrical co-ordinates given a central axis, central point, rpm, axial + and radial velocity. Example of the boundary condition specification: \verbatim @@ -36,15 +37,15 @@ Description type cylindricalInletVelocity; axis (0 0 1); centre (0 0 0); - axialVelocity constant 30; - radialVelocity constant -10; - rpm constant 100; + axialVelocity constant 30; // axial velocity [m/s] + radialVelocity constant -10; // radial velocity [m/s] + rpm constant 100; // revolutions per minute } \endverbatim - The axialVelocity, radialVelocity and rpm entries are DataEntry types, able - to describe time varying functions. The example above gives the usage for - supplying constant values. + The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry + types, able to describe time varying functions. The example above gives + the usage for supplying constant values. SourceFiles cylindricalInletVelocityFvPatchVectorField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index b3799c2bd9..bad95b3a7f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -25,17 +25,20 @@ Class Foam::fanFvPatchField Description - Jump boundary condition. Operates on cyclic. Jump specified as a DataEntry. - (table, fileTable, csv etc.) + This boundary condition supplies a jump condition, using the \c cyclic + condition as a base. + + The jump is specified as a \c DataEntry type, to enable the use of, e.g. + contant, polynomial, table values. Example of the boundary condition specification: \verbatim - fan_half0 + myPatch { type fan; - patchType cyclic; - jump uniform 0; - jumpTable csvFile; + patchType cyclic; // specify \c cyclic + jump uniform 0; // current jump value + jumpTable csvFile; // jump specification csvFileCoeffs { hasHeaderLine 1; @@ -48,20 +51,13 @@ Description } \endverbatim + The above example shows the use of a CSV file to specify the jump. - Backwards compatibility: if the 'f' keyword is detected it assumes - it is a power of the flowrate. + \note + The underlying \c patchType should be set to \c cyclic - \verbatim - fan_half0 - { - type fan; - patchType cyclic; - jump uniform 0; - f 2(100 -0.1); - value uniform 0; - } - \endverbatim +SeeAlso + Foam::DataEntry SourceFiles fanFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index 9720684193..ed3b1c0237 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,12 +25,13 @@ Class Foam::fanPressureFvPatchScalarField Description - Assigns pressure inlet or outlet total pressure condition for a fan. + This boundary condition can be applied to assign either a pressure inlet + or outlet total pressure condition for a fan. User specifies: - - pressure drop vs volumetric flow rate table (fan curve) file name; - - direction of normal flow through the fan, in or out; - - total pressure of the environment. + \li pressure drop vs volumetric flow rate table (fan curve) file name; + \li direction of normal flow through the fan, in or out; + \li total pressure of the environment. Example of the boundary condition specification: \verbatim @@ -56,7 +57,8 @@ Description \endverbatim See Also - Foam::totalPressureFvPatchScalarField and + Foam::fanFvPatchField + Foam::totalPressureFvPatchScalarField Foam::interpolationTable SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index de8f837abd..8fbe5091b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -25,14 +25,31 @@ Class Foam::fixedFluxPressureFvPatchScalarField Description - Adjusts the pressure gradient such that the flux on the boundary is that - specified by the velocity boundary condition. + This boundary condition adjusts the pressure gradient such that the flux + on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as (phi - phiHbyA), both of which are looked-up from the database as is - the pressure diffusivity Dp used to calculate the gradient. + as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as + is the pressure diffusivity \c Dp used to calculate the gradient using: - The names of the phi, phiHbyA and Dp fields may be optionally specified. + \f[ + grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} + \f] + + where + \var Sf = patch face areas + + Example of the boundary condition specification: + \verbatim + myPatch + { + type externalWallHeatFluxTemperature; + phiHbyA phiHbyA; // predicted flux field (default = phiHbyA) + phi phi; // flux field (default = phi) + rho rho; // density field (default = rho) + Dp Dp; // pressure diffusivity field (default = Dp) + } + \endverbatim SourceFiles fixedFluxPressureFvPatchScalarField.C @@ -52,7 +69,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedFluxPressureFvPatch Declaration + Class fixedFluxPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class fixedFluxPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index cd27459a94..10fac6b767 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,10 +25,26 @@ Class Foam::fixedInternalValueFvPatchField Description - Boundary condition providing mechanism to set boundary (cell) values - directly into a matrix, i.e. to set a constraint condition. Default + This boundary condition provides a mechanism to set boundary (cell) values + directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedInternalValue; + vakue uniform 0; // place holder + } + \endverbatim + + This is used as a base for conditions such as the turbulence \c epsilon + wall function, which applies a near-wall constraint for high Reynolds + number flows. + +SeeAlso + Foam::epsilonWallFunctionFvPatchScalarField + SourceFiles fixedInternalValueFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index c746b975cf..2bca8d534b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,11 @@ Class Foam::fixedJumpFvPatchField Description - Base class for "jump" of a field + Base class for "jump" of a field - not used directly + +SeeAlso + Foam::fanFvPatchScalarField + Foam::fanPressureFvPatchScalarField SourceFiles fixedJumpFvPatchField.C @@ -62,7 +66,6 @@ protected: public: - // Constructors //- Construct from patch and internal field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 3a59c98f4e..94cc081b4e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,16 @@ Class Foam::fixedNormalSlipFvPatchField Description - Foam::fixedNormalSlipFvPatchField + This boundary condition sets the patch-normal component to a fixed value. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedNormalSlip; + fixedValue uniform 0; // example entry for a scalar field + } + \endverbatim SourceFiles fixedNormalSlipFvPatchField.C @@ -43,7 +52,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedNormalSlipFvPatch Declaration + Class fixedNormalSlipFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H index 5f3446c182..503b023f95 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,12 +25,33 @@ Class Foam::filmPyrolysisTemperatureCoupledFvPatchScalarField Description - Temperature boundary condition for patches on the primary region: + This boundary condition is designed to be used in conjunction with surface + film and pyrolysis modelling. It provides a temperature boundary condition + for patches on the primary region based on whether the patch is seen to + be 'wet', specified by: - - where the film height > height threshold value: - apply film surface temperature values - - else - apply pyrolysis surface temperature values + \f[ + delta > delta_wet + \f] + + where + \var delta = film height [m] + \var delta_wet = film height above which the surface is considered wet + + \li if the patch is wet, the temperature is set using the film temperature + \li otherwise, it is set using pyrolysis temperature + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmPyrolysisTemperatureCoupled; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaWet 1e-4; // threshold height for 'wet' film + value uniform 300; // initial temperature / [K] + } + \endverbatim SourceFiles filmPyrolysisTemperatureCoupledFvPatchScalarField.C @@ -63,7 +84,7 @@ class filmPyrolysisTemperatureCoupledFvPatchScalarField //- Name of density field word rhoName_; - //- Film height threshold beyond which it is considered 'wet' + //- Film height threshold beyond which it is considered 'wet' [m] scalar deltaWet_; diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H index 8b654ec168..c7c4c5d24b 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,12 +25,33 @@ Class Foam::filmPyrolysisVelocityCoupledFvPatchVectorField Description - Velocity boundary condition for patches on the primary region: + This boundary condition is designed to be used in conjunction with surface + film and pyrolysis modelling. It provides a velocity boundary condition + for patches on the primary region based on whether the patch is seen to + be 'wet', specified by: - - where the film height > height threshold value: - apply film surface velocity values - - else - apply pyrolysis out-gassing velocity values + \f[ + delta > delta_wet + \f] + + where + \var delta = film height [m] + \var delta_wet = film height above which the surface is considered wet + + \li if the patch is wet, the velocity is set using the film velocity + \li otherwise, it is set using pyrolysis out-gassing velocity + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmPyrolysisVelocityCoupled; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaWet 1e-4; // threshold height for 'wet' film + value uniform (0 0 0); // initial velocity / [m/s] + } + \endverbatim SourceFiles filmPyrolysisVelocityCoupledFvPatchVectorField.C diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 194861cd92..571b597204 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,9 +25,34 @@ Class Foam::filmHeightInletVelocityFvPatchVectorField Description - Velocity inlet boundary condition for patches where the film height is - specified. The inflow velocity is obtained from the flux with a direction - normal to the patch faces. + This boundary condition is designed to be used in conjunction with + surface film modelling. It provides a velocity inlet boundary condition + for patches where the film height is specified. The inflow velocity is + obtained from the flux with a direction normal to the patch faces using: + + \f[ + Up = \frac{n*phi}{rho*mag(Sf)*delta} + \f] + + where + \var Up = patch velocity [m/s] + \var n = patch normal vector + \var phi = mass flux [kg/s] + \var rho = density [kg/m3] + \var Sf = patch face area vectors [m2] + \var delta = film height [m] + + Example of the boundary condition specification: + \verbatim + myPatch + { + type filmHeightInletVelocity; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + deltaf deltaf; // name of height field (default = deltaf) + value uniform (0 0 0); // initial velocity / [m/s] + } + \endverbatim SourceFiles filmHeightInletVelocityFvPatchVectorField.C diff --git a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 9b461334cb..1230136b73 100644 --- a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,26 +25,38 @@ Class externalWallHeatFluxTemperatureFvPatchScalarField Description - Heat flux boundary condition for temperature on external wall. + This boundary condition supplies a heat flux condition for temperature + on an external wall. - If h and Ta are specified then fixed_heat_transfer_coefficient mode is used - If q is specified then fixed_heat_flux is used. + The condition can operate in two modes: + \li fixed heat transfer coefficient: supply h and Ta + \li fixed heat flux: supply q - Example usage: - myWallPatch + where + \var h = heat transfer coefficient [W/m2/K] + \var Ta = ambient temperature [K] + \var q = heat flux [W/m2] + + The thermal conductivity, \c kappa, can either be retrieved from the + mesh database using the \c lookup option, or from a \c solidThermo + thermophysical package. + + Example of the boundary condition specification: + \verbatim + myPatch { type externalWallHeatFluxTemperature; kappa solidThermo; // solidThermo or lookup - q uniform 1000; // Heat flux / [W/m2] - Ta uniform 300.0; // Tambient temperature /[K] - h uniform 10.0; // Heat transfer coeff /[W/Km2] - value uniform 300.0; // Initial temperature / [K] + q uniform 1000; // heat flux / [W/m2] + Ta uniform 300.0; // ambient temperature /[K] + h uniform 10.0; // heat transfer coeff /[W/Km2] + value uniform 300.0; // initial temperature / [K] kappaName none; } + \endverbatim -Note: - Only the pair h, Ta or q can be specified in the dictionary. - + \note + Only supply \h an \c Ta, or \c q in the dictionary (see above) SourceFiles externalWallHeatFluxTemperatureFvPatchScalarField.C @@ -178,6 +190,7 @@ public: //- Update the coefficients associated with the patch field virtual void updateCoeffs(); + // I-O //- Write diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index b95f74dd92..f7649261c3 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -25,9 +25,29 @@ Class Foam::incompressible::RASModels::epsilonWallFunctionFvPatchScalarField Description - Boundary condition for epsilon when using wall functions - - calculates epsilon and G - - epsilon values added directly into the matrix to act as a constraint + This boundary condition provides a turbulence dissipation wall function + condition for high Reynolds number, turbulent flow cases. + + The condition can be applied to wall boundaries, whereby it + \li calculates \c epsilon and \c G + \li inserts near wall epsilon values directly into the epsilon equation + to act as a constraint + + where + \var epsilon = turblence dissipation field + \var G = turblence generation field + + Example of the boundary condition specification: + \verbatim + myPatch + { + type epsilonWallFunction; + G G; // turblence generation field (default = G) + Cmu 0.09; // Cmu model coefficient (default = 0.09) + kappa 0.41; // Von Karman constant (default = 0.41) + E 9.8; // E coefficient (default = 9.8) + } + \endverbatim SourceFiles epsilonWallFunctionFvPatchScalarField.C @@ -72,7 +92,6 @@ protected: //- E coefficient scalar E_; - //- Y+ at the edge of the laminar sublayer scalar yPlusLam_; From 50965fe65e01e24c7e0c0b10842d87e2b3b4eaa0 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 14:44:59 +0100 Subject: [PATCH 014/109] ENH: Enabled both compressible and incompressible usage for the fixedShearStress BC --- .../derivedFvPatchFields/Make/files | 1 + .../fixedShearStressFvPatchVectorField.C | 111 +++++++++++------- .../fixedShearStressFvPatchVectorField.H | 12 +- .../incompressible/RAS/Make/files | 1 - 4 files changed, 76 insertions(+), 49 deletions(-) rename src/turbulenceModels/{incompressible/RAS => }/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C (54%) rename src/turbulenceModels/{incompressible/RAS => }/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H (94%) diff --git a/src/turbulenceModels/derivedFvPatchFields/Make/files b/src/turbulenceModels/derivedFvPatchFields/Make/files index 360b593edb..f0a5fdfa8a 100644 --- a/src/turbulenceModels/derivedFvPatchFields/Make/files +++ b/src/turbulenceModels/derivedFvPatchFields/Make/files @@ -1,3 +1,4 @@ porousBafflePressure/porousBafflePressureFvPatchFields.C +fixedShearStress/fixedShearStressFvPatchVectorField.C LIB = $(FOAM_LIBBIN)/libturbulenceDerivedFvPatchFields diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C similarity index 54% rename from src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C rename to src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C index c5a2c5f8e8..0f1d19bb2e 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C @@ -28,28 +28,25 @@ License #include "addToRunTimeSelectionTable.H" #include "fvPatchFieldMapper.H" #include "volFields.H" -#include "RASModel.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -namespace Foam -{ -namespace incompressible -{ +#include "incompressible/RAS/RASModel/RASModel.H" +#include "compressible/RAS/RASModel/RASModel.H" // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField +Foam::fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ( const fvPatch& p, const DimensionedField& iF ) : fixedValueFvPatchVectorField(p, iF), + phiName_("phi"), + rhoName_("rho"), tau0_(vector::zero) {} -fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField +Foam::fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ( const fvPatch& p, const DimensionedField& iF, @@ -57,13 +54,15 @@ fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ) : fixedValueFvPatchVectorField(p, iF), + phiName_(dict.lookupOrDefault("phi", "phi")), + rhoName_(dict.lookupOrDefault("rho", "rho")), tau0_(dict.lookupOrDefault("tau", vector::zero)) { fvPatchField::operator=(patchInternalField()); } -fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField +Foam::fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ( const fixedShearStressFvPatchVectorField& ptf, const fvPatch& p, @@ -72,76 +71,102 @@ fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ) : fixedValueFvPatchVectorField(ptf, p, iF, mapper), + phiName_(ptf.phiName_), + rhoName_(ptf.rhoName_), tau0_(ptf.tau0_) {} -fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField +Foam::fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ( const fixedShearStressFvPatchVectorField& ptf ) : fixedValueFvPatchVectorField(ptf), + phiName_(ptf.phiName_), + rhoName_(ptf.rhoName_), tau0_(ptf.tau0_) {} -fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField +Foam::fixedShearStressFvPatchVectorField::fixedShearStressFvPatchVectorField ( const fixedShearStressFvPatchVectorField& ptf, const DimensionedField& iF ) : fixedValueFvPatchVectorField(ptf, iF), + phiName_(ptf.phiName_), + rhoName_(ptf.rhoName_), tau0_(ptf.tau0_) {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -void fixedShearStressFvPatchVectorField::updateCoeffs() +void Foam::fixedShearStressFvPatchVectorField::updateCoeffs() { if (updated()) { return; } - const label patchi = patch().index(); + const label patchI = patch().index(); - const turbulenceModel& turbModel = - db().lookupObject("turbulenceModel"); + const surfaceScalarField& phi = + db().lookupObject(phiName_); - const fvPatchVectorField& Uw = turbModel.U().boundaryField()[patchi]; + scalarField nuEff; + if (phi.dimensions() == dimVelocity*dimArea) + { + const incompressible::turbulenceModel& turbModel = + db().lookupObject + ( + "turbulenceModel" + ); - const vectorField Ui(Uw.patchInternalField()); + nuEff = turbModel.nuEff()()[patchI]; + } + else if (phi.dimensions() == dimDensity*dimVelocity*dimArea) + { + const compressible::turbulenceModel& turbModel = + db().lookupObject + ( + "turbulenceModel" + ); + + const fvPatchField& rhop = + patch().lookupPatchField(rhoName_); + + nuEff = turbModel.muEff()()[patchI]/rhop; + } + else + { + FatalErrorIn("fixedShearStressFvPatchVectorField::updateCoeffs()") + << "dimensions of phi are not correct" + << "\n on patch " << this->patch().name() + << " of field " << this->dimensionedInternalField().name() + << " in file " << this->dimensionedInternalField().objectPath() + << exit(FatalError); + } + + const vectorField Uc(patchInternalField()); vector tauHat = tau0_/(mag(tau0_) + ROOTVSMALL); const scalarField& ry = patch().deltaCoeffs(); - tmp tnuEff = turbModel.nuEff(); - const volScalarField& nuEff = tnuEff(); - const scalarField& nuEffw = nuEff.boundaryField()[patchi]; - - tmp UwUpdated = - tauHat*(tauHat & (tau0_*(1.0/(ry*nuEffw)) + Ui)); - - operator==(UwUpdated); - - if (debug) - { - tmp nHat = this->patch().nf(); - volSymmTensorField Reff(turbModel.devReff()); - Info << "tau : " << (nHat & Reff.boundaryField()[patchi])() << endl; - } + operator==(tauHat*(tauHat & (tau0_*(1.0/(ry*nuEff)) + Uc))); fixedValueFvPatchVectorField::updateCoeffs(); } -void fixedShearStressFvPatchVectorField::write(Ostream& os) const +void Foam::fixedShearStressFvPatchVectorField::write(Ostream& os) const { fixedValueFvPatchVectorField::write(os); + writeEntryIfDifferent(os, "phi", "phi", phiName_); + writeEntryIfDifferent(os, "rho", "rho", rhoName_); os.writeKeyword("tau") << tau0_ << token::END_STATEMENT << nl; writeEntry("value", os); } @@ -149,15 +174,13 @@ void fixedShearStressFvPatchVectorField::write(Ostream& os) const // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -makePatchTypeField -( - fvPatchVectorField, - fixedShearStressFvPatchVectorField -); - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -} // End namespace incompressible -} // End namespace Foam +namespace Foam +{ + makePatchTypeField + ( + fvPatchVectorField, + fixedShearStressFvPatchVectorField + ); +} // ************************************************************************* // diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H similarity index 94% rename from src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H rename to src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H index 6bbcf8c9c6..13b16e86d2 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -43,8 +43,7 @@ SourceFiles namespace Foam { -namespace incompressible -{ + /*---------------------------------------------------------------------------*\ Class fixedShearStressFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ @@ -55,6 +54,12 @@ class fixedShearStressFvPatchVectorField { // Private data + //- Name of flux field (default = phi) + const word phiName_; + + //- Name of density field (default = rho) + const word rhoName_; + //- Constant shear stress const vector tau0_; @@ -138,7 +143,6 @@ public: // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -} // End namespace incompressible } // End namespace Foam // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/turbulenceModels/incompressible/RAS/Make/files b/src/turbulenceModels/incompressible/RAS/Make/files index b76fb0c411..ce75d38346 100644 --- a/src/turbulenceModels/incompressible/RAS/Make/files +++ b/src/turbulenceModels/incompressible/RAS/Make/files @@ -51,7 +51,6 @@ $(kappatWallFunctions)/kappatJayatillekeWallFunction/kappatJayatillekeWallFuncti derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.C derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.C -derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.C derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.C From 1b59f2993b881364162bdc829fe0dd26f23ec454 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 14:47:04 +0100 Subject: [PATCH 015/109] BUG: corrected compressible usage for waveSurfacePressure BC --- .../waveSurfacePressureFvPatchScalarField.C | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C index b094aff2b3..fe4ddd3357 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C @@ -163,14 +163,14 @@ void Foam::waveSurfacePressureFvPatchScalarField::updateCoeffs() timeSchemeType timeScheme(timeSchemeTypeNames_[ddtSchemeName]); // retrieve the flux field from the database - const scalarField& phip = - patch().lookupPatchField(phiName_); + const surfaceScalarField& phi = + db().lookupObject(phiName_); // cache the patch face-normal vectors tmp nf(patch().nf()); // change in zeta due to flux - vectorField dZetap(dt*nf()*phip/patch().magSf()); + vectorField dZetap(dt*nf()*phi.boundaryField()[patchI]/patch().magSf()); if (phi.dimensions() == dimDensity*dimVelocity*dimArea) { From 96179eb560ce964d0fce19322b755b1cda5fa92f Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 14:47:51 +0100 Subject: [PATCH 016/109] BUG: Corrected typos --- .../activeBaffleVelocityFvPatchVectorField.C | 2 +- .../activePressureForceBaffleVelocityFvPatchVectorField.C | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C index 6bbc455afa..3b3667bbb5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.C @@ -292,7 +292,7 @@ void Foam::activeBaffleVelocityFvPatchVectorField::updateCoeffs() void Foam::activeBaffleVelocityFvPatchVectorField::write(Ostream& os) const { fvPatchVectorField::write(os); - writeEntryIfDifferent(os, "p", "p", pName_) + writeEntryIfDifferent(os, "p", "p", pName_); os.writeKeyword("cyclicPatch") << cyclicPatchName_ << token::END_STATEMENT << nl; os.writeKeyword("orientation") diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C index c69b5871f0..18321c9013 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C @@ -354,7 +354,7 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField:: write(Ostream& os) const { fvPatchVectorField::write(os); - writeEntryIfDifferent(os, "p", "p", pName_) + writeEntryIfDifferent(os, "p", "p", pName_); os.writeKeyword("cyclicPatch") << cyclicPatchName_ << token::END_STATEMENT << nl; os.writeKeyword("orientation") From 5b364fae9b8d03e491283934951a6bdeab838808 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 14:48:30 +0100 Subject: [PATCH 017/109] ENH: Boundary condition doxygen documentation updates --- .../basic/fixedValue/fixedValueFvPatchField.H | 16 +++++-- ...ureCompressibleDensityFvPatchScalarField.H | 21 +++++++-- .../flowRateInletVelocityFvPatchVectorField.H | 47 ++++++++++++------- .../fluxCorrectedVelocityFvPatchVectorField.H | 43 ++++++++++++++--- .../freestream/freestreamFvPatchField.H | 22 +++++++-- .../freestreamPressureFvPatchScalarField.H | 23 +++++++-- .../genericFvPatchField/genericFvPatchField.H | 10 ++-- ...iffusiveRadiationMixedFvPatchScalarField.H | 23 ++++++++- 8 files changed, 163 insertions(+), 42 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index 65e7abea4a..9b787760d2 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,17 @@ Class Foam::fixedValueFvPatchField Description - Foam::fixedValueFvPatchField + This boundary condition supplies a fixed value constraint, and is the base + class for a number of other boundary conditions. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedValue; + value uniform 0; // example for scalar field usage + } + \endverbatim SourceFiles fixedValueFvPatchField.C @@ -43,7 +53,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedValueFvPatch Declaration + Class fixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index a27409e94b..67b4184da0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,12 +25,25 @@ Class Foam::fixedPressureCompressibleDensityFvPatchScalarField Description - Calculate compressible density as a function of pressure and fluid - properties. + This boundary condition calculates a (liquid) compressible density as a + function of pressure and fluid properties: + + \f[ + rho = rholSat + psil*(p - pSat) + \f] + + where + \var rho = density [kg/m3] + \var rholSat = saturation liquid density + \var p = pressure [Pa] + \var pSat = saturation pressure [Pa] + + The variables \c rholSat, \c pSat and \c psil are retrieved from the + \c thermodynamicProperties dictionary. Example of the boundary condition specification: \verbatim - inlet + myPatch { type fixedPressureCompressibleDensity; p p; // Name of static pressure field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index a4b48c7629..e0564e3a5a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -25,31 +25,42 @@ Class Foam::flowRateInletVelocityFvPatchVectorField Description - Describes a volumetric/mass flow normal vector boundary condition by its - magnitude as an integral over its area. + This boundary condition provides a velocity boundary condition, derived + from the flux (volumetric or mass-based), whose direction is assumed + to be normal to the patch. The basis of the patch (volumetric or mass) is determined by the - dimensions of the flux, phi. + dimensions of the flux, \c phi, and the value of the density field name, + \c rhoName entry. - If the flux is mass-based - - the current density is used to correct the velocity - - volumetric flow rate can be applied by setting the 'rho' entry to 'none' + For a mass-based flux: + \li if \c rhoName is a valid density field name, the flow rate is in kg/s + \li if \c rhoName is "none" the flow rate is in m3/s + + For a volumetric-based flux: + \li the flow rate is in m3/s Example of the boundary condition specification: \verbatim - inlet - { - type flowRateInletVelocity; - flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s] - rho rho; // none | rho [m3/s or kg/s] - value uniform (0 0 0); // placeholder - } + myPatch + { + type flowRateInletVelocity; + flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s] + rho rho; // none | rho [m3/s or kg/s] + value uniform (0 0 0); // placeholder + } \endverbatim -Note - - The value is positive inwards - - May not work correctly for transonic inlets - - Strange behaviour with potentialFoam since the U equation is not solved + The \c flowRate entry is a \c DataEntry type, meaning that it can be + specified as constant, a polynomial fuction of time, and ... + + \note + \li the value is positive into the domain (as an inlet) + \li may not work correctly for transonic inlets + \li strange behaviour with potentialFoam since the U equation is not solved + +SeeAlso + Foam::DataEntry SourceFiles flowRateInletVelocityFvPatchVectorField.C @@ -67,7 +78,7 @@ SourceFiles namespace Foam { /*---------------------------------------------------------------------------*\ - Class flowRateInletVelocityFvPatch Declaration + Class flowRateInletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class flowRateInletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 6631d205b4..00ea99bc37 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,10 +25,38 @@ Class Foam::fluxCorrectedVelocityFvPatchVectorField Description - Velocity outlet boundary condition for patches where the pressure is - specified. The outflow velocity is obtained by "zeroGradient" and then - corrected from the flux. If reverse flow is possible or expected use - the "pressureInletOutletVelocityFvPatchVectorField" BC instead. + This boundary condition provides a velocity outlet boundary condition for + patches where the pressure is specified. The outflow velocity is obtained + by "zeroGradient" and then corrected from the flux: + + \f[ + Up = Uc - n*(n.Uc) + n*phi/mag(Sf) + \f] + + where + \var Up = velocity at the patch [m/s] + \var Uc = velocity in cells adjacent to the patch [m/s] + \var n = patch normal vectors + \var phi = flux at the patch [m3/s or kg/s] + \var Sf = patch face area vectors [m2] + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fluxCorrectedVelocity; + phi phi; // name of flux field (default = phi) + rho rho; // name of density field (default = rho) + } + \endverbatim + + \note + If reverse flow is possible or expected use the + pressureInletOutletVelocity condition instead. + +SeeAlso + Foam::zeroGradientFvPatchField + Foam::pressureInletOutletVelocityFvPatchVectorField SourceFiles fluxCorrectedVelocityFvPatchVectorField.C @@ -47,7 +75,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fluxCorrectedVelocityFvPatch Declaration + Class fluxCorrectedVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class fluxCorrectedVelocityFvPatchVectorField @@ -56,7 +84,10 @@ class fluxCorrectedVelocityFvPatchVectorField { // Private data + //- Name of flux field word phiName_; + + //- Name of density field word rhoName_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 50f3d136f0..d6936c01c9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,23 @@ Class Foam::freestreamFvPatchField Description - Foam::freestreamFvPatchField + This boundary condition provides a free-stream condition. It is a 'mixed' + condition derived from the \c inletOutlet condition, whereby the mode of + operation switches between fixed (free stream) value and zero gradient + based on the sign of the flux. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type freestream; + phi phi; // name of the flux field (default = phi) + } + \endverbatim + +SeeAlso + Foam::mixedFvPatchField + Foam::inletOutletFvPatchField SourceFiles freestreamFvPatchField.C @@ -43,7 +59,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class freestreamFvPatch Declaration + Class freestreamFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 6323b678d7..6107208e19 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,24 @@ Class Foam::freestreamPressureFvPatchScalarField Description - Foam::freestreamPressureFvPatchScalarField + This boundary condition provides a free-stream condition for pressure. + It is a zero-gradient condition that constrains the flux across the patch + based on the free-stream velocity. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type freestreamPressure; + } + \endverbatim + + \note + This condition is designed to operate with a freestream velocity condition + +SeeAlso + Foam::zeroGradientFvPatchField + Foam::freestreamFvPatchField SourceFiles freestreamPressureFvPatchScalarField.C @@ -44,7 +61,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class freestreamPressureFvPatch Declaration + Class freestreamPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class freestreamPressureFvPatchScalarField diff --git a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H index 3236c3f2b9..c032a32fc2 100644 --- a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H +++ b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,12 @@ Class Foam::genericFvPatchField Description - A generic version of calculatedFvPatchField, useful as a fallback for - handling unknown patch types. + This boundary condition provides a generic version of the \c calculated + condition, useful as a fallback for handling unknown patch types. Not + generally applicable as a user-specified condition. + +SeeAlso + Foam::calculatedFvPatchField SourceFiles genericFvPatchField.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index 2199242b59..4eab608b80 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,26 @@ Class Foam::greyDiffusiveRadiationMixedFvPatchScalarField Description - Radiation temperature specified + This boundary condition provides a grey-diffuse condition for radiation + intensity, \c I, for use with the finite-volume discrete-ordinates model + (fvDOM), in which the radiation temperature is retrieved from the + temperature field boundary condition. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type greyDiffusiveRadiation; + T T; // name of temperature field + emissivityMode solidThermo; // solidThermo | lookup + value uniform 0; // initial value + } + \endverbatim + +SeeAlso + Foam::radiation::fvDOM + Foam::radiationCoupledBase + Foam::mixedFvPatchField SourceFiles greyDiffusiveRadiationMixedFvPatchScalarField.C From b09f2a649942b72bf100d206f57b87fb7c600427 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 15:44:04 +0100 Subject: [PATCH 018/109] STYLE: minor code formatting updates --- .../fluxCorrectedVelocityFvPatchVectorField.C | 4 +--- .../radiationModel/fvDOM/fvDOM/fvDOM.H | 16 +++++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.C index fbd74afe20..a3f7387390 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,8 +29,6 @@ License #include "volFields.H" #include "surfaceFields.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // Foam::fluxCorrectedVelocityFvPatchVectorField:: diff --git a/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/fvDOM/fvDOM.H b/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/fvDOM/fvDOM.H index 1e49063fa4..dda36a5c5d 100644 --- a/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/fvDOM/fvDOM.H +++ b/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/fvDOM/fvDOM.H @@ -34,14 +34,16 @@ Description wideBandAbsorptionEmission i.e. dictionary - fvDOMCoeffs - { - nPhi 1; // azimuthal angles in PI/2 on X-Y.(from Y to X) - nTheta 2; // polar angles in PI (from Z to X-Y plane) - convergence 1e-4; // convergence criteria for radiation iteration - } + \verbatim + fvDOMCoeffs + { + nPhi 1; // azimuthal angles in PI/2 on X-Y.(from Y to X) + nTheta 2; // polar angles in PI (from Z to X-Y plane) + convergence 1e-4; // convergence criteria for radiation iteration + } - solverFreq 1; // Number of flow iterations per radiation iteration + solverFreq 1; // Number of flow iterations per radiation iteration + \endverbatim The total number of solid angles is 4*nPhi*nTheta. From 36b4616931acdabac74f07a5cc1229af1cf4b03d Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 6 Jul 2012 17:38:54 +0100 Subject: [PATCH 019/109] ENH: Boundary condition doxygen documentation updates --- .../basic/mixed/mixedFvPatchField.H | 29 +++++++++-- .../jumpCyclic/jumpCyclicFvPatchField.H | 8 ++- .../inletOutlet/inletOutletFvPatchField.H | 28 ++++++++-- ...OutletTotalTemperatureFvPatchScalarField.H | 26 ++++++++-- .../mappedField/mappedFieldFvPatchField.H | 37 +++++++++++--- .../mappedFixedInternalValueFvPatchField.H | 29 +++++++++-- ...ppedFixedPushedInternalValueFvPatchField.H | 28 ++++++++-- .../mappedFixedValueFvPatchField.H | 51 ++++++++++++------- ...mappedVelocityFluxFixedValueFvPatchField.H | 29 +++++++++-- .../movingWallVelocityFvPatchVectorField.H | 23 +++++++-- ...iffusiveRadiationMixedFvPatchScalarField.H | 1 + ...veViewFactorFixedValueFvPatchScalarField.H | 20 +++++++- 12 files changed, 257 insertions(+), 52 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 51481e0f91..a02393d3b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,30 @@ Class Foam::mixedFvPatchField Description - Foam::mixedFvPatchField + This boundary condition provides a base class for 'mixed' type boundary + conditions, i.e. conditions that mix fixed value and patch-normal gradient + conditions. + + The respective contributions from each is determined by a weight field: + + \f[ + x_p = w*A + (1-w)*(x_c + B/delta) + \f] + + where + \var x_p = patch values + \var x_c = patch internal cell values + \var w = weight field, \c valueFraction_ + \var A = fixed value, \c refValue_ + \var B = patch normal gradient, \c refGrad_ + \var delta = inverse distance from face centre to internal cell centre + + \note + This condition is not usually applied directly; instead, use a derived + mixed condition such as \c inletOutlet + +SeeAlso + Foam::inletOutletFvPatchField SourceFiles mixedFvPatchField.C @@ -43,7 +66,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mixedFvPatch Declaration + Class mixedFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H index 4c4f94bce6..bf7c62408d 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H @@ -25,7 +25,11 @@ Class Foam::jumpCyclicFvPatchField Description - Foam::jumpCyclicFvPatchField + This boundary condition provides a base class for coupled-cyclic + conditions with a specified 'jump' (or offset) between the values + +SeeAlso + Foam::cyclicFvPatchField SourceFiles jumpCyclicFvPatchField.C @@ -43,7 +47,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class cyclicFvPatch Declaration + Class jumpCyclicFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 4c7817967b..425c0e6fd4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,29 @@ Class Foam::inletOutletFvPatchField Description - Foam::inletOutletFvPatchField + This boundary condition provides a generic outflow condition, with + specified inflow for the case of return flow. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type inletOutlet; + phi phi; // name of flux field (default = phi) + inletValue uniform 0; // reverse flow (inlet) value + value uniform 0; // initial value + } + \endverbatim + + The mode of operation is determined by the sign of the flux across the + patch faces. + + \li positive flux (out of domain): apply zero-gradient condition + \li negative flux (into of domain): apply the user-specified fixed value + +SeeAlso + Foam::mixedFvPatchField + Foam::zeroGradientFvPatchField SourceFiles inletOutletFvPatchField.C @@ -43,7 +65,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class inletOutletFvPatch Declaration + Class inletOutletFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 7483a39bd4..0e6e596fbc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,27 @@ Class Foam::inletOutletTotalTemperatureFvPatchScalarField Description - Foam::inletOutletTotalTemperatureFvPatchScalarField + This boundary condition provides an outflow condition for total + temperature for use with supersonic cases, where a user-specified + value is applied in the case of reverse flow. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type inletOutletTotalTemperature; + U U; // velocity field (default = U) + phi phi; // flux field (default = phi) + psi psi; // compressiblility field (default = psi) + gamma gamma; // heat capacity ratio + inletValue uniform 0; // reverse flow (inlet) value + T0 uniform 0; // static temperature [K] + value uniform 0; // initial value + } + \endverbatim + +SeeAlso + Foam::inletOutletFvPatchField SourceFiles inletOutletTotalTemperatureFvPatchScalarField.C @@ -43,7 +63,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class inletOutletTotalTemperatureFvPatch Declaration + Class inletOutletTotalTemperatureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class inletOutletTotalTemperatureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 11c0425bed..549053c4c0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,10 +25,35 @@ Class Foam::mappedFieldFvPatchField Description - Self-contained version of mapped. Does not use information on - patch, instead holds it locally (and possibly duplicate) so use - normal mapped in preference and only use this if you cannot - change the underlying patch type to mapped. + This boundary condition provides a self-contained version of the \c mapped + condition. It does not use information on the patch; instead it holds + thr data locally. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mappedField; + fieldName T; // optional field name + setAverage no; // apply an average value + average 0; // average to apply if setAverage + value uniform 0; // place holder + } + \endverbatim + + + \note + Since this condition can be applied on a per-field and per-patch basis, + it is possible to duplicate the mapping information. If possible, employ + the \c mapped condition in preference to avoid this situation, and only + employ this condition if it is not possible to change the underlying + geometric (poly) patch type to \c mapped. + +SeeAlso + Foam::mappedPatchBase + Foam::mappedPolyPatch + Foam::mappedFvPatch + Foam::fixedValueFvPatchField SourceFiles mappedFieldFvPatchField.C @@ -48,7 +73,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mappedFieldFvPatchField Declaration + Class mappedFieldFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 56ab904529..79eeba6f48 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,29 @@ Class Foam::mappedFixedInternalValueFvPatchField Description - Recycles the boundary and internal values of a neighbour patch field to - the boundary and internal values of *this. + This boundary condition maps the boundary and internal values of a + neighbour patch field to the boundary and internal values of *this. + + \verbatim + myPatch + { + type mappedFixedInternalValue; + fieldName T; // optional field name + setAverage no; // apply an average value + average 0; // average to apply if setAverage + value uniform 0; // place holder + } + \endverbatim + + \note + This boundary condition can only be applied to patches that are of + the \c mappedPolyPatch type. + +SeeAlso + Foam::mappedPatchBase + Foam::mappedPolyPatch + Foam::mappedFvPatch + Foam::mappedFixedValueFvPatchField SourceFiles mappedFixedInternalValueFvPatchField.C @@ -44,7 +65,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mappedFixedInternalValueFvPatchField Declaration + Class mappedFixedInternalValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index a3dc0b67ac..6b14e38fcd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,8 +25,30 @@ Class Foam::mappedFixedPushedInternalValueFvPatchField Description - Recycles the boundary values of a neighbour patch field to the boundary - and internal values of *this. + This boundary condition maps the boundary values of a neighbour patch + field to the boundary and internal cell values of *this. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mappedFixedInternalValue; + fieldName T; // optional field name + setAverage no; // apply an average value + average 0; // average to apply if setAverage + value uniform 0; // place holder + } + \endverbatim + + \note + This boundary condition can only be applied to patches that are of + the \c mappedPolyPatch type. + +SeeAlso + Foam::mappedPatchBase + Foam::mappedPolyPatch + Foam::mappedFvPatch + Foam::mappedFixedValueFvPatchField SourceFiles mappedFixedPushedInternalValueFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index d60ae3bc3c..481c86c87d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,26 +25,41 @@ Class Foam::mappedFixedValueFvPatchField Description - Recycles the value at a set of cells or patch faces back to *this. Can not - sample internal faces (since volField not defined on faces). + This boundary condition maps the value at a set of cells or patch faces + back to *this. - mode = NEARESTCELL : sample nearest cell - mode = NEARESTPATCHFACE : sample nearest face on selected patch - mode = NEARESTFACE : sample nearest face on any patch. Note: does not - warn if nearest actually is on internal face! - mode = NEARESTPATCHFACEAMI : sample nearest face on selected patch - patches can be non-conformal - method uses AMI interpolation + The sample mode is set by the underlying mapping engine, provided by the + mappedPatchBase class. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mapped; + fieldName T; // optional (alternative) field name + setAverage no; // apply an average value + average 0; // average to apply if setAverage + interpolationScheme cell; // optional interpolation scheme + value uniform 0; // place holder + } + \endverbatim - For NEARESTCELL you have to provide an 'interpolationScheme' entry - which can be any one of the interpolation schemes (cell, cellPoint, etc.) - In case of interpolation (so scheme != cell) the limitation is that - there is only one value per cell. So e.g. if you have a cell with two - boundary faces and both faces sample into the cell both faces will get - the same value. + When employing the \c nearestCell sample mode, the user must also specify + the interpolation scheme using the \c interpolationScheme entry. - See mappedPatchBase for options on sampling. + In case of interpolation (where scheme != cell) the limitation is that + there is only one value per cell. For example, if you have a cell with two + boundary faces and both faces sample into the cell, both faces will get the + same value. - Optional 'fieldName' entry to supply a different filename + \note + It is not possible to sample internal faces since volume fields are not + defined on faces. + +SeeAlso + Foam::mappedPatchBase + Foam::interpolation + Foam::fixedValueFvPatchField SourceFiles mappedFixedValueFvPatchField.C @@ -63,7 +78,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mappedFixedValueFvPatch Declaration + Class mappedFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index c1d40666dd..cf60c26a55 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,11 +25,30 @@ Class Foam::mappedVelocityFluxFixedValueFvPatchField Description - Recycles the velocity and flux at a patch to this patch + This boundary condition maps the velocity and flux from a neighbour patch + to this patch - mode = NEARESTPATCHFACE : sample nearest face on selected patch - mode = NEARESTFACE : sample nearest face on any patch. Note: does not - warn if nearest actually is on internal face! + Example of the boundary condition specification: + \verbatim + myPatch + { + type mappedFixedInternalValue; + phi phi; // name of flux field (default = phi) + value uniform 0; // place holder + } + \endverbatim + + The underlying sample mode should be set to nearestPatchFace or nearestFace + + \note + This boundary condition can only be applied to patches that are of + the \c mappedPolyPatch type. + +SeeAlso + Foam::mappedPatchBase + Foam::mappedPolyPatch + Foam::mappedFvPatch + Foam::fixedValueFvPatchVectorField SourceFiles mappedVelocityFluxFixedValueFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 6da73d51f1..0d45bbc424 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,23 @@ Class Foam::movingWallVelocityFvPatchVectorField Description - Foam::movingWallVelocityFvPatchVectorField + This boundary condition provides a velocity condition for cases with + moving walls. In addition, it should also be applied to 'moving' walls + for moving reference frame (MRF) calculations. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type movingWallVelocity; + U U; // name of velocity field (default = U) + value uniform 0; // initial value + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchVectorField + Foam::MRFZone SourceFiles movingWallVelocityFvPatchVectorField.C @@ -44,7 +60,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class movingWallVelocityFvPatch Declaration + Class movingWallVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class movingWallVelocityFvPatchVectorField @@ -125,7 +141,6 @@ public: } - // Member functions //- Update the coefficients associated with the patch field diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index 4eab608b80..51dd2d4ad3 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -42,6 +42,7 @@ Description \endverbatim SeeAlso + Foam::radiation::radiationModel Foam::radiation::fvDOM Foam::radiationCoupledBase Foam::mixedFvPatchField diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 74a552ddb1..e2ada393e9 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -25,7 +25,25 @@ Class Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField Description - Radiation temperature specified + This boundary condition provides a grey-diffuse condition for radiative + heat flux, \c Qr, for use with the view factor model + + Example of the boundary condition specification: + \verbatim + myPatch + { + type greyDiffusiveRadiationViewFactor; + Qro uniform 0; // external radiative heat flux + emissivityMode solidThermo; // solidThermo | lookup + value uniform 0; // initial value + } + \endverbatim + +SeeAlso + Foam::radiation::radiationModel + Foam::radiation::viewFactor + Foam::radiationCoupledBase + Foam::fixedValueFvPatchField SourceFiles greyDiffusiveViewFactorFixedValueFvPatchScalarField.C From b38fa5cb228f1c5b237cae058e0500f563ea523a Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 9 Jul 2012 17:19:29 +0100 Subject: [PATCH 020/109] BUG: Corrected typo in tutorial fvSolution --- .../incompressible/pimpleDyMFoam/propeller/system/fvSolution | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/incompressible/pimpleDyMFoam/propeller/system/fvSolution b/tutorials/incompressible/pimpleDyMFoam/propeller/system/fvSolution index a6da9b769e..d9be291180 100644 --- a/tutorials/incompressible/pimpleDyMFoam/propeller/system/fvSolution +++ b/tutorials/incompressible/pimpleDyMFoam/propeller/system/fvSolution @@ -43,7 +43,7 @@ solvers relTol 0; } - "(U|k|epsion)" + "(U|k|epsilon)" { solver smoothSolver; smoother GaussSeidel; From 6af75993494163b9e6886ef3a62928dddd182ad6 Mon Sep 17 00:00:00 2001 From: andy Date: Tue, 10 Jul 2012 17:07:06 +0100 Subject: [PATCH 021/109] ENH: Added table handling and treatment for /header into doxygen --- bin/tools/doxyFilter | 3 +- bin/tools/doxyFilter-table.awk | 100 +++++++++++++++++++++++++++++++++ bin/tools/doxyFilter.sed | 4 ++ 3 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 bin/tools/doxyFilter-table.awk diff --git a/bin/tools/doxyFilter b/bin/tools/doxyFilter index b5e59a2370..2e370383e5 100755 --- a/bin/tools/doxyFilter +++ b/bin/tools/doxyFilter @@ -54,7 +54,8 @@ then # ;; esac - awk -f $awkScript $1 | \ + awk -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.awk $1 | \ + awk -f $awkScript | \ sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter.sed \ -e s@%filePath%@$filePath@g \ -e s@%fileName%@$fileName@g \ diff --git a/bin/tools/doxyFilter-table.awk b/bin/tools/doxyFilter-table.awk new file mode 100644 index 0000000000..a8bc23bd90 --- /dev/null +++ b/bin/tools/doxyFilter-table.awk @@ -0,0 +1,100 @@ +BEGIN { + FS = "|"; + data = ""; + flag = 0; + firstRow = 0; +} + + +/\/table/ { + flag = 1; + firstRow = 1; + next; +} + + +/\/endtable/ { + if (data != "") + { + printf "\n"; + printf data; + printf "
\n"; + } + + data = ""; + flag = 0; + next; +} + + +/\/vartable/ { + flag = 2; + firstRow = 1; + next; +} + + +/\/endvartable/ { + if (data != "") + { + printf "\n"; + printf data; + printf "
\n"; + } + + data = ""; + flag = 0; + next; +} + + +{ + if (flag > 0) + { + data = (data ""); + if (flag == 1) + { + for (i = 0; i <= NF; i++) + { + if ((i != 0) && (firstRow == 1)) + { + data = (data " "$i"\n"); + } + else + { + if (i == 1) + { + data = (data " \\c "$i"\n"); + } + else if (i > 1) + { + data = (data " "$i"\n"); + } + } + } + } + else if (flag == 2) + { + for (i = 0; i <= NF; i++) + { + if (i == 1) + { + data = (data " \\f$"$i"\\f$\n"); + data = (data " =\n"); + } + else if (i > 1) + { + data = (data " "$i"\n"); + } + } + } + data = (data "\n"); + firstRow = 0; + } + else + { + print $0 + } +} + + diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 681929a904..b1bbfc20de 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -150,6 +150,10 @@ s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)?
  • \1
    • ? s/.*\*\//\*\// + +# convert /heading in source files to bold font and add some space +s#/heading \(.*\)#
    \1#g + } # ----------------------------------------------------------------------------- From fa7053bd278660f9a02642e35e338d2d43ddf082 Mon Sep 17 00:00:00 2001 From: andy Date: Tue, 10 Jul 2012 17:07:31 +0100 Subject: [PATCH 022/109] ENH: Added CSS for doxygen tables --- doc/Doxygen/css/doxyMod.css | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/Doxygen/css/doxyMod.css b/doc/Doxygen/css/doxyMod.css index 01a980b463..e5909a50db 100644 --- a/doc/Doxygen/css/doxyMod.css +++ b/doc/Doxygen/css/doxyMod.css @@ -61,3 +61,19 @@ tr.memlist margin-top: 0px; width: 200px; } + +.OFTable { + width: 100%; + border: 1px solid rgb(175,175,175); + margin-top: 10px; + margin-bottom: 10px; +/* background-color: #F0F0F0; */ + padding: 5px; +} + +.OFTable th { + padding: 5px; + border-bottom: 2px solid rgb(175,175,175); +} + + From 04f044c14c95dded8ae4410a8414128cecad8ace Mon Sep 17 00:00:00 2001 From: andy Date: Tue, 10 Jul 2012 17:09:42 +0100 Subject: [PATCH 023/109] ENH: Boundary condition doxygen documentation updates --- .../basicSymmetry/basicSymmetryFvPatchField.H | 5 + .../basic/calculated/calculatedFvPatchField.H | 17 ++- .../basic/coupled/coupledFvPatchField.H | 5 + .../directionMixedFvPatchField.H | 5 + .../fixedGradient/fixedGradientFvPatchField.H | 32 ++++-- .../basic/fixedValue/fixedValueFvPatchField.H | 22 +++- .../basic/mixed/mixedFvPatchField.H | 19 ++-- .../basic/sliced/slicedFvPatchField.H | 8 ++ .../basic/transform/transformFvPatchField.H | 7 +- .../zeroGradient/zeroGradientFvPatchField.H | 21 +++- .../constraint/cyclic/cyclicFvPatchField.H | 15 ++- .../cyclicAMI/cyclicAMIFvPatchField.H | 18 +++- .../cyclicSlip/cyclicSlipFvPatchField.H | 17 ++- .../constraint/empty/emptyFvPatchField.H | 15 ++- .../jumpCyclic/jumpCyclicFvPatchField.H | 5 + .../nonuniformTransformCyclicFvPatchField.H | 13 ++- .../processor/processorFvPatchField.H | 21 +++- .../processorCyclicFvPatchField.H | 26 ++++- .../symmetry/symmetryFvPatchField.H | 21 +++- .../constraint/wedge/wedgeFvPatchField.H | 25 ++++- .../activeBaffleVelocityFvPatchVectorField.H | 68 ++++++++---- ...ureForceBaffleVelocityFvPatchVectorField.H | 56 +++++++--- .../derived/advective/advectiveFvPatchField.H | 45 +++++--- .../buoyantPressureFvPatchScalarField.H | 49 ++++++--- .../codedFixedValueFvPatchField.H | 60 ++++++----- .../codedMixed/codedMixedFvPatchField.H | 68 ++++++------ ...lindricalInletVelocityFvPatchVectorField.H | 23 +++- .../derived/fan/fanFvPatchField.H | 47 +++++--- .../fixedFluxPressureFvPatchScalarField.H | 39 +++++-- .../fixedInternalValueFvPatchField.H | 18 +++- .../derived/fixedJump/fixedJumpFvPatchField.H | 10 +- .../derived/fixedMean/fixedMeanFvPatchField.H | 30 +++++- .../fixedNormalSlipFvPatchField.H | 25 ++++- ...ureCompressibleDensityFvPatchScalarField.H | 41 +++++-- .../flowRateInletVelocityFvPatchVectorField.H | 39 ++++--- .../fluxCorrectedVelocityFvPatchVectorField.H | 40 ++++--- .../freestream/freestreamFvPatchField.H | 24 +++-- .../freestreamPressureFvPatchScalarField.H | 15 ++- .../inletOutlet/inletOutletFvPatchField.H | 33 ++++-- ...OutletTotalTemperatureFvPatchScalarField.H | 39 +++++-- .../mappedField/mappedFieldFvPatchField.H | 31 ++++-- .../mappedFixedInternalValueFvPatchField.H | 30 ++++-- ...ppedFixedPushedInternalValueFvPatchField.H | 30 ++++-- .../mappedFixedValueFvPatchField.H | 33 ++++-- .../mappedFlowRateFvPatchVectorField.H | 26 +++-- ...mappedVelocityFluxFixedValueFvPatchField.H | 27 +++-- .../movingWallVelocityFvPatchVectorField.H | 25 +++-- ...phaseFixedFluxPressureFvPatchScalarField.C | 34 +++--- ...phaseFixedFluxPressureFvPatchScalarField.H | 48 ++++++++- .../oscillatingFixedValueFvPatchField.H | 44 +++++++- .../outletInlet/outletInletFvPatchField.H | 37 ++++++- .../outletMappedUniformInletFvPatchField.H | 37 ++++++- .../partialSlip/partialSlipFvPatchField.H | 32 +++++- ...aseHydrostaticPressureFvPatchScalarField.H | 57 ++++++++-- ...tedInletOutletVelocityFvPatchVectorField.H | 52 +++++++-- ...eDirectedInletVelocityFvPatchVectorField.H | 52 +++++++-- ...tOutletParSlipVelocityFvPatchVectorField.H | 49 +++++++-- ...ureInletOutletVelocityFvPatchVectorField.H | 45 ++++++-- ...reInletUniformVelocityFvPatchVectorField.H | 27 ++++- .../pressureInletVelocityFvPatchVectorField.H | 40 +++++-- ...malInletOutletVelocityFvPatchVectorField.H | 48 +++++++-- ...ureInletOutletVelocityFvPatchVectorField.H | 47 +++++++- .../rotatingTotalPressureFvPatchScalarField.H | 46 +++++++- .../rotatingWallVelocityFvPatchVectorField.H | 38 ++++++- .../derived/slip/slipFvPatchField.H | 21 +++- .../supersonicFreestreamFvPatchVectorField.H | 45 ++++++-- ...urfaceNormalFixedValueFvPatchVectorField.H | 36 ++++++- ...lFlowRateInletVelocityFvPatchVectorField.H | 49 ++++++--- .../syringePressureFvPatchScalarField.H | 66 ++++++++---- .../temperatureJumpFvPatchScalarField.H | 34 +++++- .../timeVaryingMappedFixedValueFvPatchField.H | 61 ++++++----- .../totalPressureFvPatchScalarField.H | 100 +++++++++++++++++- ...ranslatingWallVelocityFvPatchVectorField.H | 35 +++++- .../turbulentInletFvPatchField.H | 67 +++++++++--- ...sityKineticEnergyInletFvPatchScalarField.C | 21 ++-- ...sityKineticEnergyInletFvPatchScalarField.H | 52 +++++++-- ...ityHydrostaticPressureFvPatchScalarField.H | 46 +++++++- .../uniformFixedValueFvPatchField.H | 22 +++- .../uniformTotalPressureFvPatchScalarField.H | 55 ++++++++-- .../variableHeightFlowRateFvPatchField.H | 54 ++++++---- ...tFlowRateInletVelocityFvPatchVectorField.C | 6 +- ...tFlowRateInletVelocityFvPatchVectorField.H | 43 +++++--- .../waveSurfacePressureFvPatchScalarField.H | 43 +++++--- .../waveTransmissiveFvPatchField.H | 52 ++++++++- .../fvPatchFields/fvPatchField/fvPatchField.H | 5 + 85 files changed, 2314 insertions(+), 620 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H index 70cffc74e0..3d2991be2f 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::basicSymmetryFvPatchField @@ -30,6 +33,8 @@ Description SourceFiles basicSymmetryFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef basicSymmetryFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index c3f249287b..f4d455f75e 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::calculatedFvPatchField @@ -29,18 +32,22 @@ Description that the value is assigned via field assignment, and not via a call to e.g. \c updateCoeffs or \c evaluate. + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type calculated; - value uniform (0 0 0); // optional value entry - } + myPatch + { + type calculated; + value uniform (0 0 0); // optional value entry + } \endverbatim SourceFiles calculatedFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef calculatedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H index eaf7bc51ea..fcc1bfddee 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::coupledFvPatchField @@ -30,6 +33,8 @@ Description SourceFiles coupledFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef coupledFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H index b7298b5a18..ae396fa84f 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::directionMixedFvPatchField @@ -30,6 +33,8 @@ Description SourceFiles directionMixedFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef directionMixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index 4eeda602a2..7ee9750685 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedGradientFvPatchField @@ -33,23 +36,34 @@ Description \f] where - \var values = patch values - \var int = internal field values - \var gradient = gradient (user-specified) - \var delta = inverse distance from patch face centre to cell centre + /vartable + values | patch values + int | internal field values + gradient | gradient (user-specified) + delta | inverse distance from patch face centre to cell centre + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + gradient | gradient | yes | + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type fixedGradient; - gradient uniform 0; - } + myPatch + { + type fixedGradient; + gradient uniform 0; + } \endverbatim SourceFiles fixedGradientFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedGradientFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index 9b787760d2..d89bed8f40 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedValueFvPatchField @@ -28,18 +31,27 @@ Description This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. + /heading Patch usage + + /table + Property | Description | Required | Default value + value | values | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type fixedValue; - value uniform 0; // example for scalar field usage - } + myPatch + { + type fixedValue; + value uniform 0; // example for scalar field usage + } \endverbatim SourceFiles fixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index a02393d3b8..f285baf775 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mixedFvPatchField @@ -36,12 +39,14 @@ Description \f] where - \var x_p = patch values - \var x_c = patch internal cell values - \var w = weight field, \c valueFraction_ - \var A = fixed value, \c refValue_ - \var B = patch normal gradient, \c refGrad_ - \var delta = inverse distance from face centre to internal cell centre + /vartable + x_p | patch values + x_c | patch internal cell values + w | weight field, \c valueFraction_ + A | fixed value, \c refValue_ + B | patch normal gradient, \c refGrad_ + delta | inverse distance from face centre to internal cell centre + /endvartable \note This condition is not usually applied directly; instead, use a derived @@ -53,6 +58,8 @@ SeeAlso SourceFiles mixedFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H index a40d212cd7..36b4b0e43f 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::slicedFvPatchField @@ -33,9 +36,14 @@ Description Should only used as a template argument for SlicedGeometricField. +SeeAlso + Foam::fvPatchField + SourceFiles slicedFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef slicedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H index 2c9a2c15c6..1a37a3cbb0 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::transformFvPatchField @@ -30,6 +33,8 @@ Description SourceFiles transformFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef transformFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 5726c739a9..12927f5457 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,14 +21,29 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::zeroGradientFvPatchField Description - Foam::zeroGradientFvPatchField + This boundary condition appies a zero-gradient condition from the patch + internal field onto the patch faces. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type zeroGradient; + } + \endverbatim SourceFiles zeroGradientFvPatchField.C +@} \*---------------------------------------------------------------------------*/ @@ -43,7 +58,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class zeroGradientFvPatch Declaration + Class zeroGradientFvPatch Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 4ccafd8593..e78e0e5a7d 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::cyclicFvPatchField @@ -33,17 +36,21 @@ Description transformed to the neighbour patch, the patches should be identical (or very similar). + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type cyclic; - } + myPatch + { + type cyclic; + } \endverbatim SourceFiles cyclicFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef cyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index b80ac1fd54..fd8ff67e7f 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::cyclicAMIFvPatchField @@ -34,17 +37,24 @@ Description patch is transformed to the neighbour patch, the outer perimiter of each patch should be identical (or very similar). + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type cyclicAMI; - } + myPatch + { + type cyclicAMI; + } \endverbatim +SeeAlso + Foam::AMIInterpolation + SourceFiles cyclicAMIFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef cyclicAMIFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 350e71a618..13ac6f93fa 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::cyclicSlipFvPatchField @@ -28,12 +31,14 @@ Description This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality. + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type cyclicSlip; - } + myPatch + { + type cyclicSlip; + } \endverbatim SeeAlso @@ -42,6 +47,8 @@ SeeAlso SourceFiles cyclicSlipFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef cyclicSlipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index f3a52d9fcf..97ed05d85e 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::emptyFvPatchField @@ -30,17 +33,21 @@ Description patches whose normal is aligned to geometric directions that do not constitue solution directions. + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type empty; - } + myPatch + { + type empty; + } \endverbatim SourceFiles emptyFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef emptyFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H index bf7c62408d..bcb2a16f4c 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::jumpCyclicFvPatchField @@ -34,6 +37,8 @@ SeeAlso SourceFiles jumpCyclicFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef jumpCyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H index 5d4468045d..efbd5e0fdc 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,14 +21,23 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::nonuniformTransformCyclicFvPatchField Description - Foam::nonuniformTransformCyclicFvPatchField + This boundary condition enforces a cyclic condition between a pair of + boundaries, incorporating a non-uniform transformation. SourceFiles nonuniformTransformCyclicFvPatchField.C + nonuniformTransformCyclicFvPatchFields.H + nonuniformTransformCyclicFvPatchFields.C + nonuniformTransformCyclicFvPatchFieldsFwd.H + +@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 690a9dbe4f..49f736ba28 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -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) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,30 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::processorFvPatchField Description - Foam::processorFvPatchField + This boundary condition enables processor communication across patches. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type processor; + } + \endverbatim SourceFiles processorFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef processorFvPatchField_H @@ -45,7 +60,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class processorFvPatch Declaration + Class processorFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 8de27ade32..0d5c552877 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -21,14 +21,36 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::processorCyclicFvPatchField Description - Foam::processorCyclicFvPatchField + This boundary condition enables processor communication across cyclic + patches. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type processor; + } + \endverbatim + +SeeAlso + Foam::processorFvPatchField SourceFiles processorCyclicFvPatchField.C + processorCyclicFvPatchFields.H + processorCyclicFvPatchFields.C + processorCyclicFvPatchFieldsFwd.H + +@} \*---------------------------------------------------------------------------*/ @@ -44,7 +66,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class processorCyclicFvPatch Declaration + Class processorCyclicFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index c95ffb95d6..e44c750f35 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -21,14 +21,31 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::symmetryFvPatchField Description - Foam::symmetryFvPatchField + This boundary condition enforces a symmetry constraint + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type symmetryPlane; + } + \endverbatim SourceFiles symmetryFvPatchField.C + symmetryFvPatchFields.C + symmetryFvPatchFields.H + symmetryFvPatchFieldsFwd.H +@} \*---------------------------------------------------------------------------*/ @@ -44,7 +61,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class symmetryFvPatch Declaration + Class symmetryFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index ec49aaf74f..dd66e00a9d 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,34 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::wedgeFvPatchField Description - Foam::wedgeFvPatchField + This boundary condition is similar to the cyclic condition, except that + it is applied to 2-D geometries. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type wedge; + } + \endverbatim + +SeeAlso + Foam::cyclicFvPatchField SourceFiles wedgeFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef wedgeFvPatchField_H @@ -44,7 +63,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class wedgeFvPatch Declaration + Class wedgeFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index aa5f5f077b..94ac3b93b7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -21,52 +21,74 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::activeBaffleVelocityFvPatchVectorField Description - This boundary condition is applied to the flow velocity, to simulate the - opening of a baffle due to local flow conditions, by merging the behaviours - of wall and cyclic conditions. - - The baffle joins two mesh regions, where the open fraction determines - the interpolation weights applied to each cyclic- and neighbour-patch - contribution. + This velocity boundary condition simulates the opening of a baffle due + to local flow conditions, by merging the behaviours of wall and cyclic + conditions. The baffle joins two mesh regions, where the open fraction + determines the interpolation weights applied to each cyclic- and + neighbour-patch contribution. We determine whether the baffle is opening or closing from the sign of the net force across the baffle, from which the baffle open fraction is updated using: \f[ - x = x_old + dt/DT*sign(F_net) + x = x_{old} + sign(F_{net})\frac{dt}{DT} \f] where - \var x = baffle open fraction [0-1] - \var x_old = baffle open fraction on previous evaluation - \var dt = simulation time step - \var DT = time taken to open the baffle - \var F_net = net force across the baffle + + /vartable + x | baffle open fraction [0-1] + x_{old} | baffle open fraction on previous evaluation + dt | simulation time step + DT | time taken to open the baffle + F_{net} | net force across the baffle + /endvartable The open fraction is then applied to scale the patch areas. + /heading Patch usage + + /table + Property | Description | Required | Default value + p | pressure field name | no | p + cyclicPatch | cylclic patch name | yes | + orientation | 1 or -1 used to switch flow direction | yes| + openFraction | current opatch open fraction [0-1]| yes | + openingTime | time taken to open the baffle | yes | + maxOpenFractionDelta | max open fraction change per timestep | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type activeBaffleVelocity; - p p; // name of pressure field (default = p) - cyclicPatch cyclic1; // name of cyclic patch - orientation 1; // 1 or -1 used to switch flow direction - openFraction 0.2; // current opatch open fraction [0-1] - openingTime 5.0; // time taken to open the baffle - maxOpenFractionDelta 0.1; // max open fraction change/timestep - } + myPatch + { + type activeBaffleVelocity; + p p; + cyclicPatch cyclic1; + orientation 1; + openFraction 0.2; + openingTime 5.0; + maxOpenFractionDelta 0.1; + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + Foam::cyclicFvPatchField + SourceFiles activeBaffleVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef activeBaffleVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 05bac8a277..570c14e5a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::activePressureForceBaffleVelocityFvPatchVectorField @@ -36,36 +39,55 @@ Description Once opened the baffle continues to open at a fixed rate using \f[ - x = x_old + dt/DT + x = x_{old} + \frac{dt}{DT} \f] where - \var x = baffle open fraction [0-1] - \var x_old = baffle open fraction on previous evaluation - \var dt = simulation time step - \var DT = time taken to open the baffle + + /vartable + x | baffle open fraction [0-1] + x_{old} | baffle open fraction on previous evaluation + dt | simulation time step + DT | time taken to open the baffle + /endvartable The open fraction is then applied to scale the patch areas. + /heading Patch usage + + /table + Property | Description | Required | Default value + p | pressure field name | no | p + cyclicPatch | cylclic patch name | yes | + orientation | 1 or -1 used to switch flow direction | yes| + openFraction | current opatch open fraction [0-1]| yes | + openingTime | time taken to open the baffle | yes | + maxOpenFractionDelta | max open fraction change per timestep | yes | + minThresholdValue | minimum open fraction for activation | yes | + forceBased | force (true) or pressure-based (false) activation | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type activePressureForceBaffleVelocity; - p p; // name of pressure field (default = p) - cyclicPatch cyclic1; // name of cyclic patch - orientation 1; // 1 or -1 used to switch flow direction - openFraction 0.2; // current opatch open fraction [0-1] - openingTime 5.0; // time taken to open the baffle - maxOpenFractionDelta 0.1; // max open fraction change/timestep - minThresholdValue 0.01; // minimum open fraction for activation - forceBased false; // force (true) or pressue (false) - } + myPatch + { + type activePressureForceBaffleVelocity; + p p; + cyclicPatch cyclic1; + orientation 1; + openFraction 0.2; + openingTime 5.0; + maxOpenFractionDelta 0.1; + minThresholdValue 0.01; + forceBased false; + } \endverbatim SourceFiles activePressureForceBaffleVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef activePressureForceBaffleVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index b9e46ea66f..e86979b00e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -21,12 +21,15 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::advectiveFvPatchField Description - Advective outflow boundary condition based on solving DDt(psi, U) = 0 - at the boundary. + This boundary condition provides an advective outflow condition, based on + solving DDt(psi, U) = 0 at the boundary. The standard (Euler, backward, CrankNicholson) time schemes are supported. Additionally an optional mechanism to relax the value at @@ -38,16 +41,6 @@ Description advectionSpeed() the default implementation of which requires the name of the flux field \c (phi) and optionally the density \c (rho) if the mass-flux rather than the volumetric-flux is given. - \verbatim - myPatch - { - type advective; - phi phi; - // rho rho; // Not needed, phi volumetric - // fieldInf 1e5; // Optional - // lInf 0.1; // Optional - } - \endverbatim The flow/wave speed at the outlet can be changed by deriving a specialised BC from this class and over-riding advectionSpeed() e.g. in @@ -55,9 +48,37 @@ Description the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition. + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + fieldInf | value of field beyond patch | no | + lInf | distance beyond patch for \c fieldInf | no | + /endtable + + \note + If \c lInf is specified, \c fieldInf will be required; \c rho is only + required in the case of a mass-based flux. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type advective; + phi phi; + // rho rho; // Not needed for volumetric-based flux + // fieldInf 1e5; // Optional + // lInf 0.1; // Optional + } + \endverbatim + SourceFiles advectiveFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef advectiveFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index e239f77976..751aa8c622 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::buoyantPressureFvPatchScalarField @@ -29,41 +32,57 @@ Description buoyant flow. If the variable name is one of: - \li pd - \li p_rgh - \li ph_rgh - we assume that the pressure variable is \f$ p - rho*g.h\f$ and the gradient + - \c pd + - \c p_rgh + - \c ph_rgh + we assume that the pressure variable is \f$p - rho*g.h\f$ and the gradient set using: \f[ grad(pressure) = -snGrad(rho)*(g.h) \f] + where - \var snGrad = surface-normal gradient operator - \var rho = density [kg/m3] - \var g = acceleration due to gravity [m/s2] - \var h = patch face centres [m] + + /vartable + snGrad | surface-normal gradient operator + rho | density [kg/m3] + g | acceleration due to gravity [m/s2] + h | patch face centres [m] + /endtable Otherwise we assume that it is the static pressure, and the gradient calculated using: \f[ grad(pressure) = rho*(g.n) \f] + where - \var n = patch face normal vectors + /vartable + n | patch face normal vectors + /endtable + + /heading Patch usage + + /table + Property | Description | Required | Default value + rho | density field name | no | rho + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type buoyantPressure; - rho rho; // optional density field name (default = rho) - value uniform 0; - } + myPatch + { + type buoyantPressure; + rho rho; + value uniform 0; + } \endverbatim SourceFiles buoyantPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef buoyantPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 6bf3cb06ee..e57c855112 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::codedFixedValueFvPatchField @@ -28,29 +31,31 @@ Description Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField) which is then used to evaluate. + /heading Patch usage + Example: \verbatim - movingWall - { - type codedFixedValue; - value uniform 0; - redirectType rampedFixedValue; // name of generated BC + myPatch + { + type codedFixedValue; + value uniform 0; + redirectType rampedFixedValue; // name of generated BC - code - #{ - operator==(min(10, 0.1*this->db().time().value())); - #}; + code + #{ + operator==(min(10, 0.1*this->db().time().value())); + #}; - //codeInclude - //#{ - // #include "fvCFD.H" - //#}; + //codeInclude + //#{ + // #include "fvCFD.H" + //#}; - //codeOptions - //#{ - // -I$(LIB_SRC)/finiteVolume/lnInclude - //#}; - } + //codeOptions + //#{ + // -I$(LIB_SRC)/finiteVolume/lnInclude + //#}; + } \endverbatim A special form is if the 'code' section is not supplied. In this case @@ -58,21 +63,24 @@ Description which would have a corresponding entry: \verbatim - rampedFixedValue - { - code - #{ - operator==(min(10, 0.1*this->db().time().value())); - #}; - } + myPatch + { + code + #{ + operator==(min(10, 0.1*this->db().time().value())); + #}; + } \endverbatim SeeAlso - Foam::dynamicCode and Foam::functionEntries::codeStream + Foam::dynamicCode + Foam::functionEntries::codeStream SourceFiles codedFixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef codedFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index c2841cd239..8c2ff8a59f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::codedMixedFvPatchField @@ -28,31 +31,33 @@ Description Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField) which is then used to evaluate. + /heading Patch usage + Example: \verbatim - movingWall - { - type codedMixed; - value uniform 0; - redirectType rampedMixed; // name of generated BC + myPatch + { + type codedMixed; + value uniform 0; + redirectType rampedMixed; // name of generated BC - code - #{ - this->refValue() = min(10, 0.1*this->db().time().value()); - this->refGrad() = vector::zero; - this->valueFraction() = 1.0; - #}; + code + #{ + this->refValue() = min(10, 0.1*this->db().time().value()); + this->refGrad() = vector::zero; + this->valueFraction() = 1.0; + #}; - //codeInclude - //#{ - // #include "fvCFD.H" - //#}; + //codeInclude + //#{ + // #include "fvCFD.H" + //#}; - //codeOptions - //#{ - // -I$(LIB_SRC)/finiteVolume/lnInclude - //#}; - } + //codeOptions + //#{ + // -I$(LIB_SRC)/finiteVolume/lnInclude + //#}; + } \endverbatim A special form is if the 'code' section is not supplied. In this case @@ -60,23 +65,26 @@ Description which would have a corresponding entry \verbatim - rampedMixed - { - code - #{ - this->refValue() = min(10, 0.1*this->db().time().value()); - this->refGrad() = vector::zero; - this->valueFraction() = 1.0; - #}; - } + myPatch + { + code + #{ + this->refValue() = min(10, 0.1*this->db().time().value()); + this->refGrad() = vector::zero; + this->valueFraction() = 1.0; + #}; + } \endverbatim SeeAlso - Foam::dynamicCode and Foam::functionEntries::codeStream + Foam::dynamicCode + Foam::functionEntries::codeStream SourceFiles codedMixedFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef codedMixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index d5c6f8e489..f4a837a881 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -22,6 +22,9 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +\addtogroup boundaryConditions +@{ + Class Foam::cylindricalInletVelocityFvPatchVectorField @@ -30,9 +33,20 @@ Description cylindrical co-ordinates given a central axis, central point, rpm, axial and radial velocity. + /heading Patch usage + + /table + Property | Description | Required | Default value + axis | axis of rotation | yes | + centre | centre of rotation | yes | + axialVelocity| axial velocity profile | yes | + radialVelocity| radial velocity profile | yes | + rpm | rotational speed (revolutions per minute) | yes| + /endtable + Example of the boundary condition specification: \verbatim - inlet + myPatch { type cylindricalInletVelocity; axis (0 0 1); @@ -43,13 +57,20 @@ Description } \endverbatim + \note The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. +SeeAlso + Foam::fixedValueFvPatchField + Foam::DataEntry + SourceFiles cylindricalInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef cylindricalInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index bad95b3a7f..fa975e230b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fanFvPatchField @@ -31,27 +34,37 @@ Description The jump is specified as a \c DataEntry type, to enable the use of, e.g. contant, polynomial, table values. + /heading Patch usage + + /table + Property | Description | Required | Default value + patchType | underlying patch type should be \c cyclic| yes | + jump | current jump value | yes | + jumpTable | jump data, e.g. \c csvFile | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch + myPatch + { + type fan; + patchType cyclic; + jump uniform 0; + jumpTable csvFile; + csvFileCoeffs { - type fan; - patchType cyclic; // specify \c cyclic - jump uniform 0; // current jump value - jumpTable csvFile; // jump specification - csvFileCoeffs - { - hasHeaderLine 1; - refColumn 0; - componentColumns 1(1); - separator ","; - fileName "$FOAM_CASE/constant/pressureVsU"; - } - value uniform 0; + hasHeaderLine 1; + refColumn 0; + componentColumns 1(1); + separator ","; + fileName "$FOAM_CASE/constant/pressureVsU"; } + value uniform 0; + } \endverbatim - The above example shows the use of a CSV file to specify the jump. + The above example shows the use of a comma separated (CSV) file to specify + the jump condition. \note The underlying \c patchType should be set to \c cyclic @@ -61,6 +74,10 @@ SeeAlso SourceFiles fanFvPatchField.C + fanFvPatchFields.H + fanFvPatchFields.C + fanFvPatchFieldsFwd.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index 8fbe5091b9..c17f99249a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedFluxPressureFvPatchScalarField @@ -37,23 +40,41 @@ Description \f] where - \var Sf = patch face areas + + /vartable + Sf | patch face areas [m2] + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + phiHbyA | name of predicted flux field | no | phiHbyA + phi | name of flux field | no | phi + rho | name of density field | no | rho + Dp | name of pressure diffusivity field | no | Dp + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type externalWallHeatFluxTemperature; - phiHbyA phiHbyA; // predicted flux field (default = phiHbyA) - phi phi; // flux field (default = phi) - rho rho; // density field (default = rho) - Dp Dp; // pressure diffusivity field (default = Dp) - } + myPatch + { + type externalWallHeatFluxTemperature; + phiHbyA phiHbyA; + phi phi; + rho rho; + Dp Dp; + } \endverbatim +SeeAlso + Foam::fixedGradientFvPatchField + SourceFiles fixedFluxPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedFluxPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 10fac6b767..2198962105 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedInternalValueFvPatchField @@ -29,15 +32,18 @@ Description directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type fixedInternalValue; - vakue uniform 0; // place holder - } + myPatch + { + type fixedInternalValue; + value uniform 0; // place holder + } \endverbatim + \note This is used as a base for conditions such as the turbulence \c epsilon wall function, which applies a near-wall constraint for high Reynolds number flows. @@ -48,6 +54,8 @@ SeeAlso SourceFiles fixedInternalValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 2bca8d534b..f250473ce5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -21,11 +21,17 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedJumpFvPatchField Description - Base class for "jump" of a field - not used directly + Base class for "jump" of a field + + \note + not used directly SeeAlso Foam::fanFvPatchScalarField @@ -34,6 +40,8 @@ SeeAlso SourceFiles fixedJumpFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedJumpFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index b59969a967..99a9c4e053 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -21,16 +21,40 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedMeanFvPatchField Description - Extrapolates field to the patch using the near-cell values and adjusts - the distribution to match the specified meanValue. + This boundary condition extrapolates field to the patch using the near-cell + values and adjusts the distribution to match the specified mean value. + + /heading Patch usage + + /table + Property | Description | Required | Default value + meanValue | mean value | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedMean; + meanValue 1.0; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles fixedMeanFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedMeanFvPatchField_H @@ -44,7 +68,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedMeanFvPatch Declaration + Class fixedMeanFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 94cc081b4e..9224eea582 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -21,24 +21,39 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedNormalSlipFvPatchField Description This boundary condition sets the patch-normal component to a fixed value. + /heading Patch usage + + /table + Property | Description | Required | Default value + fixedValue | fixed value | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type fixedNormalSlip; - fixedValue uniform 0; // example entry for a scalar field - } + myPatch + { + type fixedNormalSlip; + fixedValue uniform 0; // example entry for a scalar field + } \endverbatim +SeeAlso + Foam::transformFvPatchField + SourceFiles fixedNormalSlipFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedNormalSlipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 67b4184da0..bf219a6087 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fixedPressureCompressibleDensityFvPatchScalarField @@ -29,31 +32,47 @@ Description function of pressure and fluid properties: \f[ - rho = rholSat + psil*(p - pSat) + rho = rho_{l,sat} + psi_l*(p - p_{sat}) \f] where - \var rho = density [kg/m3] - \var rholSat = saturation liquid density - \var p = pressure [Pa] - \var pSat = saturation pressure [Pa] + + /vartable + rho | density [kg/m3] + rho_{l,sat} | saturation liquid density [kg/m3] + psi_l | liquid compressibility + p | pressure [Pa] + p_{sat} | saturation pressure [Pa] + /endvartable The variables \c rholSat, \c pSat and \c psil are retrieved from the \c thermodynamicProperties dictionary. + /heading Patch usage + + /table + Property | Description | Required | Default value + p | pressure field name | no | p + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type fixedPressureCompressibleDensity; - p p; // Name of static pressure field - value uniform 1; // Initial value - } + myPatch + { + type fixedPressureCompressibleDensity; + p p; + value uniform 1; + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles fixedPressureCompressibleDensityFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fixedPressureCompressibleDensityFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index e0564e3a5a..a90692905c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::flowRateInletVelocityFvPatchVectorField @@ -34,37 +37,47 @@ Description \c rhoName entry. For a mass-based flux: - \li if \c rhoName is a valid density field name, the flow rate is in kg/s - \li if \c rhoName is "none" the flow rate is in m3/s + - if \c rhoName is a valid density field name, the flow rate is in kg/s + - if \c rhoName is "none" the flow rate is in m3/s For a volumetric-based flux: - \li the flow rate is in m3/s + - the flow rate is in m3/s + + /heading Patch usage + + /table + Property | Description | Required | Default value + flowRate | volumetric [m3/s] OR mass flow rate [kg/s] | yes | + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type flowRateInletVelocity; - flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s] - rho rho; // none | rho [m3/s or kg/s] - value uniform (0 0 0); // placeholder - } + myPatch + { + type flowRateInletVelocity; + flowRate 0.2; + rho rho; + value uniform (0 0 0); // placeholder + } \endverbatim The \c flowRate entry is a \c DataEntry type, meaning that it can be specified as constant, a polynomial fuction of time, and ... \note - \li the value is positive into the domain (as an inlet) - \li may not work correctly for transonic inlets - \li strange behaviour with potentialFoam since the U equation is not solved + - the value is positive into the domain (as an inlet) + - may not work correctly for transonic inlets + - strange behaviour with potentialFoam since the U equation is not solved SeeAlso Foam::DataEntry + Foam::fixedValueFvPatchField SourceFiles flowRateInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef flowRateInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 00ea99bc37..149f971982 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::fluxCorrectedVelocityFvPatchVectorField @@ -30,24 +33,35 @@ Description by "zeroGradient" and then corrected from the flux: \f[ - Up = Uc - n*(n.Uc) + n*phi/mag(Sf) + U_p = U_c - n*(n.U_c) + n*phi/mag(Sf) \f] where - \var Up = velocity at the patch [m/s] - \var Uc = velocity in cells adjacent to the patch [m/s] - \var n = patch normal vectors - \var phi = flux at the patch [m3/s or kg/s] - \var Sf = patch face area vectors [m2] + + /vartable + U_p | velocity at the patch [m/s] + U_c | velocity in cells adjacent to the patch [m/s] + n | patch normal vectors + phi | flux at the patch [m3/s or kg/s] + Sf | patch face area vectors [m2] + /endvartable + + where + + /table + Property | Description | Required | Default value + phi | name of flux field | no | phi + rho | name of density field | no | rho + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type fluxCorrectedVelocity; - phi phi; // name of flux field (default = phi) - rho rho; // name of density field (default = rho) - } + myPatch + { + type fluxCorrectedVelocity; + phi phi; + rho rho; + } \endverbatim \note @@ -61,6 +75,8 @@ SeeAlso SourceFiles fluxCorrectedVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef fluxCorrectedVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index d6936c01c9..3083cbe630 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::freestreamFvPatchField @@ -30,13 +33,20 @@ Description operation switches between fixed (free stream) value and zero gradient based on the sign of the flux. + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type freestream; - phi phi; // name of the flux field (default = phi) - } + myPatch + { + type freestream; + phi phi; + } \endverbatim SeeAlso @@ -46,6 +56,8 @@ SeeAlso SourceFiles freestreamFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef freestreamFvPatchField_H @@ -59,7 +71,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class freestreamFvPatchField Declaration + Class freestreamFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 6107208e19..3b5fb4632f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::freestreamPressureFvPatchScalarField @@ -29,12 +32,14 @@ Description It is a zero-gradient condition that constrains the flux across the patch based on the free-stream velocity. + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type freestreamPressure; - } + myPatch + { + type freestreamPressure; + } \endverbatim \note @@ -47,6 +52,8 @@ SeeAlso SourceFiles freestreamPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef freestreamPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 425c0e6fd4..3518536ffe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::inletOutletFvPatchField @@ -28,22 +31,32 @@ Description This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + inletValue | inlet value | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type inletOutlet; - phi phi; // name of flux field (default = phi) - inletValue uniform 0; // reverse flow (inlet) value - value uniform 0; // initial value - } + myPatch + { + type inletOutlet; + phi phi; // name of flux field (default = phi) + inletValue uniform 0; // reverse flow (inlet) value + value uniform 0; // initial value + } \endverbatim The mode of operation is determined by the sign of the flux across the patch faces. - \li positive flux (out of domain): apply zero-gradient condition - \li negative flux (into of domain): apply the user-specified fixed value + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): apply the user-specified fixed value SeeAlso Foam::mixedFvPatchField @@ -52,6 +65,8 @@ SeeAlso SourceFiles inletOutletFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef inletOutletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 0e6e596fbc..6ccd06a7b3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::inletOutletTotalTemperatureFvPatchScalarField @@ -29,19 +32,31 @@ Description temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. + /heading Patch usage + + /table + Property | Description | Required | Default value + U | velocity field name | no | U + phi | flux field name | no | phi + psi | compressibility field name | no | psi + gamma | heat capacity ration (Cp/Cv) | yes | + inletValue | reverse flow (inlet) value | yes | + T0 | static temperature [K] | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type inletOutletTotalTemperature; - U U; // velocity field (default = U) - phi phi; // flux field (default = phi) - psi psi; // compressiblility field (default = psi) - gamma gamma; // heat capacity ratio - inletValue uniform 0; // reverse flow (inlet) value - T0 uniform 0; // static temperature [K] - value uniform 0; // initial value - } + myPatch + { + type inletOutletTotalTemperature; + U U; + phi phi; + psi psi; + gamma gamma; + inletValue uniform 0; + T0 uniform 0; + value uniform 0; + } \endverbatim SeeAlso @@ -50,6 +65,8 @@ SeeAlso SourceFiles inletOutletTotalTemperatureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef inletOutletTotalTemperatureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 549053c4c0..7d1a1d54d0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedFieldFvPatchField @@ -29,19 +32,27 @@ Description condition. It does not use information on the patch; instead it holds thr data locally. + /heading Patch usage + + /table + Property | Description | Required | Default value + fieldName | name of field to be mapped | no | this field name + setAverage | flag to activate setting of average value | yes | + average | average value to apply if \c setAverage = yes | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type mappedField; - fieldName T; // optional field name - setAverage no; // apply an average value - average 0; // average to apply if setAverage - value uniform 0; // place holder - } + myPatch + { + type mappedField; + fieldName T; // optional field name + setAverage no; // apply an average value + average 0; // average to apply if setAverage + value uniform 0; // place holder + } \endverbatim - \note Since this condition can be applied on a per-field and per-patch basis, it is possible to duplicate the mapping information. If possible, employ @@ -58,6 +69,8 @@ SeeAlso SourceFiles mappedFieldFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedFieldFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 79eeba6f48..ede2346d25 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedFixedInternalValueFvPatchField @@ -28,15 +31,24 @@ Description This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. + /heading Patch usage + + /table + Property | Description | Required | Default value + fieldName | name of field to be mapped | no | this field name + setAverage | flag to activate setting of average value | yes | + average | average value to apply if \c setAverage = yes | yes | + /endtable + \verbatim - myPatch - { - type mappedFixedInternalValue; - fieldName T; // optional field name - setAverage no; // apply an average value - average 0; // average to apply if setAverage - value uniform 0; // place holder - } + myPatch + { + type mappedFixedInternalValue; + fieldName T; + setAverage no; + average 0; + value uniform 0; + } \endverbatim \note @@ -52,6 +64,8 @@ SeeAlso SourceFiles mappedFixedInternalValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedFixedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 6b14e38fcd..bdf88c3cd5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedFixedPushedInternalValueFvPatchField @@ -28,16 +31,25 @@ Description This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this. + /heading Patch usage + + /table + Property | Description | Required | Default value + fieldName | name of field to be mapped | no | this field name + setAverage | flag to activate setting of average value | yes | + average | average value to apply if \c setAverage = yes | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type mappedFixedInternalValue; - fieldName T; // optional field name - setAverage no; // apply an average value - average 0; // average to apply if setAverage - value uniform 0; // place holder - } + myPatch + { + type mappedFixedInternalValue; + fieldName T; + setAverage no; + average 0; + value uniform 0; + } \endverbatim \note @@ -53,6 +65,8 @@ SeeAlso SourceFiles mappedFixedPushedInternalValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedFixedPushedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 481c86c87d..aad29789ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedFixedValueFvPatchField @@ -31,17 +34,27 @@ Description The sample mode is set by the underlying mapping engine, provided by the mappedPatchBase class. + /heading Patch usage + + /table + Property | Description | Required | Default value + fieldName | name of field to be mapped | no | this field name + setAverage | flag to activate setting of average value | yes | + average | average value to apply if \c setAverage = yes | yes | + interpolationScheme | type of interpolation scheme | no | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type mapped; - fieldName T; // optional (alternative) field name - setAverage no; // apply an average value - average 0; // average to apply if setAverage - interpolationScheme cell; // optional interpolation scheme - value uniform 0; // place holder - } + myPatch + { + type mapped; + fieldName T; + setAverage no; + average 0; + interpolationScheme cell; + value uniform 0; + } \endverbatim When employing the \c nearestCell sample mode, the user must also specify @@ -64,6 +77,8 @@ SeeAlso SourceFiles mappedFixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 45c42233b6..39a1d90dc0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedFlowRateFvPatchVectorField @@ -28,14 +31,20 @@ Description Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area. - The inlet mass flux is taken from the neighbor region. - - phi is used to determine if the flow is compressible or incompressible. + The inlet mass flux is taken from the neighbour region. The basis of the patch (volumetric or mass) is determined by the - dimensions of the flux, phi. - The current density is used to correct the velocity when applying the - mass basis. + dimensions of the flux, phi. The current density is used to correct the + velocity when applying the mass basis. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + neigPhi | name of flux field on neighbour mesh | yes | + /endtable Example of the boundary condition specification: @verbatim @@ -44,8 +53,7 @@ Description type mappedFlowRate; phi phi; rho rho; - neigPhi neigPhiName_; // Volumetric/mass flow rate - // [m3/s or kg/s] + neigPhi phi; value uniform (0 0 0); // placeholder } @endverbatim @@ -53,6 +61,8 @@ Description SourceFiles mappedFlowRateFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedFlowRateFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index cf60c26a55..1e4f29810c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::mappedVelocityFluxFixedValueFvPatchField @@ -28,17 +31,25 @@ Description This boundary condition maps the velocity and flux from a neighbour patch to this patch + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type mappedFixedInternalValue; - phi phi; // name of flux field (default = phi) - value uniform 0; // place holder - } + myPatch + { + type mappedFixedInternalValue; + phi phi; + value uniform 0; // place holder + } \endverbatim - The underlying sample mode should be set to nearestPatchFace or nearestFace + The underlying sample mode should be set to \c nearestPatchFace or + \c nearestFace \note This boundary condition can only be applied to patches that are of @@ -53,6 +64,8 @@ SeeAlso SourceFiles mappedVelocityFluxFixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef mappedVelocityFluxFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 0d45bbc424..86aed0448c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::movingWallVelocityFvPatchVectorField @@ -29,14 +32,22 @@ Description moving walls. In addition, it should also be applied to 'moving' walls for moving reference frame (MRF) calculations. + + /heading Patch usage + + /table + Property | Description | Required | Default value + U | velociy field name | no | U + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type movingWallVelocity; - U U; // name of velocity field (default = U) - value uniform 0; // initial value - } + myPatch + { + type movingWallVelocity; + U U; + value uniform 0; // initial value + } \endverbatim SeeAlso @@ -46,6 +57,8 @@ SeeAlso SourceFiles movingWallVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef movingWallVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.C index 644c8b161c..89cf73e8ad 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.C @@ -41,7 +41,8 @@ multiphaseFixedFluxPressureFvPatchScalarField fixedGradientFvPatchScalarField(p, iF), phiHbyAName_("phiHbyA"), phiName_("phi"), - rhoName_("rho") + rhoName_("rho"), + DpName_("Dp") {} @@ -57,7 +58,8 @@ multiphaseFixedFluxPressureFvPatchScalarField fixedGradientFvPatchScalarField(ptf, p, iF, mapper), phiHbyAName_(ptf.phiHbyAName_), phiName_(ptf.phiName_), - rhoName_(ptf.rhoName_) + rhoName_(ptf.rhoName_), + DpName_(ptf.DpName_) {} @@ -72,7 +74,8 @@ multiphaseFixedFluxPressureFvPatchScalarField fixedGradientFvPatchScalarField(p, iF), phiHbyAName_(dict.lookupOrDefault("phiHbyA", "phiHbyA")), phiName_(dict.lookupOrDefault("phi", "phi")), - rhoName_(dict.lookupOrDefault("rho", "rho")) + rhoName_(dict.lookupOrDefault("rho", "rho")), + DpName_(dict.lookupOrDefault("Dp", "Dp")) { if (dict.found("gradient")) { @@ -91,27 +94,29 @@ multiphaseFixedFluxPressureFvPatchScalarField Foam::multiphaseFixedFluxPressureFvPatchScalarField:: multiphaseFixedFluxPressureFvPatchScalarField ( - const multiphaseFixedFluxPressureFvPatchScalarField& wbppsf + const multiphaseFixedFluxPressureFvPatchScalarField& mfppsf ) : - fixedGradientFvPatchScalarField(wbppsf), - phiHbyAName_(wbppsf.phiHbyAName_), - phiName_(wbppsf.phiName_), - rhoName_(wbppsf.rhoName_) + fixedGradientFvPatchScalarField(mfppsf), + phiHbyAName_(mfppsf.phiHbyAName_), + phiName_(mfppsf.phiName_), + rhoName_(mfppsf.rhoName_), + DpName_(mfppsf.DpName_) {} Foam::multiphaseFixedFluxPressureFvPatchScalarField:: multiphaseFixedFluxPressureFvPatchScalarField ( - const multiphaseFixedFluxPressureFvPatchScalarField& wbppsf, + const multiphaseFixedFluxPressureFvPatchScalarField& mfppsf, const DimensionedField& iF ) : - fixedGradientFvPatchScalarField(wbppsf, iF), - phiHbyAName_(wbppsf.phiHbyAName_), - phiName_(wbppsf.phiName_), - rhoName_(wbppsf.rhoName_) + fixedGradientFvPatchScalarField(mfppsf, iF), + phiHbyAName_(mfppsf.phiHbyAName_), + phiName_(mfppsf.phiName_), + rhoName_(mfppsf.rhoName_), + DpName_(mfppsf.DpName_) {} @@ -155,7 +160,7 @@ void Foam::multiphaseFixedFluxPressureFvPatchScalarField::updateCoeffs() */ const fvsPatchField& Dpp = - patch().lookupPatchField("Dp"); + patch().lookupPatchField(DpName_); gradient() = (phiHbyAp - phip)/patch().magSf()/Dpp; @@ -172,6 +177,7 @@ void Foam::multiphaseFixedFluxPressureFvPatchScalarField::write writeEntryIfDifferent(os, "phiHbyA", "phiHbyA", phiHbyAName_); writeEntryIfDifferent(os, "phi", "phi", phiName_); writeEntryIfDifferent(os, "rho", "rho", rhoName_); + writeEntryIfDifferent(os, "Dp", "Dp", DpName_); gradient().writeEntry("gradient", os); writeEntry("value", os); } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index 57f01d78e6..f998f0407f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -21,22 +21,57 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::multiphaseFixedFluxPressureFvPatchScalarField Description - Adjusts the pressure gradient such that the flux on the boundary is that - specified by the velocity boundary condition. + This boundary condition adjusts the pressure gradient such that the flux + on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as (phi - phiHbyA), both of which are looked-up from the database as is - the pressure diffusivity Dp used to calculate the gradient. + as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as + is the pressure diffusivity Dp used to calculate the gradient using: - The names of the phi, phiHbyA and Dp fields may be optionally specified. + \f[ + grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} + \f] + + where + + /vartable + Sf | patch face areas [m2] + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + phiHbyA | name of predicted flux field | no | phiHbyA + phi | name of flux field | no | phi + rho | name of density field | no | rho + Dp | name of pressure diffusivity field | no | Dp + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type externalWallHeatFluxTemperature; + phiHbyA phiHbyA; + phi phi; + rho rho; + Dp Dp; + } + \endverbatim SourceFiles multiphaseFixedFluxPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef multiphaseFixedFluxPressureFvPatchScalarFields_H @@ -71,6 +106,9 @@ class multiphaseFixedFluxPressureFvPatchScalarField // if neccessary word rhoName_; + //- Name of the pressure diffusivity field + word DpName_; + public: diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index ba84bc1c26..0b1351cdee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,12 +21,40 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::oscillatingFixedValueFvPatchField Description - Describes an oscillating boundary condition in terms of amplitude and - frequency. + This boundary condition provides an oscillating condition in terms of + amplitude and frequency. + + /f[ + x_p = (1 + a.sin(\pi f t))x_{ref} + x_o + /f] + + where + + /vartable + x_p | patch values + x_{ref} | patch reference values + x_o | patch offset values + a | amplitude + f | frequency [1/s] + t | time [s] + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + refValue | reference value | yes | + offset | offset value | no | 0.0; // optional + amplitude | oscillation amplitude | yes | + frequency | oscillation frequency | yes | + /endtable Example of the boundary condition specification: \verbatim @@ -34,19 +62,25 @@ Description { type oscillatingFixedValue; refValue uniform 5.0; - offset 0.0; // optional + offset 0.0; amplitude constant 0.5; frequency constant 10; } \endverbatim + \note The amplitude and frequency entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. +SeeAlso + Foam::DataEntry + SourceFiles oscillatingFixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef oscillatingFixedValueFvPatchField_H @@ -62,7 +96,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class oscillatingFixedValueFvPatch Declaration + Class oscillatingFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 1002143fd1..70bdf6ec34 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,48 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::outletInletFvPatchField Description - Foam::outletInletFvPatchField + This boundary condition provides a generic inflow condition, with + specified outflow for the case of return flow. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + inletValue | inlet value | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type outletInlet; + phi phi; // name of flux field (default = phi) + outletValue uniform 0; // reverse flow (inlet) value + value uniform 0; // initial value + } + \endverbatim + + The mode of operation is determined by the sign of the flux across the + patch faces. + + \note + Sign conventions: + - positive flux (out of domain): apply the user-specified fixed value + - negative flux (into of domain): apply zero-gradient condition SourceFiles outletInletFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef outletInletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index c04b7e2f17..603daaa37f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,17 +21,44 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::outletMappedUniformInletFvPatchField Description - Averages the field over the "outlet" patch specified by name - "outletPatchName" and applies this as the uniform value of the field - over this patch. + This boundary conditon averages the field over the "outlet" patch specified + by name "outletPatchName" and applies this as the uniform value of the + field over this patch. + + /heading Patch usage + + /table + Property | Description | Required | Default value + outletPatchName | name of outlet patch | yes | + phi | flux field name | no | phi + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type outletMappedUniformInlet; + outletPatchName aPatch; + phi phi; + value uniform 0; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles outletMappedUniformInletFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef outletMappedUniformInletFvPatchField_H @@ -45,7 +72,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class outletMappedUniformInletFvPatch Declaration + Class outletMappedUniformInletFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index c369143439..8fad8bed65 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,41 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::partialSlipFvPatchField Description - Foam::partialSlipFvPatchField + This boundary condition provides a partial slip condition. The amount of + slip is controlled by a user-supplied field. + + /heading Patch usage + + /table + Property | Description | Required | Default value + valueFraction | fraction od value used for boundary [0-1] | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type partialSlip; + valueFraction uniform 0.1; + value uniform 0; + } + \endverbatim + +SeeAlso + Foam::transformFvPatchField SourceFiles partialSlipFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef partialSlipFvPatchField_H @@ -43,7 +69,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class partialSlipFvPatch Declaration + Class partialSlipFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 4c14094f49..b67f610920 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,23 +21,64 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::phaseHydrostaticPressureFvPatchScalarField Description - Phase hydrostatic pressure boundary condition calculated as + This boundary condition provides a phase-based hydrostatic pressure + condition, calculated as: - pRefValue + rho*g.(x - pRefPoint) + \f[ + p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) + \f] - where rho is provided and assumed uniform + where + /vartable + p_{hyd} | hyrostatic pressure [Pa] + p_{ref} | reference pressure [Pa] + x_{ref} | reference point in Cartesian co-ordinates + \rho | density (assumed uniform) + g | acceleration due to gravity [m/s2] + /endtable - applied according to the phase-fraction field provided: - 1 -> fix value to that provided - 0 -> zero-gradient + The values are assigned according to the phase-fraction field: + - 1: apply \$fp_{hyd}\$f + - 0: apply a zero-gradient condition + + /heading Patch usage + + /table + Property | Description | Required | Default value + phaseName | phase field name | no | alpha + rho | density field name | no | rho + pRefValue | reference pressure [Pa] | yes | + pRefPoint | reference pressure location | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type phaseHydrostaticPressure; + phaseName alpha1; + rho rho; + pRefValue 1e5; + pRefPoint (0 0 0); + value uniform 0; // optional initial value + } + \endverbatim + +SeeAlso + Foam::mixedFvPatchScalarField SourceFiles phaseHydrostaticPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef phaseHydrostaticPressureFvPatchScalarField_H @@ -51,7 +92,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class phaseHydrostaticPressureFvPatch Declaration + Class phaseHydrostaticPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class phaseHydrostaticPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index d9f1a3e2a8..85eaf73c9e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,18 +21,53 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureDirectedInletOutletVelocityFvPatchVectorField Description - Velocity inlet/outlet boundary condition for pressure boundary where the - pressure is specified. zero-gradient is applied for outflow (as defined - by the flux) and for inflow the velocity is obtained from the flux with - the specified `inletDirection'. + This velocity inlet/outlet boundary condition is applied to pressure + boundaries where the pressure is specified. A zero-gradient condtion is + applied for outflow (as defined by the flux); for inflow, the velocity + is obtained from the flux with the specified inlet direction. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + inletDirection | inlet direction per patch face | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureDirectedInletOutletVelocity; + phi phi; + rho rho; + inletDirection uniform (1 0 0); + value uniform 0; + } + \endverbatim + + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux with specified + direction + +SeeAlso + Foam::mixedFvPatchVectorField SourceFiles pressureDirectedInletOutletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureDirectedInletOutletVelocityFvPatchVectorField_H @@ -47,7 +82,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureDirectedInletOutletVelocityFvPatch Declaration + Class pressureDirectedInletOutletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureDirectedInletOutletVelocityFvPatchVectorField @@ -56,8 +91,13 @@ class pressureDirectedInletOutletVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; + + //- Density field name word rhoName_; + + //- Inlet direction vectorField inletDir_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index b12dda34fb..892a7e09ed 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,19 +21,52 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureDirectedInletVelocityFvPatchVectorField Description - Velocity inlet boundary condition for patches where the pressure is - specified. The inflow velocity is obtained from the flux with the - specified "inletDirection" direction. If reverse flow is possible or - expected use the "pressureDirectedInletOutletVelocityFvPatchVectorField" - BC instead. + This velocity inlet boundary condition is applied to patches where the + pressure is specified. The inflow velocity is obtained from the flux with + the specified inlet direction" direction. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + inletDirection | inlet direction per patch face | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureDirectedInletVelocity; + phi phi; + rho rho; + inletDirection uniform (1 0 0); + value uniform 0; + } + \endverbatim + + \note + If reverse flow is possible or expected use the + pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. + + +SeeAlso + Foam::fixedValueFvPatchField + Foam::pressureDirectedInletOutletVelocityFvPatchVectorField SourceFiles pressureDirectedInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureDirectedInletVelocityFvPatchVectorField_H @@ -48,7 +81,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureDirectedInletVelocityFvPatch Declaration + Class pressureDirectedInletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureDirectedInletVelocityFvPatchVectorField @@ -57,8 +90,13 @@ class pressureDirectedInletVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; + + //- Density field name word rhoName_; + + //- Inlet direction vectorField inletDir_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index afab477fbc..9a7d657c73 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,20 +21,54 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureInletOutletParSlipVelocityFvPatchVectorField Description - Velocity inlet/outlet boundary condition for pressure boundary where the - pressure is specified. zero-gradient is applied for outflow (as defined - by the flux) and for inflow the velocity is obtained from the flux with - the specified `inletDirection'. + This velocity inlet/outlet boundary condition for pressure boundary where + the pressure is specified. A zero-gradient is applied for outflow (as + defined by the flux); for inflow, the velocity is obtained from the flux + with the specified inlet direction. - Slip condition applied tangential to the patch. + A slip condition is applied tangential to the patch. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureInletOutletParSlipVelocity; + phi phi; + rho rho; + value uniform 0; + } + \endverbatim + + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux with specified + direction + +SeeAlso + Foam::mixedFvPatchVectorField + Foam::pressureDirectedInletOutletVelocityFvPatchVectorField SourceFiles pressureInletOutletParSlipVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureInletOutletParSlipVelocityFvPatchVectorField_H @@ -58,7 +92,10 @@ class pressureInletOutletParSlipVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; + + //- Density field name word rhoName_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 174142e5ec..3cb219c35e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,18 +21,50 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureInletOutletVelocityFvPatchVectorField Description - Velocity inlet/outlet boundary condition patches for where the pressure is - specified. zero-gradient is applied for outflow (as defined by the flux) - and for inflow the velocity is obtained from the patch-face normal - component of the internal-cell value. + This velocity inlet/outlet boundary condition is applied to pressure + boundaries where the pressure is specified. A zero-gradient condtion is + applied for outflow (as defined by the flux); for inflow, the velocity is + obtained from the patch-face normal component of the internal-cell value. + + The tangential patch velocity can be optionally specified. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + tangentialVelocity | tangential velocity field | no | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureInletOutletVelocity; + phi phi; + tangentialVelocity uniform (0 0 0); + value uniform 0; + } + \endverbatim + + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux in the patch-normal + direction SourceFiles pressureInletOutletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureInletOutletVelocityFvPatchVectorField_H @@ -47,7 +79,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureInletOutletVelocityFvPatch Declaration + Class pressureInletOutletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureInletOutletVelocityFvPatchVectorField @@ -56,6 +88,7 @@ class pressureInletOutletVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; //- Optional tangential velocity component diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 69c1d54c56..255eadc07b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,17 +21,34 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureInletUniformVelocityFvPatchVectorField Description - Velocity inlet boundary condition for patches where the pressure is - specified. The uniform inflow velocity is obtained by averaging the flux - over the patch and apply it in the direction normal to the patch faces. + This velocity inlet boundary condition is applied to patches where the + pressure is specified. The uniform inflow velocity is obtained by + averaging the flux over the patch, and then applying it in the direction + normal to the patch faces. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureInletUniformVelocity; + value uniform 0; + } + \endverbatim SourceFiles pressureInletUniformVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureInletUniformVelocityFvPatchVectorField_H @@ -45,7 +62,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureInletUniformVelocityFvPatch Declaration + Class pressureInletUniformVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureInletUniformVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index c50d53d590..1afb6a95c5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,18 +21,43 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureInletVelocityFvPatchVectorField Description - Velocity inlet boundary condition for patches where the pressure is - specified. The inflow velocity is obtained from the flux with a direction - normal to the patch faces. If reverse flow is possible or expected use - the "pressureInletOutletVelocityFvPatchVectorField" BC instead. + This velocity inlet boundary condition is applied to patches where the + pressure is specified. The inflow velocity is obtained from the flux with + a direction normal to the patch faces. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureInletVelocity; + phi phi; + rho rho; + value uniform 0; + } + \endverbatim + + \note + If reverse flow is possible or expected use + the pressureInletOutletVelocityFvPatchVectorField condition instead. + +SeeAlso + Foam::fixedValueFvPatchField + Foam::pressureInletOutletVelocityFvPatchVectorField SourceFiles pressureInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureInletVelocityFvPatchVectorField_H @@ -47,7 +72,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureInletVelocityFvPatch Declaration + Class pressureInletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureInletVelocityFvPatchVectorField @@ -56,7 +81,10 @@ class pressureInletVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; + + //- Density field name word rhoName_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 04351a477a..7e9c0c63b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,18 +21,51 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::pressureNormalInletOutletVelocityFvPatchVectorField Description - Velocity inlet/outlet boundary condition for patches where the pressure is - specified. zero-gradient is applied for outflow (as defined by the flux) - and for inflow the velocity is obtained from the flux with a direction - normal to the patch faces. + This velocity inlet/outlet boundary condition is applied to patches where + the pressure is specified. A zero-gradient condition is applied for + outflow (as defined by the flux); for inflow, the velocity is obtained from + the flux with a direction normal to the patch faces. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type pressureNormalInletOutletVelocity; + phi phi; + rho rho; + value uniform 0; + } + \endverbatim + + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux and patch-normal + direction + +SeeAlso + Foam::mixedFvPatchVectorField SourceFiles pressureNormalInletOutletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef pressureNormalInletOutletVelocityFvPatchVectorField_H @@ -47,7 +80,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class pressureNormalInletOutletVelocityFvPatch Declaration + Class pressureNormalInletOutletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class pressureNormalInletOutletVelocityFvPatchVectorField @@ -56,7 +89,10 @@ class pressureNormalInletOutletVelocityFvPatchVectorField { // Private data + //- Flux field name word phiName_; + + //- Density field name word rhoName_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 0635857518..39288045ea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,18 +21,55 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::rotatingPressureInletOutletVelocityFvPatchVectorField Description - Velocity inlet/outlet boundary condition in a rotating frame - for patches where the pressure is specified. zero-gradient is applied for - outflow (as defined by the flux) and for inflow the velocity is obtained + This velocity inlet/outlet boundary condition is applied to patches in a + rotating frame where the pressure is specified. A zero-gradient is applied + for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + tangentialVelocity | tangential velocity field | no | + omega | angular velocty of the frame [rad/s] | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type rotatingPressureInletOutletVelocity; + phi phi; + tangentialVelocity uniform (0 0 0); + omega 100; + } + \endverbatim + + The \c omega entry is a DataEntry type, able to describe time varying + functions. + + \note + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux in the patch-normal + direction + +SeeAlso + Foam::pressureInletOutletVelocityFvPatchVectorField + SourceFiles rotatingPressureInletOutletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef rotatingPressureInletOutletVelocityFvPatchVectorField_H @@ -48,7 +85,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class rotatingPressureInletOutletVelocityFvPatch Declaration + Class rotatingPressureInletOutletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class rotatingPressureInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index 68e1d19c8f..eb1dbbfa8c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,55 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::rotatingTotalPressureFvPatchScalarField Description - Foam::rotatingTotalPressureFvPatchScalarField + This boundary condition provides a total pressure condition for patches + in a rotating frame. + + /heading Patch usage + + /table + Property | Description | Required | Default value + U | velocity field name | no | U + phi | flux field name | no | phi + rho | density field name | no | rho + psi | compressibility field name | no | psi + gamma | ratio of specific heats (Cp/Cv) | yes | + p0 | static pressure reference | yes | + omega | angular velocty of the frame [rad/s] | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type rotatingTotalPressure; + U U; + phi phi; + rho rho; + psi psi; + gamma 1.4; + p0 uniform 1e5; + omega 100; + } + \endverbatim + + The \c omega entry is a DataEntry type, able to describe time varying + functions. + +SeeAlso + Foam::totalPressureFvPatchScalarField SourceFiles rotatingTotalPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef rotatingTotalPressureFvPatchScalarField_H @@ -44,7 +84,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class rotatingTotalPressureFvPatch Declaration + Class rotatingTotalPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class rotatingTotalPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 41f821c6d8..957089b6e3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,47 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::rotatingWallVelocityFvPatchVectorField Description - Foam::rotatingWallVelocityFvPatchVectorField + This boundary condition provides a rotational velocity condition. + + /heading Patch usage + + /table + Property | Description | Required | Default value + origin | origin of rotation in Cartesian co-ordinates | yes| + axis | axis of rotation | yes | + omega | angular velocty of the frame [rad/s] | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type rotatingWallVelocity; + origin (0 0 0); + axis (0 0 1); + omega 100; + } + \endverbatim + + The \c omega entry is a DataEntry type, able to describe time varying + functions. + +SeeAlso + Foam::DataEntry + Foam::fixedValueFvPatchField SourceFiles rotatingWallVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef rotatingWallVelocityFvPatchVectorField_H @@ -44,7 +76,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class rotatingWallVelocityFvPatch Declaration + Class rotatingWallVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class rotatingWallVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 19e740ad8d..5c4ac4e0b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,30 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::slipFvPatchField Description - Foam::slipFvPatchField + This boundary condition provides a slip constraint. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type slip; + } + \endverbatim SourceFiles slipFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef slipFvPatchField_H @@ -43,7 +58,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class slipFvPatch Declaration + Class slipFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index 2115ac392d..f47b3a4978 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,25 +21,52 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::supersonicFreestreamFvPatchVectorField Description - Supersonic free stream condition. + This boundary condition provides a supersonic free-stream condition. - Supersonic outflow is vented according to ??? + - supersonic outflow is vented according to ??? + - supersonic inflow is assumed to occur according to the Prandtl-Meyer + expansion process. + - subsonic outflow is applied via a zero-gradient condition from inside + the domain. - Supersonic inflow is assumed to occur according to the Prandtl-Meyer - expansion process. + /heading Patch usage - Subsonic outflow is zero-gradiented from inside the domain. + /table + Property | Description | Required | Default value + UInf | free-stream velocity | yes | + pInf | free-stream pressure | yes | + TInf | free-stream temperature | yes | + gamma | heat capacity ratio (cp/Cv) | yes | + /endtable - N.B. This boundary condition is ill-posed if the free-stream flow is - normal to the boundary. + Example of the boundary condition specification: + \verbatim + myPatch + { + type supersonicFreestream; + UInf 500; + pInf 1e4; + TInf 265; + gamma 1.4; + } + \endverbatim + + \note + This boundary condition is ill-posed if the free-stream flow is normal + to the boundary. SourceFiles supersonicFreestreamFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef supersonicFreestreamFvPatchVectorFields_H @@ -54,7 +81,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class supersonicFreestreamFvPatch Declaration + Class supersonicFreestreamFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class supersonicFreestreamFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 465d875c68..4926c0627a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,16 +21,44 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::surfaceNormalFixedValueFvPatchVectorField Description - Describes a surface normal vector boundary condition by its magnitude. - Note: The value is positive for outward-pointing vectors + This boundary condition provides a surface-normal vector boundary condition + by its magnitude. + + /heading Patch usage + + /table + Property | Description | Required | Default value + refValue | reference value | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type inletOutlet; + refValue -10; // 10 INTO the domain + } + \endverbatim + + \note + Sign conventions: + - the value is positive for outward-pointing vectors + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles surfaceNormalFixedValueFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef surfaceNormalFixedValueFvPatchVectorField_H @@ -45,7 +73,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class surfaceNormalFixedValueFvPatch Declaration + Class surfaceNormalFixedValueFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class surfaceNormalFixedValueFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index ef2ea8b9c9..faa11fa621 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,39 +21,56 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::swirlFlowRateInletVelocityFvPatchVectorField Description - Describes a volumetric/mass flow normal vector boundary condition by its - magnitude as an integral over its area with a swirl component determined - by the RPM + This boundary condition provides a volumetric- OR mass-flow normal vector + boundary condition by its magnitude as an integral over its area with a + swirl component determined by the angular speed, given in revolutions per + minute (RPM) The basis of the patch (volumetric or mass) is determined by the - dimensions of the flux, phi. - The current density is used to correct the velocity when applying the - mass basis. + dimensions of the flux, phi. The current density is used to correct the + velocity when applying the mass basis. + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + flowRate | flow rate profile | yes | + rpm | rotational speed profile | yes | + /endtable Example of the boundary condition specification: \verbatim - inlet + myPatch { type swirlFlowRateInletVelocity; - flowRate constant 0.2; // Vol/mass flow rate [m3/s or kg/s] + flowRate constant 0.2; rpm constant 100; } \endverbatim - The flowRate and rpm entries are DataEntry types, able to describe time - varying functions. The example above gives the usage for supplying - constant values. + \note + - the \c flowRate and \c rpm entries are DataEntry types, able to describe + time varying functions. The example above gives the usage for supplying + constant values. + - the value is positive into the domain -Note - - The value is positive inwards +SeeAlso + Foam::fixedValueFvPatchField SourceFiles swirlFlowRateInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef swirlFlowRateInletVelocityFvPatchVectorField_H @@ -67,7 +84,7 @@ SourceFiles namespace Foam { /*---------------------------------------------------------------------------*\ - Class swirlFlowRateInletVelocityFvPatchVectorField Declaration + Class swirlFlowRateInletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class swirlFlowRateInletVelocityFvPatchVectorField @@ -85,7 +102,7 @@ class swirlFlowRateInletVelocityFvPatchVectorField //- Inlet integral flow rate autoPtr > flowRate_; - //- RPM + //- Angular speed in revolutions per minute (RPM) autoPtr > rpm_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index aa2bec48af..8399a0cf69 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,12 +21,15 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::syringePressureFvPatchScalarField Description - Pressure boundary condition obtained from a 0-D model of the cylinder - of a syringe. + This boundary condition provides a pressure condition, obtained from a + zero-D model of the cylinder of a syringe. The syringe cylinder is defined by its initial volume, piston area and velocity profile specified by regions of constant acceleration, speed @@ -34,28 +37,49 @@ Description pressure and compressibility which is assumed constant, i.e. isothermal expansion/compression. + /heading Patch usage + + /table + Property | Description | Required | Default value + Ap | syringe piston area | yes | + Sp | syringe piston speed | yes | + VsI | initial syringe volume | yes | + tas | start of piston acceleration | yes | + tae | end of piston acceleration | yes | + tds | start of piston deceleration | yes | + tde | end of piston deceleration | yes | + psI | initial syringe pressure | yes | + psi | gas compressibility | yes | + ams | added (or removed) gas mass | yes | + /endtable + Example of the BC specification: \verbatim - outlet - { - type syringePressure; - Ap 1.388e-6; // syringe piston area - Sp 0.01; // syringe piston speed - VsI 1.388e-8; // Initial syringe volume - tas 0.001; // Start of piston acceleration - tae 0.002; // End of piston acceleration - tds 0.005; // Start of piston deceleration - tde 0.006; // end of piston deceleration - psI 1e5; // Initial syringe pressure - psi 1e-5; // Gas compressibility - ams 0; // Added (or removed) gas mass - // Initially 0 but used for restarting. - } + myPatch + { + type syringePressure; + Ap 1.388e-6; // syringe piston area + Sp 0.01; // syringe piston speed + VsI 1.388e-8; // Initial syringe volume + tas 0.001; // Start of piston acceleration + tae 0.002; // End of piston acceleration + tds 0.005; // Start of piston deceleration + tde 0.006; // end of piston deceleration + psI 1e5; // Initial syringe pressure + psi 1e-5; // Gas compressibility + ams 0; // Added (or removed) gas mass + value uniform 0 // Initially 0 but used for restarting + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles syringePressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef syringePressureFvPatchScalarField_H @@ -69,7 +93,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class syringePressureFvPatch Declaration + Class syringePressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class syringePressureFvPatchScalarField @@ -115,7 +139,9 @@ class syringePressureFvPatchScalarField label curTimeIndex_; - //- return the volume of the syringe at time t + // Private Functions + + //- Return the volume of the syringe at time t scalar Vs(const scalar t) const; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index 55364eac5d..f4c97575d3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -21,22 +21,52 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::temperatureJumpFvPatchScalarField Description - Introduce a jump in temperature on a cycle patch - front + This boundary condition provides a temperature jump condition across a + coupled pair of cyclic patches. + + The jump is specified as a \c DataEntry type, to enable the use of, e.g. + contant, polynomial, table values. + + /heading Patch usage + + /table + Property | Description | Required | Default value + patchType | underlying patch type should be \c cyclic| yes | + jump | current jump value | yes | + jumpTable | jump data, e.g. \c csvFile | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch { type temperatureJump; patchType cyclic; jumpTable constant 100; value uniform 300; } + \endverbatim + + The above example shows the use of a constant jump condition. + + \note + The underlying \c patchType should be set to \c cyclic + +SeeAlso + Foam::fixedJumpFvPatchField SourceFiles temperatureJumpFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef temperatureJumpFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 82525ec49a..0d675c0fe5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -21,44 +21,56 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::timeVaryingMappedFixedValueFvPatchField Description - Foam::timeVaryingMappedFixedValueFvPatchField + This boundary conditions interpolates the values from a set of supplied + points in space and time. Supplied data should be specified in + constant/boundaryData/ where: + - points : pointField with locations + - ddd : supplied values at time ddd + The points should be more or less on a plane since they get triangulated + in 2-D. - Interpolates from a set of supplied points in space and time. Supplied - data in constant/boundaryData/: - - points : pointField with locations - - ddd : supplied values at time ddd - Points need to be more or less on a plane since get triangulated in 2D. + At startup, this condition generates the triangulation and performs a + linear interpolation (triangle it is in and weights to the 3 vertices) + for every face centre. - At startup this bc does the triangulation and determines linear - interpolation (triangle it is in and weights to the 3 vertices) - for every face centre. Interpolates linearly inbetween times. + Values are interpolated linearly between times. - @verbatim - inlet - { - type timeVaryingMappedFixedValue; + /heading Patch usage - // Maintain average to that of the supplied values - setAverage false; + /table + Property | Description | Required | Default value + setAverage | flag to activate setting of average value | yes | + perturb | perturb points for regular geometries | no | 1e-5 + fieldTableName | alternative field name to sample | no| this field name + /endtable - // Optional: change perturbation (default 1e-5) to avoid any ties - // in triangulating regular geometries. - //perturb 0.0; - - // Optional: use name instead of patchname for location of data - //fieldTableName samples; - } - @endverbatim + /verbatim + myPatch + { + type timeVaryingMappedFixedValue; + setAverage false; + //perturb 0.0; + //fieldTableName samples; + } + /endverbatim + \note Switch on debug flag to have it dump the triangulation (in transformed space) and transform face centres. +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles timeVaryingMappedFixedValueFvPatchField.C +@} \*---------------------------------------------------------------------------*/ @@ -76,7 +88,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class timeVaryingMappedFixedValueFvPatch Declaration + Class timeVaryingMappedFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template @@ -119,6 +131,7 @@ class timeVaryingMappedFixedValueFvPatchField //- If setAverage: end average value Type endAverage_; + public: //- Runtime type information diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index c95f15771c..715cf3dc75 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,14 +21,108 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::totalPressureFvPatchScalarField Description - Foam::totalPressureFvPatchScalarField + This boundary condition provides a total pressure condition. Four + variants are possible: + + - incompressible subsonic: + \f[ + p_T = p_0 + 0.5*|U|^2 + \f] + where + /vartable + p_T | incompressible total pressure [m2/s2] + p_0 | incompressible reference pressure [m2/s2] + U | velocity + /endvartable + + - compressible subsonic: + \f[ + p_T = p_0 + 0.5*\rho*|U|^2 + \f] + where + /vartable + p_T | total pressure [Pa] + p_0 | reference pressure [Pa] + \rho | density [kg/m3] + U | velocity + /endvartable + + - compressible supersonic (\gamma > 1): + \f[ + p_T = \frac{p_0}{(1 + 0.5*\psi*G)^{\frac{1}{G}}} + \f] + where + /vartable + p_T | total pressure [Pa] + p_0 | reference pressure [Pa] + \psi | compressibility [m2/s2] + G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ + /endvartable + + - compressible transonic (\gamma <= 1): + \f[ + p_T = \frac{p_0}{1 + 0.5*\psi*|U|^2} + \f] + where + /vartable + p_T | total pressure [Pa] + p_0 | reference pressure [Pa] + G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ + /endvartable + + The modes of operation are set via the combination of \c phi, \c rho, and + \c psi entries: + /table + Mode | phi | rho | psi + incompressible subsonic | phi | none | none + compressible subsonic | phi | rho | none + compressible transonic | phi | none | psi + compressible supersonic | phi | none | psi + /endtable + + + /heading Patch usage + + /table + Property | Description | Required | Default value + U | velocity field name | no | U + phi | flux field name | no | phi + rho | density field name | no | none + psi | compressibility field name | no | none + gamma | ratio of specific heats (Cp/Cv) | yes | + p0 | static pressure reference | yes | + /endtable + + \note + The default boundary behaviour is for subsonic, incompressible flow. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type totalPressure; + U U; + phi phi; + rho none; + psi none; + gamma 1.4; + p0 uniform 1e5; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles totalPressureFvPatchScalarField.C +@} \*---------------------------------------------------------------------------*/ @@ -43,7 +137,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class totalPressureFvPatch Declaration + Class totalPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class totalPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index e19d1265e7..d63ca5e606 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,41 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::translatingWallVelocityFvPatchVectorField Description - Foam::translatingWallVelocityFvPatchVectorField + This boundary condition provides a velocity condition for translational + motion on walls. + + /heading Patch usage + + /table + Property | Description | Required | Default value + U | translational velocity | yes| + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type rotatingWallVelocity; + U (100 0 0); + } + \endverbatim + + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles translatingWallVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef translatingWallVelocityFvPatchVectorField_H @@ -43,7 +69,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class translatingWallVelocityFvPatchField Declaration + Class translatingWallVelocityFvPatchField Declaration \*---------------------------------------------------------------------------*/ class translatingWallVelocityFvPatchVectorField @@ -52,7 +78,7 @@ class translatingWallVelocityFvPatchVectorField { // Private data - //- Origin of the rotation + //- Translational velocity vector U_; @@ -124,7 +150,6 @@ public: } - // Member functions // Access functions diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index a7b3272c13..5ab4c643b1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -21,25 +21,59 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::turbulentInletFvPatchField Description - Generate a fluctuating inlet condition by adding a random component - to a reference (mean) field. - Input: - referenceField - Mean field. - fluctuationScale - RMS fluctuation, provided as the fraction of the mean field. - alpha - temporal correlation factor; - the fraction of the new random component added to the previous - time-step (defaults to 0.1). + This boundary condition generates a fluctuating inlet condition by adding + a random component to a reference (mean) field. + + \f[ + x_p = (1 - \alpha)*x_p^{n-1} + \alpha*(x_{ref}+C_{RMS}*s*x_{ref}) + \f] + + where + + /vartable + x_p | patch values + x_{ref} | refernce patch values + n | time level + \alpha | fraction of new random component added to previous time value + C_{RMS} | RMS coefficient + s | fluctuation scale + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + fluctuationScale | RMS fluctuation scale (fraction of mean) | yes | + referenceField | reference (mean) field | yes | + alpha | fraction of new random component added to previous| no| 0.1 + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type turbulentInlet; + fluctuationScale 0.1; + referenceField uniform 10; + alpha 0.1; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles turbulentInletFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef turbulentInletFvPatchField_H @@ -54,7 +88,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class turbulentInletFvPatch Declaration + Class turbulentInletFvPatchField Declaration \*---------------------------------------------------------------------------*/ template @@ -64,10 +98,19 @@ class turbulentInletFvPatchField { // Private data + //- Random number generator Random ranGen_; + + //- Fluctuation scake Type fluctuationScale_; + + //- Reference field Field referenceField_; + + //- Fraction of RMS component to apply to last time step values scalar alpha_; + + //- Current time index (used for updating) label curTimeIndex_; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C index 7d650f6eb7..cb3395f0a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -40,8 +40,8 @@ turbulentIntensityKineticEnergyInletFvPatchScalarField : inletOutletFvPatchScalarField(p, iF), intensity_(0.0), - UName_("undefined-U"), - phiName_("undefined-phi") + UName_("U"), + phiName_("phi") { this->refValue() = 0.0; this->refGrad() = 0.0; @@ -82,12 +82,15 @@ turbulentIntensityKineticEnergyInletFvPatchScalarField ( "turbulentIntensityKineticEnergyInletFvPatchScalarField::" "turbulentIntensityKineticEnergyInletFvPatchScalarField" - "(const fvPatch& p, const DimensionedField& iF, " - "const dictionary& dict)" + "(" + "const fvPatch&, " + "const DimensionedField&, " + "const dictionary& + ")" ) << "Turbulence intensity should be specified as a fraction 0-1 " "of the mean velocity\n" - " value given is " << intensity_ - << "\n on patch " << this->patch().name() + " value given is " << intensity_ << nl + << " on patch " << this->patch().name() << " of field " << this->dimensionedInternalField().name() << " in file " << this->dimensionedInternalField().objectPath() << exit(FatalError); @@ -157,8 +160,8 @@ void Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::write { fvPatchScalarField::write(os); os.writeKeyword("intensity") << intensity_ << token::END_STATEMENT << nl; - os.writeKeyword("U") << UName_ << token::END_STATEMENT << nl; - os.writeKeyword("phi") << phiName_ << token::END_STATEMENT << nl; + writeEntryIfDifferent(os, "U", "U", UName_); + writeEntryIfDifferent(os, "phi", "phi", phiName_); writeEntry("value", os); } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index 1663364d10..ce41bf5972 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,26 +21,58 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField Description - Calculate turbulent kinetic energy from the intensity provided as a - fraction of the mean velocity + This boundary condition provides a turbulent kinetic energy condition, + based on user-supplied turbulence intensity, defined as a fraction of the + mean velocity: + + \f[ + k_p = 1.5*(I)*|U|^2 + \f] + + where + + /vartable + k_p | kinetic energy at the patch + I | turbulence intensity + U | velocity field + /endvartable + + In the event of reverse flow, a zero-gradient condition is applied. + + /heading Patch usage + + /table + Property | Description | Required | Default value + intensity | fraction of mean field [0-1] | yes | + U | velocity field name | no | U + phi | flux field name | no | phi + /endtable Example of the boundary condition specification: \verbatim - inlet - { - type turbulentIntensityKineticEnergyInlet; - intensity 0.05; // 5% turbulence - value uniform 1; // placeholder - } + myPatch + { + type turbulentIntensityKineticEnergyInlet; + intensity 0.05; // 5% turbulence + value uniform 1; // placeholder + } \endverbatim +SeeAlso + Foam::inletOutletFvPatchField + SourceFiles turbulentIntensityKineticEnergyInletFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef turbulentIntensityKineticEnergyInletFvPatchScalarField_H @@ -54,7 +86,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class turbulentIntensityKineticEnergyInletFvPatch Declaration + Class turbulentIntensityKineticEnergyInletFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class turbulentIntensityKineticEnergyInletFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index b199d3e8eb..6fb33ef149 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,19 +21,55 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::uniformDensityHydrostaticPressureFvPatchScalarField Description - Hydrostatic pressure boundary condition calculated as + This boundary condition provides a hydrostatic pressure condition, + calculated as: - pRefValue + rho*g.(x - pRefPoint) + \f[ + p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) + \f] - where rho is provided and assumed uniform. + where + /vartable + p_{hyd} | hyrostatic pressure [Pa] + p_{ref} | reference pressure [Pa] + x_{ref} | reference point in Cartesian co-ordinates + \rho | density (assumed uniform) + g | acceleration due to gravity [m/s2] + /endtable + + /heading Patch usage + + /table + Property | Description | Required | Default value + rho | uniform density [kg/m3] | yes | + pRefValue | reference pressure [Pa] | yes | + pRefPoint | reference pressure location | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type uniformDensityHydrostaticPressure; + rho rho; + pRefValue 1e5; + pRefPoint (0 0 0); + value uniform 0; // optional initial value + } + \endverbatim SourceFiles uniformDensityHydrostaticPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef uniformDensityHydrostaticPressureFvPatchScalarField_H @@ -47,7 +83,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class uniformDensityHydrostaticPressureFvPatch Declaration + Class uniformDensityHydrostaticPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class uniformDensityHydrostaticPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index cd6445babf..593d007dda 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -21,29 +21,45 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::uniformFixedValueFvPatchField Description - Enables the specification of a uniform fixed value boundary condition. + This boundary condition provides a uniform fixed value condition. + + /heading Patch usage + + /table + Property | Description | Required | Default value + uniformValue | uniform value | yes | + /endtable Example of the boundary condition specification: \verbatim - inlet + myPatch { type uniformFixedValue; uniformValue constant 0.2; } \endverbatim + \note The uniformValue entry is a DataEntry type, able to describe time varying functions. The example above gives the usage for supplying a constant value. +SeeAlso + Foam::DataEntry + Foam::fixedValueFvPatchField SourceFiles uniformFixedValueFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef uniformFixedValueFvPatchField_H @@ -58,7 +74,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class uniformFixedValueFvPatch Declaration + Class uniformFixedValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index aa77ffe2ca..7a42d5d42f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,20 +21,61 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::uniformTotalPressureFvPatchScalarField Description - A time-varying form of a uniform total pressure boundary condition. The - variation is specified as an DataEntry (see Foam::DataEntry). + This boundary condition provides a time-varying form of the uniform total + pressure boundary condition. -See Also - Foam::uniformFixedValueFvPatchField.H - and Foam::totalPressureFvPatchScalarField.H + /heading Patch usage + + /table + Property | Description | Required | Default value + U | velocity field name | no | U + phi | flux field name | no | phi + rho | density field name | no | none + psi | compressibility field name | no | none + gamma | ratio of specific heats (Cp/Cv) | yes | + p0 | static pressure reference | yes | + pressure | total pressure as a function of time | yes | + /endtable + + \note + The default boundary behaviour is for subsonic, incompressible flow. + + Example of the boundary condition specification: + \verbatim + myPatch + { + type uniformTotalPressure; + U U; + phi phi; + rho rho; + psi psi; + gamma 1.4; + p0 uniform 1e5; + pressure uniform 0.0; + } + \endverbatim + + + The \c pressure entry is specified as a DataEntry type, able to describe + time varying functions. + +SeeAlso + Foam::DataEntry + Foam::uniformFixedValueFvPatchField + Foam::totalPressureFvPatchField SourceFiles uniformTotalPressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef uniformTotalPressureFvPatchScalarField_H @@ -75,7 +116,7 @@ class uniformTotalPressureFvPatchScalarField //- Heat capacity ratio scalar gamma_; - //- Total pressure + //- Static pressure reference scalar p0_; //- Table of time vs total pressure, including the bounding treatment diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index 51e8c87899..dbbe27dec8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -21,32 +21,51 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::variableHeightFlowRateFvPatchScalarField Description - This boundary condition uses zeroGradient within a specified range of - values for phase fraction alpha. The range is defined within the - boundary condition by the lowerBound and upperBound. + This boundary condition provides a phase fraction condition based on the + local flow conditions, whereby the values are constrained to lay between + user-specified upper and lower bounds. The behaviour is described by: - alpha > upperBound: fixedValue with uniform value of upperBound - lowerBound <= alpha <= upperBound: zeroGradient - alpha < lowerBound: fixedValue with uniform value of lowerBound + if alpha > upperBound: + - apply a fixed value condition, with a uniform level of the upper bound - Example: + if lower bound <= alpha <= upper bound: + - apply a zero-gradient condition + + if alpha < lowerBound: + - apply a fixed value condition, with a uniform level of the lower bound + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + lowerBound | lower bound for clipping | yes | + upperBound | upper bound for clipping | yes | + /endtable + + Example of the boundary condition specification: \verbatim - inlet - { - type clippedZeroGradient; - lowerBound 0.0; - upperBound 0.9; - value uniform 0; - } + myPatch + { + type variableHeightFlowRate; + lowerBound 0.0; + upperBound 0.9; + value uniform 0; + } \verbatim SourceFiles variableHeightFlowRateFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef variableHeightFlowRateFvPatchScalarField_H @@ -60,7 +79,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class variableHeightFlowRateFvPatchScalar Declaration + Class variableHeightFlowRateFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class variableHeightFlowRateFvPatchScalarField @@ -81,6 +100,7 @@ protected: //- Upper bound for alpha1 scalar upperBound_; + public: //- Runtime scalar information @@ -156,10 +176,6 @@ public: //- Write virtual void write(Ostream&) const; - - - // Member operators - }; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.C b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.C index b33bbc65f1..9b0a6694e7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.C @@ -121,8 +121,10 @@ void Foam::variableHeightFlowRateInletVelocityFvPatchVectorField } -void Foam::variableHeightFlowRateInletVelocityFvPatchVectorField -::write(Ostream& os) const +void Foam::variableHeightFlowRateInletVelocityFvPatchVectorField::write +( + Ostream& os +) const { fvPatchField::write(os); diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index d1bc1ac62f..ddac63287e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -22,39 +22,50 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +\addtogroup boundaryConditions +@{ + Class Foam::variableHeightFlowRateInletVelocityFvPatchVectorField Description - Describes a volumetric/mass flow normal vector boundary condition by its - magnitude as an integral over its area. + This boundary condition provides a velocity boundary condition for + multphase flow based on a user-specified volumetric flow rate. - The basis of the patch (volumetric or mass) is determined by the - dimensions of the flux, phi. - The current density is used to correct the velocity when applying the - mass basis. + The flow rate is made proportional to the phase fraction alpha at each + face of the patch and alpha is ensured to be bound between 0 and 1. - The flow rate is made proportional to the phase fraction alpha at each face - of the patch and alpha is ensured to be bound between 0 and 1. + /heading Patch usage + + /table + Property | Description | Required | Default value + flowRate | volumetric flow rate [m3/s] | yes | + /endtable Example of the boundary condition specification: \verbatim - inlet + myPatch { type variableHeightFlowRateInletVelocity; - flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s] + flowRate 0.2; value uniform (0 0 0); // placeholder } \endverbatim -Note - - The value is positive inwards - - May not work correctly for transonic inlets - - Strange behaviour with potentialFoam since the U equation is not solved + \note + - the value is positive into the domain + - may not work correctly for transonic inlets + - strange behaviour with potentialFoam since the momentum equation is + not solved + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles variableHeightFlowRateInletVelocityFvPatchVectorField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef variableHeightFlowRateInletVelocityFvPatchVectorField_H @@ -67,7 +78,7 @@ SourceFiles namespace Foam { /*---------------------------------------------------------------------------*\ - Class variableHeightFlowRateInletVelocityFvPatch Declaration + Class variableHeightFlowRateInletVelocityFvPatchVectorField Declaration \*---------------------------------------------------------------------------*/ class variableHeightFlowRateInletVelocityFvPatchVectorField @@ -79,6 +90,7 @@ class variableHeightFlowRateInletVelocityFvPatchVectorField //- Inlet integral flow rate scalar flowRate_; + public: //- Runtime type information @@ -174,7 +186,6 @@ public: //- Write virtual void write(Ostream&) const; - }; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 567b17dde7..eca1439431 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::waveSurfacePressureFvPatchScalarField @@ -29,34 +32,50 @@ Description the hydrostatic pressure based on a given displacement: \f[ - p = -rho*g*zeta + p = -\rho*g*\zeta \f] - where - \var g = acceleration due to gravity [m/s2] - \var zeta = wave amplitude [m] + /vartable + \rho | density [kg/m3] + g | acceleration due to gravity [m/s2] + \zeta | wave amplitude [m] + /endvartable The wave amplitude is updated as part of the calculation, derived from the local volumetric flux. + + /heading Patch usage + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + zeta | wave amplitude field name | no | zeta + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type waveSurfacePressure; - phi phi; // name of flux field (default = phi) - rho rho; // name of density field (default = rho) - zeta zeta; // name amplitude field (default = zeta) - value uniform 0; // place holder - } + myPatch + { + type waveSurfacePressure; + phi phi; + rho rho; + zeta zeta; + value uniform 0; // place holder + } \endverbatim The density field is only required if the flux is mass-based as opposed to volumetric-based. +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles waveSurfacePressureFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef waveSurfacePressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 6cd00aac55..2325e383fd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,15 +21,61 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup boundaryConditions +@{ + Class Foam::waveTransmissiveFvPatchField Description - Foam::waveTransmissiveFvPatchField + This boundary condition provides a wave transmissive outflow condition, + based onsolving DDt(psi, U) = 0 at the boundary. + + The wave speed is calculated using: + + \f[ + x_p = \frac{\phi_p}{|Sf|} + \sqrt{\frac{\gamma}{\psi_p}} + \f] + + where + + /vartable + x_p | patch values + \phi_p | patch face flux + \psi_p | patch compressibility + Sf | patch face area vector + \gamma | ratio of specific heats + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | flux field name | no | phi + rho | density field name | no | rho + psi | compressibility field name | no | psi + gamma | ratio of specific heats (Cp/Cv) | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type waveTransmissive; + phi phi; + psi psi; + gamma 1.4; + } + \endverbatim + +SeeAlso + Foam::advectiveFvPatchField SourceFiles waveTransmissiveFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef waveTransmissiveFvPatchField_H @@ -43,7 +89,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class waveTransmissiveFvPatch Declaration + Class waveTransmissiveFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H index 369246d3b0..ed9b605588 100644 --- a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H @@ -21,6 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\defgroup boundaryConditions Boundary Conditions +@{ + This group contains OpenFOAM boundary condition types +@} + Class Foam::fvPatchField From 55b87980c275e8956e8443630b018044ea4d0650 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 11:42:58 +0100 Subject: [PATCH 024/109] ENH: Added documentation file for incompressible wall functions --- .../incompressibleWallFunctionsDoc.H | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H new file mode 100644 index 0000000000..a42b86f9ee --- /dev/null +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup icoWallFunctions RAS incompressible wall functions +@{ + \ingroup boundaryConditions + This group contains incompressible RAS turbulence model wall functions +@} + +\*---------------------------------------------------------------------------*/ From 7f84940b5ce5cee09359a2783277fea1bd7b6855 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 11:44:06 +0100 Subject: [PATCH 025/109] ENH: Boundary condition doxygen documentation updates - incompressible wall functions --- .../epsilonWallFunctionFvPatchScalarField.H | 41 ++++++++++----- ...ayatillekeWallFunctionFvPatchScalarField.H | 35 +++++++++++-- .../kqRWallFunctionFvPatchField.H | 24 +++++++-- .../nutLowReWallFunctionFvPatchScalarField.H | 23 ++++++-- .../nutURoughWallFunctionFvPatchScalarField.H | 31 ++++++++++- ...tUSpaldingWallFunctionFvPatchScalarField.H | 23 +++++++- ...UTabulatedWallFunctionFvPatchScalarField.H | 35 +++++++++++-- .../nutUWallFunctionFvPatchScalarField.H | 23 +++++++- .../nutWallFunctionFvPatchScalarField.H | 22 +++++++- ...tkAtmRoughWallFunctionFvPatchScalarField.C | 1 - ...tkAtmRoughWallFunctionFvPatchScalarField.H | 52 ++++++++++++++----- .../nutkRoughWallFunctionFvPatchScalarField.H | 39 +++++++++++--- .../nutkWallFunctionFvPatchScalarField.H | 22 +++++++- .../omegaWallFunctionFvPatchScalarField.H | 40 +++++++++++--- 14 files changed, 350 insertions(+), 61 deletions(-) diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index f7649261c3..be75c4f45e 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::epsilonWallFunctionFvPatchScalarField @@ -29,29 +32,43 @@ Description condition for high Reynolds number, turbulent flow cases. The condition can be applied to wall boundaries, whereby it - \li calculates \c epsilon and \c G - \li inserts near wall epsilon values directly into the epsilon equation + - calculates \c epsilon and \c G + - inserts near wall epsilon values directly into the epsilon equation to act as a constraint where - \var epsilon = turblence dissipation field - \var G = turblence generation field + + /vartable + epsilon | turblence dissipation field + G | turblence generation field + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + G | turbulence generation field name | no | G + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type epsilonWallFunction; - G G; // turblence generation field (default = G) - Cmu 0.09; // Cmu model coefficient (default = 0.09) - kappa 0.41; // Von Karman constant (default = 0.41) - E 9.8; // E coefficient (default = 9.8) - } + myPatch + { + type epsilonWallFunction; + } \endverbatim +SeeAlso + Foam::fixedInternalValueFvPatchField + SourceFiles epsilonWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef epsilonWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index d9ba225361..bbc105b147 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,19 +21,46 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels:: kappatJayatillekeWallFunctionFvPatchScalarField Description - Boundary condition for (kinematic) turbulent thermal conductivity when - using wall functions, using Jayatilleke P function. + This boundary condition provides a kinematic turbulent thermal conductivity + for using wall functions, using the Jayatilleke 'P' function. - Units of m2/s + \note + The units of kinematic turbulent thermal conductivity are m2/s + + /heading Patch usage + + /table + Property | Description | Required | Default value + Prt | turbulent Prandtl number | no | 0.85 + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type kappatJayatillekeWallFunction; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles kappatJayatillekeWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef kappatJayatillekeWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 292fe79a89..2e8fa43368 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,16 +21,34 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::kqRWallFunctionFvPatchField Description - Boundary condition for turbulence k, Q, and R when using wall functions. - Simply acts as a zero gradient condition. + This boundary condition is applied to turbulence \c k, \c Q, and \c R + when using wall functions, and simply enforces a zer-gradient condition. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type kqRWallFunction; + } + \endverbatim + +SeeAlso + Foam::zeroGradientFvPatchField SourceFiles kqRWallFunctionFvPatchField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef kqRWallFunctionFvPatchField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 1dc153b0b9..22384c7e66 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -21,18 +21,35 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutLowReWallFunctionFvPatchScalarField Description - Boundary condition for turbulent (kinematic) viscosity when for use with - low Reynolds number models. + This boundary condition provides a turbulent kinematic viscosity condition + for use with low Reynolds number models. It sets \c nut to zero, and + provides an access function to calculate y+. - Sets nut to zero, and provides an access function to calculate y+. + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutLowReWallFunction; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField SourceFiles nutLowReWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutLowReWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index ea00181a21..afd24b2826 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -21,15 +21,44 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutURoughWallFunctionFvPatchScalarField Description - Wall function boundary condition for rough walls, based on velocity. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions for rough walls, based on velocity. + + /heading Patch usage + + /table + Property | Description | Required | Default value + roughnessHeight | roughness height | yes | + roughnessConstant | roughness constanr | yes | + roughnessFactor | scaling factor | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutURoughWallFunction; + roughnessHeight 1e-5; + roughnessConstant 0.5; + roughnessFactor 1; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField SourceFiles nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutURoughWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index 983ecc57ae..711d6785ac 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -21,16 +21,35 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutUSpaldingWallFunctionFvPatchScalarField Description - Wall function boundary condition for walls, based on velocity, using + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions for rough walls, based on velocity, using Spaldings law to give a continuous nut profile to the wall (y+ = 0) + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutUSpaldingWallFunction; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField + SourceFiles nutUSpaldingWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutUSpaldingWallFunctionFvPatchScalarField_H @@ -48,7 +67,7 @@ namespace RASModels { /*---------------------------------------------------------------------------*\ - Class nutUSpaldingWallFunctionFvPatch Declaration + Class nutUSpaldingWallFunctionFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class nutUSpaldingWallFunctionFvPatchScalarField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index a164366d7c..d23dd8138d 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -21,19 +21,46 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutUTabulatedWallFunctionFvPatchScalarField Description - Wall function boundary condition for turbulence kinematic viscosity. Uses a - table to return the value of U+ as a function of near-wall Reynolds number. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions. As input, the user specifies a look-up table + of U+ as a function of near-wall Reynolds number. The table should be + located in the $FOAM_CASE/constant folder. - Note: the tables are not registered since the same table object may be used - for more than one patch. + \note + the tables are not registered since the same table object may be used for + more than one patch. + + /heading Patch usage + + /table + Property | Description | Required | Default value + uPlusTable | U+ as a function of Re table name | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutTabulatedWallFunction; + uPlusTable myUPlusTable; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField SourceFiles nutUTabulatedWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutUTabulatedWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index 4ebf730636..6629e101a7 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -21,15 +21,34 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutUWallFunctionFvPatchScalarField Description - Wall function boundary condition for walls, based on velocity. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions, based on velocity. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutUWallFunction; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField SourceFiles nutUWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutUWallFunctionFvPatchScalarField_H @@ -47,7 +66,7 @@ namespace RASModels { /*---------------------------------------------------------------------------*\ - Class nutUWallFunctionFvPatchScalarField Declaration + Class nutUWallFunctionFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class nutUWallFunctionFvPatchScalarField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index a6e196472e..ad53fdf3c4 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -21,17 +21,35 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutWallFunctionFvPatchScalarField Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions, based on turbulence kinetic energy. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutWallFunction; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles nutWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.C b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.C index 035bd813d7..b00e9f0bf9 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.C +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.C @@ -40,7 +40,6 @@ namespace RASModels // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // - tmp nutkAtmRoughWallFunctionFvPatchScalarField::calcNut() const { const label patchI = patch().index(); diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index a4c2aaa936..a6dda6a5cc 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -21,28 +21,56 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels:: nutkAtmRoughWallFunctionFvPatchScalarField Description - Boundary condition for turbulent (kinematic) viscosity for atmospheric - velocity profiles. - Desinged to be used togheter with atmBoundaryLayerInletVelocity. - It follows U = (Ustar/K) ln((z - zGround + z0)/z0) + This boundary condition provides a turbulent kinematic viscosity for + atmospheric velocity profiles. It is desinged to be used in conjunction + with the atmBoundaryLayerInletVelocity boundary condition. The values + are calculated using: - where: + \f[ + U = (U_f/K) ln((z + z_0)/z_0) + \f] - Ustar is the frictional velocity - K is karman's constant - z0 is the surface roughness lenght - z is the verical coordinate - zGround is the minumum coordinate value in z direction. + where + /vartable + U_f | frictional velocity + K | Von Karman's constant + z_0 | surface roughness length + z | vertical co-ordinate + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + z0 | surface roughness length| yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutkAtmRoughWallFunction; + z0 uniform 0; + } + \endverbatim + +SeeAlso + Foam::nutkWallFunctionFvPatchField SourceFiles nutkAtmRoughWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutkAtmRoughWallFunctionFvPatchScalarField_H @@ -60,7 +88,7 @@ namespace RASModels { /*---------------------------------------------------------------------------*\ - Class nutkAtmRoughWallFunctionFvPatchScalarField Declaration + Class nutkAtmRoughWallFunctionFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class nutkAtmRoughWallFunctionFvPatchScalarField @@ -71,7 +99,7 @@ protected: // Protected data - //- Surface roughness lenght + //- Surface roughness length scalarField z0_; diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index ad39e628a2..183a331fc0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,22 +21,47 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutkRoughWallFunctionFvPatchScalarField Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions for rough walls, based on turbulence kinetic energy. - - Manipulates the E parameter to account for roughness effects, based on - KsPlus. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions for rough walls, based on turbulence kinetic + energy. The condition manipulates the E parameter to account for roughness effects. + Parameter ranges - roughness height = sand-grain roughness (0 for smooth walls) - - roughness constant = 0.5-1.0 (0.5 default) + - roughness constant = 0.5-1.0 + + /heading Patch usage + + /table + Property | Description | Required | Default value + Ks | sand-grain roughness height | yes | + Cs | roughness constant | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutkAtmRoughWallFunction; + Ks uniform 0; + Cs uniform 0.5; + } + \endverbatim + +SeeAlso + Foam::nutkRoughWallFunctionFvPatchScalarField SourceFiles nutkRoughWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutkRoughWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index d4ffd6167a..6bb4bf5209 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -21,17 +21,35 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::nutkWallFunctionFvPatchScalarField Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions, based on turbulence kinetic energy. + This boundary condition provides a turbulent kinematic viscosity condition + when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutkWallFunction; + } + \endverbatim + +SeeAlso + Foam::nutWallFunctionFvPatchScalarField + SourceFiles nutkWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef nutkWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index 41f1d0027d..acc0b5e5c1 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -21,19 +21,26 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup icoWallFunctions +@{ + Class Foam::incompressible::RASModels::omegaWallFunctionFvPatchScalarField Description - Provides a wall function boundary condition/constraint on omega + This boundary condition provides a wall function constraint on turbulnce + specific dissipation, omega. The values are computed using: - Computed value is: - - omega = sqrt(omega_vis^2 + omega_log^2) + \f[ + \omega = sqrt(\omega_{vis}^2 + \omega_{log}^2) + \f] where - omega_vis = omega in viscous region - omega_log = omega in logarithmic region + + /vartable + \omega_{vis} | omega in viscous region + \omega_{log} | omega in logarithmic region + /endvartable Model described by Eq.(15) of: \verbatim @@ -43,9 +50,30 @@ Description Nov. 2001 \endverbatim + /heading Patch usage + + /table + Property | Description | Required | Default value + G | turbulence generation field name | no | G + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + beta1 | model coefficient | no | 0.075 + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type omegaWallFunction; + } + \endverbatim + SourceFiles omegaWallFunctionFvPatchScalarField.C +@} + \*---------------------------------------------------------------------------*/ #ifndef omegaWallFunctionFvPatchScalarField_H From 5ebb8dc482ffa6295b08a5e20529b86620f9f29d Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 11:46:34 +0100 Subject: [PATCH 026/109] ENH: Added documentation file for function objects --- .../functionObject/functionObjectsDoc.H | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H new file mode 100644 index 0000000000..54375696a8 --- /dev/null +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H @@ -0,0 +1,29 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup functionObjects Function objects +@{ + This group contains function objects +@} + +\*---------------------------------------------------------------------------*/ From 354d0ae7ce79b8c2c983d5fe8f2393994c634ded Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 12:26:08 +0100 Subject: [PATCH 027/109] ENH: First pass through doxygen info updates for function objects --- .../functionObjects/IO/partialWrite/partialWrite.H | 6 +++++- .../removeRegisteredObject/removeRegisteredObject.H | 4 ++++ .../writeRegisteredObject/writeRegisteredObject.H | 6 +++++- .../functionObjects/cloud/cloudInfo/cloudInfo.H | 13 ++++++++----- .../field/fieldAverage/fieldAverage/fieldAverage.H | 4 ++++ .../fieldCoordinateSystemTransform.H | 8 ++++++-- .../functionObjects/field/fieldMinMax/fieldMinMax.H | 6 +++++- .../field/fieldValues/fieldValue/fieldValue.H | 6 +++++- .../field/nearWallFields/nearWallFields.H | 6 +++++- .../field/processorField/processorField.H | 6 +++++- .../functionObjects/field/readFields/readFields.H | 6 +++++- .../regionSizeDistribution/regionSizeDistribution.H | 4 ++++ .../functionObjects/field/streamLine/streamLine.H | 4 ++++ .../surfaceInterpolateFields.H | 4 ++++ .../field/turbulenceFields/turbulenceFields.H | 4 ++++ .../wallBoundedStreamLine/wallBoundedStreamLine.H | 4 ++++ .../forces/forceCoeffs/forceCoeffs.H | 6 +++++- .../functionObjects/forces/forces/forces.H | 6 +++++- .../jobControl/abortCalculation/abortCalculation.H | 6 +++++- .../functionObjects/systemCall/systemCall.H | 6 +++++- .../codedFunctionObject/codedFunctionObject.H | 5 +++++ .../utilities/dsmcFields/dsmcFields.H | 7 ++++++- .../pressureCoefficient/pressureCoefficient.H | 10 ++++++++-- .../utilities/staticPressure/staticPressure.H | 6 +++++- .../timeActivatedFileUpdate.H | 6 +++++- .../functionObjects/utilities/yPlusLES/yPlusLES.H | 4 ++++ .../functionObjects/utilities/yPlusRAS/yPlusRAS.H | 4 ++++ src/sampling/probes/probes.H | 6 +++++- src/sampling/sampledSet/sampledSet/sampledSet.H | 4 ++++ .../sampledSurface/sampledSurface/sampledSurface.H | 4 ++++ 30 files changed, 147 insertions(+), 24 deletions(-) diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index 40538f20ee..4c25bf7460 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::partialWrite @@ -33,6 +36,7 @@ Description SourceFiles partialWrite.C IOpartialWrite.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index 79bed8aa1c..dd0a4211f2 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::removeRegisteredObject @@ -30,6 +33,7 @@ Description SourceFiles removeRegisteredObject.C IOremoveRegisteredObject.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index a33441ae33..c4eb8d5c58 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::writeRegisteredObject @@ -30,6 +33,7 @@ Description SourceFiles writeRegisteredObject.C IOwriteRegisteredObject.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 04e6468d68..2e95f56a58 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -21,19 +21,22 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::cloudInfo Description - Outputs cloud information to file - - Currently outputs: - - total current number of parcels - - total current mass of parcels + This function object outputs lagrangian cloud information to a file. The + current outputs include: + - total current number of parcels + - total current mass of parcels SourceFiles cloudInfo.C IOcloudInfo.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 3e0ddad528..c56fda7685 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::fieldAverage @@ -79,6 +82,7 @@ Description SourceFiles fieldAverage.C fieldAverageTemplates.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 138d2d09d5..696618bb3f 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,7 +21,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Class +\addtogroup functionObjects +@{ + +class Foam::fieldCoordinateSystemTransform Description @@ -31,6 +34,7 @@ Description SourceFiles fieldCoordinateSystemTransform.C IOfieldCoordinateSystemTransform.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 3cccb9668d..71d155b193 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::fieldMinMax @@ -36,6 +39,7 @@ Description SourceFiles fieldMinMax.C IOfieldMinMax.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index 44e6c6a895..ca765d8f64 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::fieldValue @@ -29,6 +32,7 @@ Description SourceFiles fieldValue.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 11feb11041..7815857b5c 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::nearWallFields @@ -53,6 +56,7 @@ Description SourceFiles nearWallFields.C IOnearWallFields.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index a51b17f969..cdbb8a98e4 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::processorField @@ -31,6 +34,7 @@ Description SourceFiles processorField.C IOprocessorField.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 56232ec51d..d7bf664fd3 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::readFields @@ -31,6 +34,7 @@ Description SourceFiles readFields.C IOreadFields.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 033b5f9aec..e51f4729bc 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::regionSizeDistribution @@ -33,6 +36,7 @@ Description SourceFiles regionSizeDistribution.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index f4fb4e42dc..b912caf0c4 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::streamLine @@ -29,6 +32,7 @@ Description SourceFiles streamLine.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index a49a86e8bc..97839a198e 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::surfaceInterpolateFields @@ -49,6 +52,7 @@ Description SourceFiles surfaceInterpolateFields.C IOsurfaceInterpolateFields.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index e62ee5b174..a82f53b290 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::turbulenceFields @@ -34,6 +37,7 @@ Description SourceFiles turbulenceFields.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index bb130b985d..12d19f8d62 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::wallBoundedStreamLine @@ -29,6 +32,7 @@ Description SourceFiles wallBoundedStreamLine.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index 59c064c407..a6342f86e8 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::forceCoeffs @@ -31,6 +34,7 @@ Description SourceFiles forceCoeffs.C IOforceCoeffs.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index 3d14768b2b..bae6652c3a 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::forces @@ -51,6 +54,7 @@ Note SourceFiles forces.C IOforces.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 408674eba6..ddabedf35b 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::abortCalculation @@ -36,6 +39,7 @@ Description SourceFiles abortCalculation.C IOabortCalculation.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index 9baf118ef8..bd0147b78f 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::systemCall @@ -30,6 +33,7 @@ Description SourceFiles systemCall.C IOsystemCall.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 52a202df54..2c2dfe8306 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::codedFunctionObject @@ -29,6 +32,7 @@ Description SourceFiles codedFunctionObject.C +@} \*---------------------------------------------------------------------------*/ @@ -90,6 +94,7 @@ protected: // Get the dictionary to initialize the codeContext virtual const dictionary& codeDict() const; + private: //- Disallow default bitwise copy construct diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index 548a83df5c..e197cc6924 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::dsmcFields @@ -35,6 +38,7 @@ Description SourceFiles dsmcFields.C IOdsmcFields.H +@} \*---------------------------------------------------------------------------*/ @@ -69,6 +73,7 @@ class dsmcFields //- on/off switch bool active_; + // Private Member Functions //- Disallow default bitwise copy construct diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 7d72e3b784..8cf05389cb 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -21,13 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::pressureCoefficient Description - Calculates pressure coefficient, c_p + Calculates pressure coefficient, \f$c_p\f$ - c_p = p/p_dyn,inf + \f[ + c_p = p/p_{dyn,inf} + \f] where: @@ -36,6 +41,7 @@ Description SourceFiles pressureCoefficient.C IOpressureCoefficient.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 34e1a0fda6..5de19c4583 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::staticPressure @@ -33,6 +36,7 @@ Description SourceFiles staticPressure.C IOstaticPressure.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index d9a5b071f5..b350f012a1 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::timeActivatedFileUpdate @@ -50,6 +53,7 @@ Description SourceFiles timeActivatedFileUpdate.C IOtimeActivatedFileUpdate.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index 5ab936ab7e..d353e9bf9c 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::yPlusLES @@ -31,6 +34,7 @@ Description SourceFiles yPlusLES.C IOyPlusLES.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 2be6293424..2a2c03ea1c 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::yPlusRAS @@ -31,6 +34,7 @@ Description SourceFiles yPlusRAS.C IOyPlusRAS.H +@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/probes/probes.H b/src/sampling/probes/probes.H index 2bcebe1674..18200ddcd7 100644 --- a/src/sampling/probes/probes.H +++ b/src/sampling/probes/probes.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::probes @@ -31,6 +34,7 @@ Description SourceFiles probes.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSet/sampledSet/sampledSet.H b/src/sampling/sampledSet/sampledSet/sampledSet.H index 953f65d77e..461e3c1ee3 100644 --- a/src/sampling/sampledSet/sampledSet/sampledSet.H +++ b/src/sampling/sampledSet/sampledSet/sampledSet.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::sampledSet @@ -35,6 +38,7 @@ Description SourceFiles sampledSet.C +@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H index 9843143107..fe820c1b5d 100644 --- a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H +++ b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +\addtogroup functionObjects +@{ + Class Foam::sampledSurface @@ -43,6 +46,7 @@ Description SourceFiles sampledSurface.C sampledSurfaceTemplates.C +@} \*---------------------------------------------------------------------------*/ From 61eaea8b81599feee11f4f6437343a0d95600eb6 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 14:02:11 +0100 Subject: [PATCH 028/109] ENH: restructured doxygen entries for function objects --- .../functionObjects/IO/IOFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../IO/partialWrite/partialWrite.H | 2 +- .../removeRegisteredObject.H | 2 +- .../writeRegisteredObject.H | 2 +- .../cloud/cloudFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../cloud/cloudInfo/cloudInfo.H | 2 +- .../fieldAverage/fieldAverage/fieldAverage.H | 2 +- .../fieldCoordinateSystemTransform.H | 2 +- .../field/fieldFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../field/fieldMinMax/fieldMinMax.H | 2 +- .../field/fieldValues/fieldValue/fieldValue.H | 2 +- .../field/nearWallFields/nearWallFields.H | 2 +- .../field/processorField/processorField.H | 2 +- .../field/readFields/readFields.H | 2 +- .../regionSizeDistribution.H | 2 +- .../field/streamLine/streamLine.H | 2 +- .../surfaceInterpolateFields.H | 2 +- .../field/turbulenceFields/turbulenceFields.H | 2 +- .../wallBoundedStreamLine.H | 2 +- .../forces/forceCoeffs/forceCoeffs.H | 2 +- .../functionObjects/forces/forces/forces.H | 2 +- .../forces/forcesFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../abortCalculation/abortCalculation.H | 2 +- .../jobControl/jobControlFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../codedFunctionObject/codedFunctionObject.H | 2 +- .../utilities/dsmcFields/dsmcFields.H | 2 +- .../pressureCoefficient/pressureCoefficient.H | 2 +- .../utilities/staticPressure/staticPressure.H | 2 +- .../timeActivatedFileUpdate.H | 2 +- .../utilities/utilitiesFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../utilities/yPlusLES/yPlusLES.H | 2 +- .../utilities/yPlusRAS/yPlusRAS.H | 2 +- 32 files changed, 206 insertions(+), 26 deletions(-) create mode 100644 src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H diff --git a/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H b/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H new file mode 100644 index 0000000000..70daa827dc --- /dev/null +++ b/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup IOFunctionObjects Input/outuput function objects +@{ + \ingroup functionObjects + This group contains input/output-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index 4c25bf7460..d34a0462ed 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index dd0a4211f2..b773fb9a7f 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index c4eb8d5c58..a646e171af 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H b/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H new file mode 100644 index 0000000000..861ec1597c --- /dev/null +++ b/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup cloudFunctionObjects Cloud function objects +@{ + \ingroup functionObjects + This group contains cloud-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 2e95f56a58..0342de2196 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup cloudFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index c56fda7685..17184c407b 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 696618bb3f..0d6bf886c1 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ class diff --git a/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H b/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H new file mode 100644 index 0000000000..89354bbb53 --- /dev/null +++ b/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup fieldFunctionObjects Field function objects +@{ + \ingroup functionObjects + This group contains field-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 71d155b193..92f2224cf8 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index ca765d8f64..b591c809c9 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 7815857b5c..5ed2009877 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index cdbb8a98e4..0884e31ef6 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index d7bf664fd3..772b6b8eda 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index e51f4729bc..2704dbc858 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index b912caf0c4..abbb974413 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 97839a198e..10bc0cbdaf 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index a82f53b290..85a0cd2227 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 12d19f8d62..38847c1266 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index a6342f86e8..b90ff9ee9d 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup forcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index bae6652c3a..15fd54ebdf 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup forcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H new file mode 100644 index 0000000000..43130004c3 --- /dev/null +++ b/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup forcesFunctionObjects Forces function objects +@{ + \ingroup functionObjects + This group contains force-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index ddabedf35b..9d4db70ae2 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup jobControlFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H b/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H new file mode 100644 index 0000000000..3dd25c6fed --- /dev/null +++ b/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup jobControlFunctionObjects Job control function objects +@{ + \ingroup functionObjects + This group contains job control-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 2c2dfe8306..8b8e8c9934 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index e197cc6924..f780c13b54 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 8cf05389cb..690a32d927 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 5de19c4583..480cb661e9 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index b350f012a1..6b59273e7a 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H new file mode 100644 index 0000000000..b51693bedf --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H @@ -0,0 +1,30 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\defgroup utilitiesFunctionObjects Utility function objects +@{ + \ingroup functionObjects + This group contains utility-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index d353e9bf9c..f45d018457 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 2a2c03ea1c..c40d8b2182 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class From c448ba6505867b2385cc77c038501493b54a89c1 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 09:58:05 +0100 Subject: [PATCH 029/109] STYLE: change of doxygen tag boundaryConditions->grpBoundaryConditions --- .../basic/basicSymmetry/basicSymmetryFvPatchField.H | 2 +- .../fvPatchFields/basic/calculated/calculatedFvPatchField.H | 2 +- .../fields/fvPatchFields/basic/coupled/coupledFvPatchField.H | 2 +- .../basic/directionMixed/directionMixedFvPatchField.H | 2 +- .../basic/fixedGradient/fixedGradientFvPatchField.H | 2 +- .../fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H | 2 +- .../fields/fvPatchFields/basic/mixed/mixedFvPatchField.H | 2 +- .../fields/fvPatchFields/basic/sliced/slicedFvPatchField.H | 2 +- .../fvPatchFields/basic/transform/transformFvPatchField.H | 2 +- .../fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H | 2 +- .../fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H | 2 +- .../fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H | 2 +- .../constraint/cyclicSlip/cyclicSlipFvPatchField.H | 2 +- .../fields/fvPatchFields/constraint/empty/emptyFvPatchField.H | 2 +- .../constraint/jumpCyclic/jumpCyclicFvPatchField.H | 2 +- .../nonuniformTransformCyclicFvPatchField.H | 2 +- .../fvPatchFields/constraint/processor/processorFvPatchField.H | 2 +- .../constraint/processorCyclic/processorCyclicFvPatchField.H | 2 +- .../fvPatchFields/constraint/symmetry/symmetryFvPatchField.H | 2 +- .../fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H | 2 +- .../activeBaffleVelocityFvPatchVectorField.H | 2 +- .../activePressureForceBaffleVelocityFvPatchVectorField.H | 2 +- .../fvPatchFields/derived/advective/advectiveFvPatchField.H | 2 +- .../derived/buoyantPressure/buoyantPressureFvPatchScalarField.H | 2 +- .../derived/codedFixedValue/codedFixedValueFvPatchField.H | 2 +- .../fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H | 2 +- .../cylindricalInletVelocityFvPatchVectorField.H | 2 +- .../fields/fvPatchFields/derived/fan/fanFvPatchField.H | 2 +- .../fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H | 2 +- .../fixedInternalValueFvPatchField.H | 2 +- .../fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H | 2 +- .../fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H | 2 +- .../derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H | 2 +- .../fixedPressureCompressibleDensityFvPatchScalarField.H | 2 +- .../flowRateInletVelocityFvPatchVectorField.H | 2 +- .../fluxCorrectedVelocityFvPatchVectorField.H | 2 +- .../fvPatchFields/derived/freestream/freestreamFvPatchField.H | 2 +- .../freestreamPressure/freestreamPressureFvPatchScalarField.H | 2 +- .../fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H | 2 +- .../inletOutletTotalTemperatureFvPatchScalarField.H | 2 +- .../fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H | 2 +- .../mappedFixedInternalValueFvPatchField.H | 2 +- .../mappedFixedPushedInternalValueFvPatchField.H | 2 +- .../derived/mappedFixedValue/mappedFixedValueFvPatchField.H | 2 +- .../derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H | 2 +- .../mappedVelocityFluxFixedValueFvPatchField.H | 2 +- .../movingWallVelocity/movingWallVelocityFvPatchVectorField.H | 2 +- .../multiphaseFixedFluxPressureFvPatchScalarField.H | 2 +- .../oscillatingFixedValue/oscillatingFixedValueFvPatchField.H | 2 +- .../fvPatchFields/derived/outletInlet/outletInletFvPatchField.H | 2 +- .../outletMappedUniformInletFvPatchField.H | 2 +- .../fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H | 2 +- .../phaseHydrostaticPressureFvPatchScalarField.H | 2 +- .../pressureDirectedInletOutletVelocityFvPatchVectorField.H | 2 +- .../pressureDirectedInletVelocityFvPatchVectorField.H | 2 +- .../pressureInletOutletParSlipVelocityFvPatchVectorField.H | 2 +- .../pressureInletOutletVelocityFvPatchVectorField.H | 2 +- .../pressureInletUniformVelocityFvPatchVectorField.H | 2 +- .../pressureInletVelocityFvPatchVectorField.H | 2 +- .../pressureNormalInletOutletVelocityFvPatchVectorField.H | 2 +- .../rotatingPressureInletOutletVelocityFvPatchVectorField.H | 2 +- .../rotatingTotalPressureFvPatchScalarField.H | 2 +- .../rotatingWallVelocityFvPatchVectorField.H | 2 +- .../fields/fvPatchFields/derived/slip/slipFvPatchField.H | 2 +- .../supersonicFreestreamFvPatchVectorField.H | 2 +- .../surfaceNormalFixedValueFvPatchVectorField.H | 2 +- .../swirlFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../derived/syringePressure/syringePressureFvPatchScalarField.H | 2 +- .../derived/temperatureJump/temperatureJumpFvPatchScalarField.H | 2 +- .../timeVaryingMappedFixedValueFvPatchField.H | 2 +- .../derived/totalPressure/totalPressureFvPatchScalarField.H | 2 +- .../translatingWallVelocityFvPatchVectorField.H | 2 +- .../derived/turbulentInlet/turbulentInletFvPatchField.H | 2 +- .../turbulentIntensityKineticEnergyInletFvPatchScalarField.H | 2 +- .../uniformDensityHydrostaticPressureFvPatchScalarField.H | 2 +- .../derived/uniformFixedValue/uniformFixedValueFvPatchField.H | 2 +- .../uniformTotalPressureFvPatchScalarField.H | 2 +- .../variableHeightFlowRate/variableHeightFlowRateFvPatchField.H | 2 +- .../variableHeightFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H | 2 +- .../derived/waveTransmissive/waveTransmissiveFvPatchField.H | 2 +- .../fields/fvPatchFields/fvPatchField/fvPatchField.H | 2 +- 82 files changed, 82 insertions(+), 82 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H index 3d2991be2f..a4076f6fcf 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index f4d455f75e..15dc9e2d5f 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H index fcc1bfddee..4730fe1f1d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H index ae396fa84f..d480f24adc 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index 7ee9750685..f22106bd3a 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index d89bed8f40..8fe16727d9 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index f285baf775..c4dbe21204 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H index 36b4b0e43f..e245db2450 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H index 1a37a3cbb0..b5d163efbb 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 12927f5457..ae03fced6c 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index e78e0e5a7d..783e0a6b60 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index fd8ff67e7f..5c5a7d25d4 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 13ac6f93fa..38e633fc95 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index 97ed05d85e..a7ef6a816d 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H index bcb2a16f4c..98f4ea45fe 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H index efbd5e0fdc..7d42a6aac0 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 49f736ba28..649202cd20 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 0d5c552877..0828c8ceb3 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index e44c750f35..8087f248af 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index dd66e00a9d..d539700e2c 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 94ac3b93b7..2231e93051 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 570c14e5a6..09dd71dd7e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index e86979b00e..f567eaf3e0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 751aa8c622..11b848dfea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index e57c855112..5faa817c58 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 8c2ff8a59f..6e7fa87ff2 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index f4a837a881..0a120ee3a3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -22,7 +22,7 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index fa975e230b..1cc2835a9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index c17f99249a..0c74885309 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 2198962105..5ab621f8b7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index f250473ce5..35617d9c77 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index 99a9c4e053..c18cc48d17 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 9224eea582..5b1b6e9f15 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index bf219a6087..4ebbcc0808 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index a90692905c..14aa62c538 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 149f971982..00960b163b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 3083cbe630..db0eb91754 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 3b5fb4632f..609325cfa4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 3518536ffe..9a39ea3a73 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 6ccd06a7b3..1e8eb0a15e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 7d1a1d54d0..d9bb992e29 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index ede2346d25..7dbb2b7f43 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index bdf88c3cd5..a39e9f41cc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index aad29789ff..b618dd6d12 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 39a1d90dc0..27f7d1ff02 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 1e4f29810c..e12867472e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 86aed0448c..b785a732a7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index f998f0407f..71d9edaeb1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index 0b1351cdee..6021aa7f56 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 70bdf6ec34..7a3841d5fe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 603daaa37f..611bc2ca09 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 8fad8bed65..2255dd51f0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index b67f610920..7fe32be406 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index 85eaf73c9e..1d6c3f00d8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 892a7e09ed..d400e23b54 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 9a7d657c73..befe8b69a9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 3cb219c35e..4c7819530b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 255eadc07b..998618e70e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 1afb6a95c5..f80907d44e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 7e9c0c63b8..c98432a91c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 39288045ea..177cf18367 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index eb1dbbfa8c..88c248287a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 957089b6e3..4ace034757 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 5c4ac4e0b8..74e40224c1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index f47b3a4978..9b1bfdf2f1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 4926c0627a..20d5db2170 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index faa11fa621..6f36c8276a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 8399a0cf69..5ca3c7006f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index f4c97575d3..4be80e9d15 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 0d675c0fe5..916d3364e7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index 715cf3dc75..3b2af53cb2 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index d63ca5e606..43c7d46241 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 5ab4c643b1..b076c6d3a7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index ce41bf5972..5f527974e6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index 6fb33ef149..f830632599 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 593d007dda..cee5ce1a98 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 7a42d5d42f..c1df5d16b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index dbbe27dec8..7ddf30d829 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index ddac63287e..235def3aac 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -22,7 +22,7 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index eca1439431..6e620dcc4d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 2325e383fd..fedeed7707 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup boundaryConditions +\addtogroup grpBoundaryConditions @{ Class diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H index ed9b605588..bbd9d3b1d5 100644 --- a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup boundaryConditions Boundary Conditions +\defgroup grpBoundaryConditions Boundary Conditions @{ This group contains OpenFOAM boundary condition types @} From 3dd7ab054b988244661e9c8c43b444be3c2385ef Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 10:35:09 +0100 Subject: [PATCH 030/109] STYLE: change of doxygen tags for function objects and ico wall functions boundaryConditions --- .../functionObjects/functionObject/functionObjectsDoc.H | 2 +- .../functionObjects/IO/IOFunctionObjectsDoc.H | 4 ++-- .../functionObjects/IO/partialWrite/partialWrite.H | 2 +- .../IO/removeRegisteredObject/removeRegisteredObject.H | 2 +- .../IO/writeRegisteredObject/writeRegisteredObject.H | 2 +- .../functionObjects/cloud/cloudFunctionObjectsDoc.H | 9 ++++++--- .../functionObjects/cloud/cloudInfo/cloudInfo.H | 2 +- .../field/fieldAverage/fieldAverage/fieldAverage.H | 2 +- .../fieldCoordinateSystemTransform.H | 2 +- .../functionObjects/field/fieldFunctionObjectsDoc.H | 7 +++++-- .../functionObjects/field/fieldMinMax/fieldMinMax.H | 2 +- .../field/fieldValues/fieldValue/fieldValue.H | 2 +- .../field/nearWallFields/nearWallFields.H | 2 +- .../field/processorField/processorField.H | 2 +- .../functionObjects/field/readFields/readFields.H | 2 +- .../regionSizeDistribution/regionSizeDistribution.H | 2 +- .../functionObjects/field/streamLine/streamLine.H | 2 +- .../surfaceInterpolateFields/surfaceInterpolateFields.H | 2 +- .../field/turbulenceFields/turbulenceFields.H | 2 +- .../field/wallBoundedStreamLine/wallBoundedStreamLine.H | 2 +- .../functionObjects/forces/forceCoeffs/forceCoeffs.H | 2 +- .../functionObjects/forces/forces/forces.H | 2 +- .../functionObjects/forces/forcesFunctionObjectsDoc.H | 7 +++++-- .../jobControl/abortCalculation/abortCalculation.H | 2 +- .../jobControl/jobControlFunctionObjectsDoc.H | 4 ++-- .../functionObjects/systemCall/systemCall.H | 2 +- .../utilities/codedFunctionObject/codedFunctionObject.H | 2 +- .../functionObjects/utilities/dsmcFields/dsmcFields.H | 2 +- .../utilities/pressureCoefficient/pressureCoefficient.H | 2 +- .../utilities/staticPressure/staticPressure.H | 2 +- .../timeActivatedFileUpdate/timeActivatedFileUpdate.H | 2 +- .../utilities/utilitiesFunctionObjectsDoc.H | 4 ++-- .../functionObjects/utilities/yPlusLES/yPlusLES.H | 2 +- .../functionObjects/utilities/yPlusRAS/yPlusRAS.H | 2 +- .../epsilonWallFunctionFvPatchScalarField.H | 2 +- .../wallFunctions/incompressibleWallFunctionsDoc.H | 4 ++-- .../kappatJayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../kqRWallFunction/kqRWallFunctionFvPatchField.H | 2 +- .../nutLowReWallFunctionFvPatchScalarField.H | 2 +- .../nutURoughWallFunctionFvPatchScalarField.H | 2 +- .../nutUSpaldingWallFunctionFvPatchScalarField.H | 2 +- .../nutUTabulatedWallFunctionFvPatchScalarField.H | 2 +- .../nutUWallFunctionFvPatchScalarField.H | 2 +- .../nutWallFunction/nutWallFunctionFvPatchScalarField.H | 2 +- .../nutkAtmRoughWallFunctionFvPatchScalarField.H | 2 +- .../nutkRoughWallFunctionFvPatchScalarField.H | 2 +- .../nutkWallFunctionFvPatchScalarField.H | 2 +- .../omegaWallFunctionFvPatchScalarField.H | 2 +- 48 files changed, 65 insertions(+), 56 deletions(-) diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H index 54375696a8..0e93e3e3b3 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup functionObjects Function objects +\defgroup grpFunctionObjects Function objects @{ This group contains function objects @} diff --git a/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H b/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H index 70daa827dc..8466362578 100644 --- a/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H @@ -21,9 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup IOFunctionObjects Input/outuput function objects +\defgroup grpIOFunctionObjects Input/outuput function objects @{ - \ingroup functionObjects + \ingroup grpFunctionObjects This group contains input/output-based function objects @} diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index d34a0462ed..d2a878618b 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup IOFunctionObjects +\addtogroup grpIOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index b773fb9a7f..644f2f3853 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup IOFunctionObjects +\addtogroup grpIOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index a646e171af..aaaf68044e 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup IOFunctionObjects +\addtogroup grpIOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H b/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H index 861ec1597c..2ac4b66db4 100644 --- a/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H @@ -21,10 +21,13 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup cloudFunctionObjects Cloud function objects +\defgroup grpCloudFunctionObjects Cloud function objects @{ - \ingroup functionObjects - This group contains cloud-based function objects + \ingroup grpFunctionObjects + This group contains cloud-based function objects. + + Function objects in this group are packaged into the + libcloudFunctionObjects.so library. @} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 0342de2196..1c1494864e 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup cloudFunctionObjects +\addtogroup grpCloudFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 17184c407b..0c66074f22 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 0d6bf886c1..db65d4046e 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ class diff --git a/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H b/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H index 89354bbb53..6c934be48e 100644 --- a/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H @@ -21,10 +21,13 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup fieldFunctionObjects Field function objects +\defgroup grpFieldFunctionObjects Field function objects @{ - \ingroup functionObjects + \ingroup grpFunctionObjects This group contains field-based function objects + + Function objects in this group are packaged into the + libfieldFunctionObjects.so library. @} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 92f2224cf8..55198bff72 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index b591c809c9..414d19bbcf 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 5ed2009877..bbfc352afe 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index 0884e31ef6..1bf8282685 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 772b6b8eda..400036e2fd 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 2704dbc858..3a7a29ccf9 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index abbb974413..16d26e2a7b 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 10bc0cbdaf..4d4697426c 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 85a0cd2227..33a6f44d11 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 38847c1266..7e20da7e0b 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup fieldFunctionObjects +\addtogroup grpFieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index b90ff9ee9d..56351be370 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup forcesFunctionObjects +\addtogroup grpForcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index 15fd54ebdf..abf9df97ef 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup forcesFunctionObjects +\addtogroup grpForcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H index 43130004c3..b171ef9289 100644 --- a/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H @@ -21,10 +21,13 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup forcesFunctionObjects Forces function objects +\defgroup grpForcesFunctionObjects Forces function objects @{ - \ingroup functionObjects + \ingroup grpFunctionObjects This group contains force-based function objects + + Function objects in this group are packaged into the + libforcesFunctionObjects.so library. @} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 9d4db70ae2..3d9a3f19e2 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup jobControlFunctionObjects +\addtogroup grpJobControlFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H b/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H index 3dd25c6fed..34a586b207 100644 --- a/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H @@ -21,9 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup jobControlFunctionObjects Job control function objects +\defgroup grpJobControlFunctionObjects Job control function objects @{ - \ingroup functionObjects + \ingroup grpFunctionObjects This group contains job control-based function objects @} diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index bd0147b78f..3a3d9965af 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects +\addtogroup grpFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 8b8e8c9934..1171951b33 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index f780c13b54..57b9c317c2 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 690a32d927..93be6c8344 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 480cb661e9..fae08db94a 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index 6b59273e7a..9d6a2a578f 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H index b51693bedf..b6e39e565d 100644 --- a/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H +++ b/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H @@ -21,9 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup utilitiesFunctionObjects Utility function objects +\defgroup grpUtilitiesFunctionObjects Utility function objects @{ - \ingroup functionObjects + \ingroup grpFunctionObjects This group contains utility-based function objects @} diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index f45d018457..b0225aab16 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index c40d8b2182..1ed5275561 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup utilitiesFunctionObjects +\addtogroup grpUtilitiesFunctionObjects @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index be75c4f45e..807813d1e3 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H index a42b86f9ee..e319b2aee4 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H @@ -21,9 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup icoWallFunctions RAS incompressible wall functions +\defgroup grpIcoWallFunctions RAS incompressible wall functions @{ - \ingroup boundaryConditions + \ingroup grpBoundaryConditions This group contains incompressible RAS turbulence model wall functions @} diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index bbc105b147..97a01567ea 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 2e8fa43368..007401a499 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 22384c7e66..28861bbc65 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index afd24b2826..89113aa58a 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index 711d6785ac..abb1f0c683 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index d23dd8138d..efabcfb58f 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index 6629e101a7..3fd38c9e37 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index ad53fdf3c4..dfdebdc2ee 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index a6dda6a5cc..bef03208d0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 183a331fc0..57cb2c27cb 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 6bb4bf5209..61363a9c46 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index acc0b5e5c1..e7c41731aa 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup icoWallFunctions +\addtogroup grpIcoWallFunctions @{ Class From 375bcd0d6007ae7351771cc1ba77c6b0462b3ab8 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 11:10:12 +0100 Subject: [PATCH 031/109] ENH: Updated code from GPL2->GPL3 --- ...lindricalInletVelocityFvPatchVectorField.H | 21 +++++++++---------- ...tFlowRateInletVelocityFvPatchVectorField.H | 13 ++++++------ 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 0a120ee3a3..94206e5afc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -8,10 +8,10 @@ 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 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 @@ -19,8 +19,7 @@ License for more details. You should have received a copy of the GNU General Public License - along with OpenFOAM; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + along with OpenFOAM. If not, see . \addtogroup grpBoundaryConditions @{ @@ -39,8 +38,8 @@ Description Property | Description | Required | Default value axis | axis of rotation | yes | centre | centre of rotation | yes | - axialVelocity| axial velocity profile | yes | - radialVelocity| radial velocity profile | yes | + axialVelocity | axial velocity profile [m/s] | yes | + radialVelocity | radial velocity profile [m/s] | yes | rpm | rotational speed (revolutions per minute) | yes| /endtable @@ -51,9 +50,9 @@ Description type cylindricalInletVelocity; axis (0 0 1); centre (0 0 0); - axialVelocity constant 30; // axial velocity [m/s] - radialVelocity constant -10; // radial velocity [m/s] - rpm constant 100; // revolutions per minute + axialVelocity constant 30; + radialVelocity constant -10; + rpm constant 100; } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index 235def3aac..e4ec5f2763 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -2,16 +2,16 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-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 2 of the License, or (at your - option) any later version. + 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 @@ -19,8 +19,7 @@ License for more details. You should have received a copy of the GNU General Public License - along with OpenFOAM; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + along with OpenFOAM. If not, see . \addtogroup grpBoundaryConditions @{ From b15d6af77f053673badac091710f69d8180f3f13 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 11:14:18 +0100 Subject: [PATCH 032/109] STYLE: minor code tweaks --- .../field/fieldAverage/fieldAverage/fieldAverage.H | 1 + .../fieldCoordinateSystemTransform.H | 1 + 2 files changed, 2 insertions(+) diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 0c66074f22..948733c18f 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -64,6 +64,7 @@ Description base time; } ); + } \endverbatim Member function calcAverages() calculates the averages. diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index db65d4046e..c257b0617f 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -33,6 +33,7 @@ Description SourceFiles fieldCoordinateSystemTransform.C + fieldCoordinateSystemTransformTemplates.C IOfieldCoordinateSystemTransform.H @} From b19eedd095d39b6ae9895afafc3ec92a3d695636 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 12:45:28 +0100 Subject: [PATCH 033/109] ENH: Assigned doxygen types (inlet/wall etc) to boundary conditions --- .../activeBaffleVelocityFvPatchVectorField.H | 7 +- ...ureForceBaffleVelocityFvPatchVectorField.H | 7 +- .../derived/advective/advectiveFvPatchField.H | 7 +- .../buoyantPressureFvPatchScalarField.H | 7 +- .../codedFixedValueFvPatchField.H | 7 +- .../codedMixed/codedMixedFvPatchField.H | 7 +- ...lindricalInletVelocityFvPatchVectorField.H | 7 +- .../derived/fan/fanFvPatchField.H | 6 +- .../fanPressureFvPatchScalarField.H | 40 +++++------ .../fixedFluxPressureFvPatchScalarField.H | 7 +- .../fixedInternalValueFvPatchField.H | 7 +- .../derived/fixedJump/fixedJumpFvPatchField.H | 7 +- .../derived/fixedMean/fixedMeanFvPatchField.H | 7 +- .../fixedNormalSlipFvPatchField.H | 7 +- ...ureCompressibleDensityFvPatchScalarField.H | 7 +- .../flowRateInletVelocityFvPatchVectorField.H | 7 +- .../fluxCorrectedVelocityFvPatchVectorField.H | 7 +- .../freestream/freestreamFvPatchField.H | 7 +- .../freestreamPressureFvPatchScalarField.H | 7 +- .../inletOutlet/inletOutletFvPatchField.H | 7 +- ...OutletTotalTemperatureFvPatchScalarField.H | 7 +- .../mappedField/mappedFieldFvPatchField.H | 7 +- .../mappedFixedInternalValueFvPatchField.H | 7 +- ...ppedFixedPushedInternalValueFvPatchField.H | 7 +- .../mappedFixedValueFvPatchField.H | 7 +- .../mappedFlowRateFvPatchVectorField.H | 11 ++- ...mappedVelocityFluxFixedValueFvPatchField.H | 7 +- .../movingWallVelocityFvPatchVectorField.H | 7 +- ...phaseFixedFluxPressureFvPatchScalarField.H | 7 +- .../oscillatingFixedValueFvPatchField.H | 7 +- .../outletInlet/outletInletFvPatchField.H | 7 +- .../outletMappedUniformInletFvPatchField.H | 7 +- .../partialSlip/partialSlipFvPatchField.H | 7 +- ...aseHydrostaticPressureFvPatchScalarField.H | 7 +- ...tedInletOutletVelocityFvPatchVectorField.H | 7 +- ...eDirectedInletVelocityFvPatchVectorField.H | 7 +- ...tOutletParSlipVelocityFvPatchVectorField.H | 7 +- ...ureInletOutletVelocityFvPatchVectorField.H | 7 +- ...reInletUniformVelocityFvPatchVectorField.H | 7 +- .../pressureInletVelocityFvPatchVectorField.H | 7 +- ...malInletOutletVelocityFvPatchVectorField.H | 7 +- ...ureInletOutletVelocityFvPatchVectorField.H | 7 +- .../rotatingTotalPressureFvPatchScalarField.H | 7 +- .../rotatingWallVelocityFvPatchVectorField.H | 7 +- .../derived/slip/slipFvPatchField.H | 7 +- .../supersonicFreestreamFvPatchVectorField.H | 7 +- ...urfaceNormalFixedValueFvPatchVectorField.H | 7 +- ...lFlowRateInletVelocityFvPatchVectorField.H | 7 +- .../syringePressureFvPatchScalarField.H | 7 +- .../temperatureJumpFvPatchScalarField.H | 7 +- .../timeVaryingMappedFixedValueFvPatchField.H | 6 +- .../totalPressureFvPatchScalarField.H | 6 +- .../totalTemperatureFvPatchScalarField.H | 29 +++++++- ...ranslatingWallVelocityFvPatchVectorField.H | 7 +- .../turbulentInletFvPatchField.H | 7 +- ...sityKineticEnergyInletFvPatchScalarField.H | 7 +- ...ityHydrostaticPressureFvPatchScalarField.H | 7 +- .../uniformFixedValueFvPatchField.H | 7 +- .../uniformTotalPressureFvPatchScalarField.H | 7 +- .../variableHeightFlowRateFvPatchField.H | 7 +- ...tFlowRateInletVelocityFvPatchVectorField.H | 7 +- .../waveSurfacePressureFvPatchScalarField.H | 7 +- .../waveTransmissiveFvPatchField.H | 7 +- .../fvPatchFields/fvPatchField/fvPatchField.H | 5 -- .../fvPatchField/fvPatchFieldDoc.H | 67 +++++++++++++++++++ 65 files changed, 239 insertions(+), 330 deletions(-) create mode 100644 src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 2231e93051..e5fc8c3c15 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::activeBaffleVelocityFvPatchVectorField +\ingroup grpCoupledBoundaryConditions + Description This velocity boundary condition simulates the opening of a baffle due to local flow conditions, by merging the behaviours of wall and cyclic @@ -87,8 +86,6 @@ SeeAlso SourceFiles activeBaffleVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef activeBaffleVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 09dd71dd7e..350f2113a1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::activePressureForceBaffleVelocityFvPatchVectorField +\ingroup grpCoupledBoundaryConditions + Description This boundary condition is applied to the flow velocity, to simulate the opening of a baffle due to local flow conditions, by merging the behaviours @@ -86,8 +85,6 @@ Description SourceFiles activePressureForceBaffleVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef activePressureForceBaffleVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index f567eaf3e0..9a87eaf77d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::advectiveFvPatchField +\ingroup grpOutletBoundaryConditions + Description This boundary condition provides an advective outflow condition, based on solving DDt(psi, U) = 0 at the boundary. @@ -77,8 +76,6 @@ Description SourceFiles advectiveFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef advectiveFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 11b848dfea..05e88b18cd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::buoyantPressureFvPatchScalarField +\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions + Description This boundary condition sets the pressure gradient appropriately for buoyant flow. @@ -81,8 +80,6 @@ Description SourceFiles buoyantPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef buoyantPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 5faa817c58..8bda7a7952 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::codedFixedValueFvPatchField +\ingroup grpGenericBoundaryConditions + Description Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField) which is then used to evaluate. @@ -79,8 +78,6 @@ SeeAlso SourceFiles codedFixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef codedFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 6e7fa87ff2..1d9ce49b8c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::codedMixedFvPatchField +\ingroup grpGenericBoundaryConditions + Description Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField) which is then used to evaluate. @@ -83,8 +82,6 @@ SeeAlso SourceFiles codedMixedFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef codedMixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 94206e5afc..e9d2a3455b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::cylindricalInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This boundary condition describes an inlet vector boundary condition in cylindrical co-ordinates given a central axis, central point, rpm, axial @@ -68,8 +67,6 @@ SeeAlso SourceFiles cylindricalInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef cylindricalInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 1cc2835a9a..86d52ed1f0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fanFvPatchField +\ingroup grpCoupledBoundaryConditions + Description This boundary condition supplies a jump condition, using the \c cyclic condition as a base. @@ -77,7 +76,6 @@ SourceFiles fanFvPatchFields.H fanFvPatchFields.C fanFvPatchFieldsFwd.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index ed3b1c0237..ad25e082ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -24,6 +24,8 @@ License Class Foam::fanPressureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan. @@ -35,25 +37,25 @@ Description Example of the boundary condition specification: \verbatim - inlet - { - type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction in; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure - } + inlet + { + type fanPressure; + fileName "fanCurve"; // Fan curve file name + outOfBounds clamp; // (error|warn|clamp|repeat) + direction in; // Direction of flow through fan + p0 uniform 0; // Environmental total pressure + value uniform 0; // Initial pressure + } - outlet - { - type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction out; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure - } + outlet + { + type fanPressure; + fileName "fanCurve"; // Fan curve file name + outOfBounds clamp; // (error|warn|clamp|repeat) + direction out; // Direction of flow through fan + p0 uniform 0; // Environmental total pressure + value uniform 0; // Initial pressure + } \endverbatim See Also @@ -62,7 +64,7 @@ See Also Foam::interpolationTable SourceFiles - fanPressureFvPatchScalarField.C + fanPressureFvPatchScalarField.C \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index 0c74885309..52768875e6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedFluxPressureFvPatchScalarField +\ingroup grpBoundaryConditions + Description This boundary condition adjusts the pressure gradient such that the flux on the boundary is that specified by the velocity boundary condition. @@ -73,8 +72,6 @@ SeeAlso SourceFiles fixedFluxPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedFluxPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 5ab621f8b7..1410335358 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedInternalValueFvPatchField +\ingroup grpGenericBoundaryConditions + Description This boundary condition provides a mechanism to set boundary (cell) values directly into a matrix, i.e. to set a constraint condition. Default @@ -54,8 +53,6 @@ SeeAlso SourceFiles fixedInternalValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 35617d9c77..caaa866306 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedJumpFvPatchField +\ingroup grpCoupledBoundaryConditions + Description Base class for "jump" of a field @@ -40,8 +39,6 @@ SeeAlso SourceFiles fixedJumpFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedJumpFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index c18cc48d17..7fd5c515a9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedMeanFvPatchField +\ingroup grpGenericBoundaryConditions + Description This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified mean value. @@ -53,8 +52,6 @@ SeeAlso SourceFiles fixedMeanFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedMeanFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 5b1b6e9f15..1c387e48a5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedNormalSlipFvPatchField +\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions + Description This boundary condition sets the patch-normal component to a fixed value. @@ -52,8 +51,6 @@ SeeAlso SourceFiles fixedNormalSlipFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedNormalSlipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 4ebbcc0808..af16f8e270 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedPressureCompressibleDensityFvPatchScalarField +\ingroup grpInletBoundaryConditions + Description This boundary condition calculates a (liquid) compressible density as a function of pressure and fluid properties: @@ -71,8 +70,6 @@ SeeAlso SourceFiles fixedPressureCompressibleDensityFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedPressureCompressibleDensityFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 14aa62c538..9875120c18 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::flowRateInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a velocity boundary condition, derived from the flux (volumetric or mass-based), whose direction is assumed @@ -76,8 +75,6 @@ SeeAlso SourceFiles flowRateInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef flowRateInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 00960b163b..37a508e5ef 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fluxCorrectedVelocityFvPatchVectorField +\ingroup grpOutletBoundaryConditions + Description This boundary condition provides a velocity outlet boundary condition for patches where the pressure is specified. The outflow velocity is obtained @@ -75,8 +74,6 @@ SeeAlso SourceFiles fluxCorrectedVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fluxCorrectedVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index db0eb91754..90fae4911b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::freestreamFvPatchField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a free-stream condition. It is a 'mixed' condition derived from the \c inletOutlet condition, whereby the mode of @@ -56,8 +55,6 @@ SeeAlso SourceFiles freestreamFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef freestreamFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 609325cfa4..d1f8214bc3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::freestreamPressureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a free-stream condition for pressure. It is a zero-gradient condition that constrains the flux across the patch @@ -52,8 +51,6 @@ SeeAlso SourceFiles freestreamPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef freestreamPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 9a39ea3a73..1ba72744df 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::inletOutletFvPatchField +\ingroup grpOutletBoundaryConditions + Description This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. @@ -65,8 +64,6 @@ SeeAlso SourceFiles inletOutletFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef inletOutletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 1e8eb0a15e..ef2f279e24 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::inletOutletTotalTemperatureFvPatchScalarField +\ingroup grpOutletBoundaryConditions + Description This boundary condition provides an outflow condition for total temperature for use with supersonic cases, where a user-specified @@ -65,8 +64,6 @@ SeeAlso SourceFiles inletOutletTotalTemperatureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef inletOutletTotalTemperatureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index d9bb992e29..8c9c39b9d5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedFieldFvPatchField +\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions + Description This boundary condition provides a self-contained version of the \c mapped condition. It does not use information on the patch; instead it holds @@ -69,8 +68,6 @@ SeeAlso SourceFiles mappedFieldFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedFieldFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 7dbb2b7f43..f5f2a5b167 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedFixedInternalValueFvPatchField +\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions + Description This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. @@ -64,8 +63,6 @@ SeeAlso SourceFiles mappedFixedInternalValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedFixedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index a39e9f41cc..12aa98c6b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedFixedPushedInternalValueFvPatchField +\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions + Description This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this. @@ -65,8 +64,6 @@ SeeAlso SourceFiles mappedFixedPushedInternalValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedFixedPushedInternalValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index b618dd6d12..0a7e597e9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedFixedValueFvPatchField +\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions + Description This boundary condition maps the value at a set of cells or patch faces back to *this. @@ -77,8 +76,6 @@ SeeAlso SourceFiles mappedFixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 27f7d1ff02..253294c0cd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedFlowRateFvPatchVectorField +\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions + Description Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area. @@ -47,7 +46,7 @@ Description /endtable Example of the boundary condition specification: - @verbatim + /verbatim inlet { type mappedFlowRate; @@ -56,13 +55,11 @@ Description neigPhi phi; value uniform (0 0 0); // placeholder } - @endverbatim + /endverbatim SourceFiles mappedFlowRateFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedFlowRateFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index e12867472e..0dea9e1ed1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::mappedVelocityFluxFixedValueFvPatchField +\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions + Description This boundary condition maps the velocity and flux from a neighbour patch to this patch @@ -64,8 +63,6 @@ SeeAlso SourceFiles mappedVelocityFluxFixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mappedVelocityFluxFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index b785a732a7..daf1a77df4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::movingWallVelocityFvPatchVectorField +\ingroup grpWallBoundaryConditions + Description This boundary condition provides a velocity condition for cases with moving walls. In addition, it should also be applied to 'moving' walls @@ -57,8 +56,6 @@ SeeAlso SourceFiles movingWallVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef movingWallVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index 71d9edaeb1..a03bf05439 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::multiphaseFixedFluxPressureFvPatchScalarField +\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions + Description This boundary condition adjusts the pressure gradient such that the flux on the boundary is that specified by the velocity boundary condition. @@ -70,8 +69,6 @@ Description SourceFiles multiphaseFixedFluxPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef multiphaseFixedFluxPressureFvPatchScalarFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index 6021aa7f56..4cb745fad5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::oscillatingFixedValueFvPatchField +\ingroup grpGenericBoundaryConditions + Description This boundary condition provides an oscillating condition in terms of amplitude and frequency. @@ -79,8 +78,6 @@ SeeAlso SourceFiles oscillatingFixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef oscillatingFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 7a3841d5fe..13973910b1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::outletInletFvPatchField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a generic inflow condition, with specified outflow for the case of return flow. @@ -61,8 +60,6 @@ Description SourceFiles outletInletFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef outletInletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 611bc2ca09..4e5c3ff062 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::outletMappedUniformInletFvPatchField +\ingroup grpInletBoundaryConditions + Description This boundary conditon averages the field over the "outlet" patch specified by name "outletPatchName" and applies this as the uniform value of the @@ -57,8 +56,6 @@ SeeAlso SourceFiles outletMappedUniformInletFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef outletMappedUniformInletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 2255dd51f0..eb883458f7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::partialSlipFvPatchField +\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions + Description This boundary condition provides a partial slip condition. The amount of slip is controlled by a user-supplied field. @@ -54,8 +53,6 @@ SeeAlso SourceFiles partialSlipFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef partialSlipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 7fe32be406..673e51c072 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::phaseHydrostaticPressureFvPatchScalarField +\ingroup grpGenericBoundaryConditions + Description This boundary condition provides a phase-based hydrostatic pressure condition, calculated as: @@ -77,8 +76,6 @@ SeeAlso SourceFiles phaseHydrostaticPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef phaseHydrostaticPressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index 1d6c3f00d8..bfe5aab9f5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureDirectedInletOutletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This velocity inlet/outlet boundary condition is applied to pressure boundaries where the pressure is specified. A zero-gradient condtion is @@ -66,8 +65,6 @@ SeeAlso SourceFiles pressureDirectedInletOutletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureDirectedInletOutletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index d400e23b54..c4c0a57092 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureDirectedInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This velocity inlet boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with @@ -65,8 +64,6 @@ SeeAlso SourceFiles pressureDirectedInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureDirectedInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index befe8b69a9..dab033544b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureInletOutletParSlipVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This velocity inlet/outlet boundary condition for pressure boundary where the pressure is specified. A zero-gradient is applied for outflow (as @@ -67,8 +66,6 @@ SeeAlso SourceFiles pressureInletOutletParSlipVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureInletOutletParSlipVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 4c7819530b..71b4ce4238 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureInletOutletVelocityFvPatchVectorField +\ingroup grpInletletBoundaryConditions grpOutletBoundaryConditions + Description This velocity inlet/outlet boundary condition is applied to pressure boundaries where the pressure is specified. A zero-gradient condtion is @@ -63,8 +62,6 @@ Description SourceFiles pressureInletOutletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureInletOutletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 998618e70e..ed9cf68188 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureInletUniformVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This velocity inlet boundary condition is applied to patches where the pressure is specified. The uniform inflow velocity is obtained by @@ -47,8 +46,6 @@ Description SourceFiles pressureInletUniformVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureInletUniformVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index f80907d44e..3acb22984b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This velocity inlet boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with @@ -56,8 +55,6 @@ SeeAlso SourceFiles pressureInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index c98432a91c..7cfb0c639a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::pressureNormalInletOutletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This velocity inlet/outlet boundary condition is applied to patches where the pressure is specified. A zero-gradient condition is applied for @@ -64,8 +63,6 @@ SeeAlso SourceFiles pressureNormalInletOutletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef pressureNormalInletOutletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 177cf18367..2a5254195d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::rotatingPressureInletOutletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This velocity inlet/outlet boundary condition is applied to patches in a rotating frame where the pressure is specified. A zero-gradient is applied @@ -68,8 +67,6 @@ SeeAlso SourceFiles rotatingPressureInletOutletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef rotatingPressureInletOutletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index 88c248287a..29c9eb822c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::rotatingTotalPressureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a total pressure condition for patches in a rotating frame. @@ -68,8 +67,6 @@ SeeAlso SourceFiles rotatingTotalPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef rotatingTotalPressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 4ace034757..bfdce14ba7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::rotatingWallVelocityFvPatchVectorField +\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions + Description This boundary condition provides a rotational velocity condition. @@ -60,8 +59,6 @@ SeeAlso SourceFiles rotatingWallVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef rotatingWallVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 74e40224c1..f216b358ed 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::slipFvPatchField +\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions + Description This boundary condition provides a slip constraint. @@ -43,8 +42,6 @@ Description SourceFiles slipFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef slipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index 9b1bfdf2f1..fca7044c78 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::supersonicFreestreamFvPatchVectorField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a supersonic free-stream condition. @@ -65,8 +64,6 @@ Description SourceFiles supersonicFreestreamFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef supersonicFreestreamFvPatchVectorFields_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 20d5db2170..5f223d6dbc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::surfaceNormalFixedValueFvPatchVectorField +\ingroup grpGenericBoundaryConditions grpInletBoundaryConditions + Description This boundary condition provides a surface-normal vector boundary condition by its magnitude. @@ -57,8 +56,6 @@ SeeAlso SourceFiles surfaceNormalFixedValueFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef surfaceNormalFixedValueFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 6f36c8276a..1be1e1ca92 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::swirlFlowRateInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a volumetric- OR mass-flow normal vector boundary condition by its magnitude as an integral over its area with a @@ -69,8 +68,6 @@ SeeAlso SourceFiles swirlFlowRateInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef swirlFlowRateInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 5ca3c7006f..8e40b42d9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::syringePressureFvPatchScalarField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a pressure condition, obtained from a zero-D model of the cylinder of a syringe. @@ -78,8 +77,6 @@ SeeAlso SourceFiles syringePressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef syringePressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index 4be80e9d15..8433ddfa21 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::temperatureJumpFvPatchScalarField +\ingroup grpCoupledBoundaryConditions + Description This boundary condition provides a temperature jump condition across a coupled pair of cyclic patches. @@ -65,8 +64,6 @@ SeeAlso SourceFiles temperatureJumpFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef temperatureJumpFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 916d3364e7..9566c298b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::timeVaryingMappedFixedValueFvPatchField +\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions + Description This boundary conditions interpolates the values from a set of supplied points in space and time. Supplied data should be specified in @@ -70,7 +69,6 @@ SeeAlso SourceFiles timeVaryingMappedFixedValueFvPatchField.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index 3b2af53cb2..715c993cf4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::totalPressureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a total pressure condition. Four variants are possible: @@ -122,7 +121,6 @@ SeeAlso SourceFiles totalPressureFvPatchScalarField.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index 7f6137709b..c095b2fbd0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -24,12 +24,37 @@ License Class Foam::totalTemperatureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description - Foam::totalTemperatureFvPatchScalarField + This boundary condition provides a total temperature condition. + + /heading Patch usage + + /table + Property | Description | Required | Default value + U | Velocity field name | no | U + phi | Flux field name | no | phi + psi | Compressibility field name | no | psi + gamma | ratio of specific heats (Cp/Cv) | yes | + T0 | reference temperature | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type totalTemperature; + T0 uniform 300; + } + \endverbatim SourceFiles totalTemperatureFvPatchScalarField.C +SeeAlso + Foam::fixedValueFvPatchField + \*---------------------------------------------------------------------------*/ #ifndef totalTemperatureFvPatchScalarField_H @@ -43,7 +68,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class totalTemperatureFvPatch Declaration + Class totalTemperatureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class totalTemperatureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index 43c7d46241..bff3ffeccb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::translatingWallVelocityFvPatchVectorField +\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions + Description This boundary condition provides a velocity condition for translational motion on walls. @@ -54,8 +53,6 @@ SeeAlso SourceFiles translatingWallVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef translatingWallVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index b076c6d3a7..2d61ae94d3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::turbulentInletFvPatchField +\ingroup grpInletBoundaryConditions + Description This boundary condition generates a fluctuating inlet condition by adding a random component to a reference (mean) field. @@ -72,8 +71,6 @@ SeeAlso SourceFiles turbulentInletFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef turbulentInletFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index 5f527974e6..1774e06f02 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the @@ -71,8 +70,6 @@ SeeAlso SourceFiles turbulentIntensityKineticEnergyInletFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef turbulentIntensityKineticEnergyInletFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index f830632599..a8002088a2 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::uniformDensityHydrostaticPressureFvPatchScalarField +\ingroup grpGenericBoundaryConditions + Description This boundary condition provides a hydrostatic pressure condition, calculated as: @@ -68,8 +67,6 @@ Description SourceFiles uniformDensityHydrostaticPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef uniformDensityHydrostaticPressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index cee5ce1a98..4953b2ef2c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::uniformFixedValueFvPatchField +\ingroup grpGenericBoundaryConditions + Description This boundary condition provides a uniform fixed value condition. @@ -58,8 +57,6 @@ SeeAlso SourceFiles uniformFixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef uniformFixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index c1df5d16b6..4aab5f54fe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::uniformTotalPressureFvPatchScalarField +\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions + Description This boundary condition provides a time-varying form of the uniform total pressure boundary condition. @@ -74,8 +73,6 @@ SeeAlso SourceFiles uniformTotalPressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef uniformTotalPressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index 7ddf30d829..e9b764fe53 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::variableHeightFlowRateFvPatchScalarField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a phase fraction condition based on the local flow conditions, whereby the values are constrained to lay between @@ -64,8 +63,6 @@ Description SourceFiles variableHeightFlowRateFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef variableHeightFlowRateFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index e4ec5f2763..cef322e614 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::variableHeightFlowRateInletVelocityFvPatchVectorField +\ingroup grpInletBoundaryConditions + Description This boundary condition provides a velocity boundary condition for multphase flow based on a user-specified volumetric flow rate. @@ -63,8 +62,6 @@ SeeAlso SourceFiles variableHeightFlowRateInletVelocityFvPatchVectorField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef variableHeightFlowRateInletVelocityFvPatchVectorField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 6e620dcc4d..feab7a21c0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::waveSurfacePressureFvPatchScalarField +\ingroup grpInletBoundaryConditions + Description This is a pressure boundary condition, whose value is calculated as the hydrostatic pressure based on a given displacement: @@ -74,8 +73,6 @@ SeeAlso SourceFiles waveSurfacePressureFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef waveSurfacePressureFvPatchScalarField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index fedeed7707..9e30f3701b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::waveTransmissiveFvPatchField +\ingroup grpOutletBoundaryConditions + Description This boundary condition provides a wave transmissive outflow condition, based onsolving DDt(psi, U) = 0 at the boundary. @@ -74,8 +73,6 @@ SeeAlso SourceFiles waveTransmissiveFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef waveTransmissiveFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H index 90a1b9ef98..4dc1041ffc 100644 --- a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H @@ -21,11 +21,6 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\defgroup grpBoundaryConditions Boundary Conditions -@{ - This group contains OpenFOAM boundary condition types -@} - Class Foam::fvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H new file mode 100644 index 0000000000..4918858612 --- /dev/null +++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H @@ -0,0 +1,67 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpBoundaryConditions Boundary Conditions +@{ + This group contains OpenFOAM boundary condition types +@} + +\defgroup grpConstraintBoundaryConditions Constraint boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains constraint boundary condition types +@} + +\defgroup grpInletBoundaryConditions Inlet boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains inlet boundary condition types +@} + +\defgroup grpOutletBoundaryConditions Outlet boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains outlet boundary condition types +@} + +\defgroup grpGenericBoundaryConditions Generic boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains generic boundary condition types +@} + +\defgroup grpGenericBoundaryConditions Coupled boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains coupled boundary condition types +@} + +\defgroup grpWallBoundaryConditions Wall boundary Conditions +@{ + \ingroup grpBoundaryConditions + This group contains wall boundary condition types +@} + +// ************************************************************************* // From 3eddf5d90478a12aa035da5632738679eea57817 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 17:08:00 +0100 Subject: [PATCH 034/109] STYLE: Corrected GPL text --- ...ndaryLayerInletEpsilonFvPatchScalarField.H | 73 +++++++++++------- ...daryLayerInletVelocityFvPatchVectorField.H | 76 +++++++++++-------- 2 files changed, 90 insertions(+), 59 deletions(-) diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 964ff6286b..2dcd5c9214 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -8,10 +8,10 @@ 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 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 @@ -19,11 +19,12 @@ License for more details. You should have received a copy of the GNU General Public License - along with OpenFOAM; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + along with OpenFOAM. If not, see . Class - atmBoundaryLayerInletEpsilonFvPatchScalarField + Foam::incompressible::atmBoundaryLayerInletEpsilonFvPatchScalarField + +\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions Description This boundary condition specifies an inlet value for the turbulence @@ -32,40 +33,54 @@ Description velocity boundary condition. \f[ - epsilon = Ustar^3 / (K(z - zGround + z0)) + epsilon = (U^*)^3 / (K(z - z_g + z_0)) \f] - where: - - \var Ustar = frictional velocity - \var K = Karman's constant - \var z = vertical co-ordinate [m] - \var z0 = surface roughness length [m] - \var zGround = minimum vlaue in z direction [m] - + where + /vartable + U^* | frictional velocity + K | Karman's constant + z | vertical co-ordinate [m] + z_0 | surface roughness length [m] + z_g | minimum vlaue in z direction [m] + /endvartable + and: \f[ - Ustar = K Uref/ln((Zref + z0)/z0) + U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0}} \f] where: + /vartable + U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] + Z_{ref} | reference height [m] + /endvartable - \var Uref = reference velocity at Zref [m/s] - \var Zref = reference height [m] + /heading Patch usage + + /table + Property | Description | Required | Default value + z | vertical co-ordinate [m] | yes | + kappa | Karman's constanat | no | 0.41 + Uref | reference velocity [m/s] | yes | + Href | reference height [m] | yes | + z0 | surface roughness length [m] | yes | + zGround | minimum z co-ordinate [m] | yes | + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type atmBoundaryLayerInletEpsilon; - z 1.0; // vertical co-ordinate [m] - kappa 0.41; // kappa coefficient (default = 0.41) - Uref 1.0; // reference velocity [m/s] - Href 0.0; // reference height [m] - z0 uniform 0.0; // surface roughness length [m] - zGround uniform 0.0; // minimum z co-ordinate [m] - } + myPatch + { + type atmBoundaryLayerInletVelocity; + z 1.0; + kappa 0.41; + Uref 1.0; + Href 0.0; + z0 uniform 0.0; + zGround uniform 0.0; + } \endverbatim Reference: diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 21b57a5ac4..d0fa2992bd 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -8,10 +8,10 @@ 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 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 @@ -19,11 +19,12 @@ License for more details. You should have received a copy of the GNU General Public License - along with OpenFOAM; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + along with OpenFOAM. If not, see . Class - atmBoundaryLayerInletVelocityFvPatchVectorField + Foam::incompressible::atmBoundaryLayerInletVelocityFvPatchVectorField + +\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions Description This boundary condition specifies a velocity inlet profile appropriate @@ -32,27 +33,29 @@ Description co-ordinate \c z. \f[ - U = (Ustar/K) ln((z - zGround + z0)/z0) + U = \frac{U^*}{K} ln(\frac{z - z_g + z_0}{z_0}) \f] - where: - - \var Ustar = frictional velocity - \var K = Karman's constant - \var z = vertical co-ordinate [m] - \var z0 = surface roughness length [m] - \var zGround = minimum vlaue in z direction [m] + where + /vartable + U^* | frictional velocity + K | Karman's constant + z | vertical co-ordinate [m] + z_0 | surface roughness length [m] + z_g | minimum vlaue in z direction [m] + /endvartable and: \f[ - Ustar = K Uref/ln((Zref + z0)/z0) + U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} \f] where: - - \var Uref = reference velocity at Zref [m/s] - \var Zref = reference height [m] + /vartable + U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] + Z_{ref} | reference height [m] + /endvartable Reference: D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model @@ -66,19 +69,32 @@ Description The roughness height (Er) is given by Er = 20 z0 following the same reference. + /heading Patch usage + + /table + Property | Description | Required | Default value + n | flow direction | yes | + z | vertical co-ordinate [m] | yes | + kappa | Karman's constanat | no | 0.41 + Uref | reference velocity [m/s] | yes | + Href | reference height [m] | yes | + z0 | surface roughness length [m] | yes | + zGround | minimum z co-ordinate [m] | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type atmBoundaryLayerInletVelocity; - n (0 1 0); // flow direction - z 1.0; // vertical co-ordinate [m] - kappa 0.41; // kappa coefficient (default = 0.41) - Uref 1.0; // reference velocity [m/s] - Href 0.0; // reference height [m] - z0 uniform 0.0; // surface roughness length [m] - zGround uniform 0.0; // minimum z co-ordinate [m] - } + myPatch + { + type atmBoundaryLayerInletVelocity; + n (0 1 0); + z 1.0; + kappa 0.41; + Uref 1.0; + Href 0.0; + z0 uniform 0.0; + zGround uniform 0.0; + } \endverbatim SourceFiles From 6b3781680867bb4b3e12cd69294406a86e238541 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 17:08:30 +0100 Subject: [PATCH 035/109] BUG: corrected erroneous use of \f doxygen command --- .../dictionary/functionEntries/codeStream/codeStream.H | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H b/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H index c6c4b53bf5..b8baa0183c 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H @@ -29,12 +29,12 @@ Description generate the entry itself. So - codeStream reads three entries: 'code', 'codeInclude' (optional), 'codeOptions' (optional) - and uses those to generate library sources inside \f codeStream/ + and uses those to generate library sources inside \c codeStream/ - these get compiled using 'wmake libso' - the resulting library is loaded in executed with as arguments \code (const dictionary& dict, Ostream& os) - \endcode + \endcode where the dictionary is the current dictionary. - the code has to write into Ostream which is then used to construct the actual dictionary entry. @@ -77,12 +77,12 @@ Description \c \$ and \c ~ sequences) Note - The code to be compiled is stored under the local \f codeStream directory + The code to be compiled is stored under the local \c codeStream directory with a subdirectory name corresponding to the SHA1 of the contents. The corresponding library code is located under the local - \f codeStream/platforms/$WM_OPTIONS/lib directory in a library - \f libcodeStream_SHA1.so + \c codeStream/platforms/$WM_OPTIONS/lib directory in a library + \c libcodeStream_SHA1.so SourceFiles codeStream.C From 4d318912c11f9bf4d3a513858c94bf7e390ad103 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 17:09:49 +0100 Subject: [PATCH 036/109] ENH: protected use of # in doxygen comment --- src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCodeContext.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCodeContext.H b/src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCodeContext.H index 3f3cccf538..3551e8c20b 100644 --- a/src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCodeContext.H +++ b/src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCodeContext.H @@ -123,7 +123,7 @@ public: return sha1_; } - //- Helper: add #line directive + //- Helper: add \#line directive static void addLineDirective ( string&, From c40bc965ed36c06011d7a3cb7a85bf532eb973d5 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 17:10:45 +0100 Subject: [PATCH 037/109] ENHL code restructuring --- ...sDoc.H => incompressibleRASBoundaryConditionsDoc.H} | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) rename src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/{wallFunctions/incompressibleWallFunctionsDoc.H => incompressibleRASBoundaryConditionsDoc.H} (81%) diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H similarity index 81% rename from src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H rename to src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H index e319b2aee4..366f7e5c9e 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/incompressibleWallFunctionsDoc.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H @@ -21,10 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoRASBoundaryConditions RAS incompressible boundary conditions +@{ + This group contains incompressible RAS turbulence model boundary conditions +@} + \defgroup grpIcoWallFunctions RAS incompressible wall functions @{ - \ingroup grpBoundaryConditions + \ingroup grpIcoRASBoundaryConditions This group contains incompressible RAS turbulence model wall functions @} + \*---------------------------------------------------------------------------*/ From a80d4d9b69b74c1691c8d05c6732572a515898bc Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 12 Jul 2012 17:12:52 +0100 Subject: [PATCH 038/109] ENH: doxygen documentation updates --- .../functionObject/functionObjectsDoc.H | 2 + src/OpenFOAM/global/foamDoc.H | 28 +++++++- .../basicSymmetry/basicSymmetryFvPatchField.H | 8 +-- .../basic/calculated/calculatedFvPatchField.H | 8 +-- .../basic/coupled/coupledFvPatchField.H | 8 +-- .../directionMixedFvPatchField.H | 8 +-- .../fixedGradient/fixedGradientFvPatchField.H | 18 +++-- .../basic/fixedValue/fixedValueFvPatchField.H | 8 +-- .../basic/mixed/mixedFvPatchField.H | 12 ++-- .../basic/sliced/slicedFvPatchField.H | 8 +-- .../basic/transform/transformFvPatchField.H | 8 +-- .../zeroGradient/zeroGradientFvPatchField.H | 7 +- .../constraint/cyclic/cyclicFvPatchField.H | 8 +-- .../cyclicAMI/cyclicAMIFvPatchField.H | 8 +-- .../cyclicSlip/cyclicSlipFvPatchField.H | 8 +-- .../constraint/empty/emptyFvPatchField.H | 8 +-- .../jumpCyclic/jumpCyclicFvPatchField.H | 8 +-- .../nonuniformTransformCyclicFvPatchField.H | 8 +-- .../processor/processorFvPatchField.H | 8 +-- .../processorCyclicFvPatchField.H | 8 +-- .../symmetry/symmetryFvPatchField.H | 7 +- .../constraint/wedge/wedgeFvPatchField.H | 8 +-- .../activeBaffleVelocityFvPatchVectorField.H | 3 +- ...ureForceBaffleVelocityFvPatchVectorField.H | 3 +- .../derived/advective/advectiveFvPatchField.H | 3 +- .../buoyantPressureFvPatchScalarField.H | 20 +++--- .../codedFixedValueFvPatchField.H | 3 +- .../codedMixed/codedMixedFvPatchField.H | 3 +- ...lindricalInletVelocityFvPatchVectorField.H | 3 +- .../derived/fan/fanFvPatchField.H | 3 +- .../fanPressureFvPatchScalarField.H | 5 +- .../fixedFluxPressureFvPatchScalarField.H | 13 ++-- .../fixedInternalValueFvPatchField.H | 3 +- .../derived/fixedJump/fixedJumpFvPatchField.H | 3 +- .../derived/fixedMean/fixedMeanFvPatchField.H | 3 +- .../fixedNormalSlipFvPatchField.H | 3 +- ...ureCompressibleDensityFvPatchScalarField.H | 11 +-- .../flowRateInletVelocityFvPatchVectorField.H | 3 +- .../fluxCorrectedVelocityFvPatchVectorField.H | 7 +- .../freestream/freestreamFvPatchField.H | 3 +- .../freestreamPressureFvPatchScalarField.H | 3 +- .../inletOutlet/inletOutletFvPatchField.H | 3 +- ...OutletTotalTemperatureFvPatchScalarField.H | 3 +- .../mappedField/mappedFieldFvPatchField.H | 3 +- .../mappedFixedInternalValueFvPatchField.H | 3 +- ...ppedFixedPushedInternalValueFvPatchField.H | 3 +- .../mappedFixedValueFvPatchField.H | 3 +- .../mappedFlowRateFvPatchVectorField.H | 11 +-- ...mappedVelocityFluxFixedValueFvPatchField.H | 3 +- .../movingWallVelocityFvPatchVectorField.H | 3 +- ...phaseFixedFluxPressureFvPatchScalarField.H | 9 ++- .../oscillatingFixedValueFvPatchField.H | 3 +- .../outletInlet/outletInletFvPatchField.H | 3 +- .../outletMappedUniformInletFvPatchField.H | 3 +- .../partialSlip/partialSlipFvPatchField.H | 3 +- ...aseHydrostaticPressureFvPatchScalarField.H | 5 +- ...tedInletOutletVelocityFvPatchVectorField.H | 3 +- ...eDirectedInletVelocityFvPatchVectorField.H | 3 +- ...tOutletParSlipVelocityFvPatchVectorField.H | 3 +- ...ureInletOutletVelocityFvPatchVectorField.H | 3 +- ...reInletUniformVelocityFvPatchVectorField.H | 3 +- .../pressureInletVelocityFvPatchVectorField.H | 3 +- ...malInletOutletVelocityFvPatchVectorField.H | 3 +- ...ureInletOutletVelocityFvPatchVectorField.H | 3 +- .../rotatingTotalPressureFvPatchScalarField.H | 7 +- .../rotatingWallVelocityFvPatchVectorField.H | 3 +- .../derived/slip/slipFvPatchField.H | 3 +- .../supersonicFreestreamFvPatchVectorField.H | 3 +- ...urfaceNormalFixedValueFvPatchVectorField.H | 3 +- ...lFlowRateInletVelocityFvPatchVectorField.H | 3 +- .../syringePressureFvPatchScalarField.H | 45 ++++++------ .../temperatureJumpFvPatchScalarField.H | 3 +- .../timeVaryingMappedFixedValueFvPatchField.H | 5 +- .../totalPressureFvPatchScalarField.H | 22 +++--- .../totalTemperatureFvPatchScalarField.H | 3 +- ...ranslatingWallVelocityFvPatchVectorField.H | 3 +- .../turbulentInletFvPatchField.H | 5 +- ...sityKineticEnergyInletFvPatchScalarField.H | 5 +- ...ityHydrostaticPressureFvPatchScalarField.H | 5 +- .../uniformFixedValueFvPatchField.H | 3 +- .../uniformTotalPressureFvPatchScalarField.H | 3 +- .../variableHeightFlowRateFvPatchField.H | 5 +- ...tFlowRateInletVelocityFvPatchVectorField.H | 3 +- .../waveSurfacePressureFvPatchScalarField.H | 3 +- .../waveTransmissiveFvPatchField.H | 3 +- .../fvPatchFields/doc/boundaryConditions.dox | 39 +++++++++++ .../{fvPatchField => doc}/fvPatchFieldDoc.H | 4 +- .../IO/partialWrite/partialWrite.H | 6 +- .../removeRegisteredObject.H | 6 +- .../writeRegisteredObject.H | 6 +- .../cloud/cloudInfo/cloudInfo.H | 6 +- .../fieldAverage/fieldAverage/fieldAverage.H | 6 +- .../fieldCoordinateSystemTransform.H | 6 +- .../field/fieldMinMax/fieldMinMax.H | 6 +- .../field/fieldValues/fieldValue/fieldValue.H | 6 +- .../field/nearWallFields/nearWallFields.H | 6 +- .../field/processorField/processorField.H | 6 +- .../field/readFields/readFields.H | 6 +- .../regionSizeDistribution.H | 6 +- .../field/streamLine/streamLine.H | 6 +- .../surfaceInterpolateFields.H | 6 +- .../field/turbulenceFields/turbulenceFields.H | 6 +- .../wallBoundedStreamLine.H | 6 +- .../forces/forceCoeffs/forceCoeffs.H | 6 +- .../functionObjects/forces/forces/forces.H | 6 +- .../functionObjects/functionObjects.dox | 69 +++++++++++++++++++ .../abortCalculation/abortCalculation.H | 6 +- .../functionObjects/systemCall/systemCall.H | 6 +- .../codedFunctionObject/codedFunctionObject.H | 6 +- .../utilities/dsmcFields/dsmcFields.H | 6 +- .../pressureCoefficient/pressureCoefficient.H | 6 +- .../utilities/staticPressure/staticPressure.H | 6 +- .../timeActivatedFileUpdate.H | 39 +++++------ .../utilities/yPlusLES/yPlusLES.H | 6 +- .../utilities/yPlusRAS/yPlusRAS.H | 6 +- .../compressibleRASBoundaryConditionsDoc.H | 38 ++++++++++ ...convectiveHeatTransferFvPatchScalarField.H | 44 +++++++++++- ...thDissipationRateInletFvPatchScalarField.C | 10 ++- ...thDissipationRateInletFvPatchScalarField.H | 51 +++++++++++--- ...ngLengthFrequencyInletFvPatchScalarField.C | 10 ++- ...ngLengthFrequencyInletFvPatchScalarField.H | 50 +++++++++++--- ...ayatillekeWallFunctionFvPatchScalarField.H | 36 +++++++--- .../alphatWallFunctionFvPatchScalarField.H | 47 +++++++++---- .../epsilonWallFunctionFvPatchScalarField.H | 41 ++++++++++- .../kqRWallFunctionFvPatchField.H | 20 +++++- .../mutLowReWallFunctionFvPatchScalarField.H | 23 +++++-- .../mutURoughWallFunctionFvPatchScalarField.H | 31 ++++++++- ...tUSpaldingWallFunctionFvPatchScalarField.H | 20 +++++- .../mutUWallFunctionFvPatchScalarField.H | 19 ++++- .../mutWallFunctionFvPatchScalarField.H | 20 +++++- .../mutkRoughWallFunctionFvPatchScalarField.H | 36 ++++++++-- .../mutkWallFunctionFvPatchScalarField.H | 20 +++++- .../omegaWallFunctionFvPatchScalarField.H | 38 ++++++++-- ...ndaryLayerInletEpsilonFvPatchScalarField.H | 13 ++-- ...daryLayerInletVelocityFvPatchVectorField.H | 3 +- ...entHeatFluxTemperatureFvPatchScalarField.H | 42 +++++++---- ...thDissipationRateInletFvPatchScalarField.C | 10 ++- ...thDissipationRateInletFvPatchScalarField.H | 51 +++++++++++--- ...ngLengthFrequencyInletFvPatchScalarField.H | 51 +++++++++++--- .../epsilonWallFunctionFvPatchScalarField.H | 8 +-- ...ayatillekeWallFunctionFvPatchScalarField.H | 28 ++++---- .../kqRWallFunctionFvPatchField.H | 12 ++-- .../nutLowReWallFunctionFvPatchScalarField.H | 8 +-- .../nutURoughWallFunctionFvPatchScalarField.H | 10 ++- ...tUSpaldingWallFunctionFvPatchScalarField.H | 8 +-- ...UTabulatedWallFunctionFvPatchScalarField.H | 8 +-- .../nutUWallFunctionFvPatchScalarField.H | 8 +-- .../nutWallFunctionFvPatchScalarField.H | 8 +-- ...tkAtmRoughWallFunctionFvPatchScalarField.H | 10 ++- .../nutkRoughWallFunctionFvPatchScalarField.H | 8 +-- .../nutkWallFunctionFvPatchScalarField.H | 8 +-- .../omegaWallFunctionFvPatchScalarField.H | 8 +-- 152 files changed, 1131 insertions(+), 555 deletions(-) create mode 100644 src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox rename src/finiteVolume/fields/fvPatchFields/{fvPatchField => doc}/fvPatchFieldDoc.H (93%) create mode 100644 src/postProcessing/functionObjects/functionObjects.dox create mode 100644 src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H index 0e93e3e3b3..2e09301232 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H @@ -21,6 +21,8 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + \defgroup grpFunctionObjects Function objects @{ This group contains function objects diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H index 1a38387f5a..27389e27a0 100644 --- a/src/OpenFOAM/global/foamDoc.H +++ b/src/OpenFOAM/global/foamDoc.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -21,6 +21,8 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + \mainpage OpenFOAM®: open source CFD \section about About OpenFOAM @@ -34,4 +36,28 @@ License turbulence and heat transfer, to solid dynamics and electromagnetics. More ... +\section layout Code Layout + + The OpenFOAM source code comprises of four main components: + - src: + the core OpenFOAM source code + + - applications: + collections of library functionality wrapped up into applications, + such as solvers and utilities + + - tutorials: + a suite of test cases that highlight a broad cross-section of + OpenFOAM's capabilities + + - doc: + supporting documentation + +\section usingTheCode Using the code + + - \subpage pagePostProcessing + - \subpage pageBoundaryConditions + - \subpage grpIcoRASBoundaryConditions + + \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H index a4076f6fcf..2e19ff1d2c 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/basicSymmetry/basicSymmetryFvPatchField.H @@ -21,20 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::basicSymmetryFvPatchField +Group + grpConstraintBoundaryConditions + Description A symmetry patch SourceFiles basicSymmetryFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef basicSymmetryFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index 15dc9e2d5f..b7163e5bc0 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::calculatedFvPatchField +Group + grpGenericBoundaryConditions + Description This boundary condition is not designed to be evaluated; it is assmued that the value is assigned via field assignment, and not via a call to @@ -46,8 +46,6 @@ Description SourceFiles calculatedFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef calculatedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H index 4730fe1f1d..1f2dcbfb61 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H @@ -21,20 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::coupledFvPatchField +Group + grpCoupledBoundaryConditions + Description Abstract base class for coupled patches. SourceFiles coupledFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef coupledFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H index d480f24adc..54686db761 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/directionMixed/directionMixedFvPatchField.H @@ -21,20 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::directionMixedFvPatchField +Group + grpGenericBoundaryConditions + Description Base class for direction-mixed boundary conditions. SourceFiles directionMixedFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef directionMixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index f22106bd3a..6290d8f5a5 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -21,26 +21,26 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::fixedGradientFvPatchField +Group + grpGenericBoundaryConditions + Description This boundary condition supplies a fixed gradient condition, such that the patch values are calculated using: \f[ - values = int + gradient/delta + x_p = x_c + \frac{\nabla(x)}{\Delta} \f] where /vartable - values | patch values - int | internal field values - gradient | gradient (user-specified) - delta | inverse distance from patch face centre to cell centre + x_p | patch values + x_c | internal field values + \nabla(x)| gradient (user-specified) + \Delta | inverse distance from patch face centre to cell centre /endvartable /heading Patch usage @@ -62,8 +62,6 @@ Description SourceFiles fixedGradientFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedGradientFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index 8fe16727d9..50b986a760 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::fixedValueFvPatchField +Group + grpGenericBoundaryConditions + Description This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. @@ -50,8 +50,6 @@ Description SourceFiles fixedValueFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef fixedValueFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index c4dbe21204..193dd6cb4d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::mixedFvPatchField +Group + grpGenericBoundaryConditions + Description This boundary condition provides a base class for 'mixed' type boundary conditions, i.e. conditions that mix fixed value and patch-normal gradient @@ -35,7 +35,7 @@ Description The respective contributions from each is determined by a weight field: \f[ - x_p = w*A + (1-w)*(x_c + B/delta) + x_p = w*A + (1-w)*(x_c + B/\Delta) \f] where @@ -45,7 +45,7 @@ Description w | weight field, \c valueFraction_ A | fixed value, \c refValue_ B | patch normal gradient, \c refGrad_ - delta | inverse distance from face centre to internal cell centre + \Delta| inverse distance from face centre to internal cell centre /endvartable \note @@ -58,8 +58,6 @@ SeeAlso SourceFiles mixedFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef mixedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H index e245db2450..06671ea132 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::slicedFvPatchField +Group + grpGenericBoundaryConditions + Description Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field. @@ -42,8 +42,6 @@ SeeAlso SourceFiles slicedFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef slicedFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H index b5d163efbb..0eab206104 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/transform/transformFvPatchField.H @@ -21,20 +21,18 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpBoundaryConditions -@{ - Class Foam::transformFvPatchField +Group + grpGenericBoundaryConditions + Description Foam::transformFvPatchField SourceFiles transformFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef transformFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index ae03fced6c..90f1dc25c6 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::zeroGradientFvPatchField +Group + grpGenericBoundaryConditions + Description This boundary condition appies a zero-gradient condition from the patch internal field onto the patch faces. @@ -43,7 +43,6 @@ Description SourceFiles zeroGradientFvPatchField.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 783e0a6b60..073f5015a4 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::cyclicFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition enforces a cyclic condition between a pair of boundaries. @@ -49,8 +49,6 @@ Description SourceFiles cyclicFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef cyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index 5c5a7d25d4..ac2e442921 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::cyclicAMIFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using @@ -53,8 +53,6 @@ SeeAlso SourceFiles cyclicAMIFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef cyclicAMIFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 38e633fc95..3f77c1f8fc 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::cyclicSlipFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality. @@ -47,8 +47,6 @@ SeeAlso SourceFiles cyclicSlipFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef cyclicSlipFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index a7ef6a816d..9f1e8caf01 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::emptyFvPatchField +Group + grpConstraintBoundaryConditions + Description This boundary condition provides an 'empty' condition for reduced dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to @@ -46,8 +46,6 @@ Description SourceFiles emptyFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef emptyFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H index 98f4ea45fe..a5fd2343bf 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::jumpCyclicFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition provides a base class for coupled-cyclic conditions with a specified 'jump' (or offset) between the values @@ -37,8 +37,6 @@ SeeAlso SourceFiles jumpCyclicFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef jumpCyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H index 7d42a6aac0..576d4d0833 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::nonuniformTransformCyclicFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition enforces a cyclic condition between a pair of boundaries, incorporating a non-uniform transformation. @@ -37,8 +37,6 @@ SourceFiles nonuniformTransformCyclicFvPatchFields.C nonuniformTransformCyclicFvPatchFieldsFwd.H -@} - \*---------------------------------------------------------------------------*/ #ifndef nonuniformTransformCyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 649202cd20..6278a3567f 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::processorFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition enables processor communication across patches. @@ -43,8 +43,6 @@ Description SourceFiles processorFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef processorFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 0828c8ceb3..12ad60fcbc 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::processorCyclicFvPatchField +Group + grpCoupledBoundaryConditions + Description This boundary condition enables processor communication across cyclic patches. @@ -50,8 +50,6 @@ SourceFiles processorCyclicFvPatchFields.C processorCyclicFvPatchFieldsFwd.H -@} - \*---------------------------------------------------------------------------*/ #ifndef processorCyclicFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index 8087f248af..26fa081eb7 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::symmetryFvPatchField +Group + grpConstraintBoundaryConditions + Description This boundary condition enforces a symmetry constraint @@ -45,7 +45,6 @@ SourceFiles symmetryFvPatchFields.C symmetryFvPatchFields.H symmetryFvPatchFieldsFwd.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index d539700e2c..de4072625b 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.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 grpBoundaryConditions -@{ - Class Foam::wedgeFvPatchField +Group + grpConstraintBoundaryConditions + Description This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries. @@ -47,8 +47,6 @@ SeeAlso SourceFiles wedgeFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef wedgeFvPatchField_H diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index e5fc8c3c15..08423e848f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::activeBaffleVelocityFvPatchVectorField -\ingroup grpCoupledBoundaryConditions +Group + grpCoupledBoundaryConditions Description This velocity boundary condition simulates the opening of a baffle due diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 350f2113a1..0957852428 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::activePressureForceBaffleVelocityFvPatchVectorField -\ingroup grpCoupledBoundaryConditions +Group + grpCoupledBoundaryConditions Description This boundary condition is applied to the flow velocity, to simulate the diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 9a87eaf77d..b5f143acac 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::advectiveFvPatchField -\ingroup grpOutletBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition provides an advective outflow condition, based on diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 05e88b18cd..39e59bfcc6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::buoyantPressureFvPatchScalarField -\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions +Group + grpGenericBoundaryConditions grpWallBoundaryConditions Description This boundary condition sets the pressure gradient appropriately for @@ -34,31 +35,30 @@ Description - \c pd - \c p_rgh - \c ph_rgh - we assume that the pressure variable is \f$p - rho*g.h\f$ and the gradient - set using: + we assume that the pressure variable is \f$p - \rho(g \cdot h)\f$ and the + gradient set using: \f[ - grad(pressure) = -snGrad(rho)*(g.h) + \nabla(p) = -\nabla_\perp(\rho)(g \cdot h) \f] where /vartable - snGrad | surface-normal gradient operator - rho | density [kg/m3] + \rho | density [kg/m3] g | acceleration due to gravity [m/s2] h | patch face centres [m] - /endtable + /endvartable Otherwise we assume that it is the static pressure, and the gradient calculated using: \f[ - grad(pressure) = rho*(g.n) + \nabla(p) = \rho(g \cdot n) \f] where /vartable n | patch face normal vectors - /endtable + /endvartable /heading Patch usage @@ -94,7 +94,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class buoyantPressureFvPatch Declaration + Class buoyantPressureFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class buoyantPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 8bda7a7952..04c2562f49 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::codedFixedValueFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description Constructs on-the-fly a new boundary condition (derived from diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 1d9ce49b8c..e35c4af2c3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::codedMixedFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description Constructs on-the-fly a new boundary condition (derived from diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index e9d2a3455b..6ffa995cde 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::cylindricalInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition describes an inlet vector boundary condition in diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 86d52ed1f0..bb0f3574c7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::fanFvPatchField -\ingroup grpCoupledBoundaryConditions +Group + grpCoupledBoundaryConditions Description This boundary condition supplies a jump condition, using the \c cyclic diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index ad25e082ff..a8124bb38b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::fanPressureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition can be applied to assign either a pressure inlet @@ -97,8 +98,10 @@ public: ffdOut }; + //- Fan flow directions names static const NamedEnum fanFlowDirectionNames_; + private: // Private data diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index 52768875e6..5bc8a2281c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -24,23 +24,26 @@ License Class Foam::fixedFluxPressureFvPatchScalarField -\ingroup grpBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition adjusts the pressure gradient such that the flux on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as - is the pressure diffusivity \c Dp used to calculate the gradient using: + as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as + is the pressure diffusivity used to calculate the gradient using: \f[ - grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} + \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| D_p} \f] where /vartable + phi | flux + D_p | pressure diffusivity Sf | patch face areas [m2] /endvartable @@ -58,7 +61,7 @@ Description \verbatim myPatch { - type externalWallHeatFluxTemperature; + type fixedFluxPressure; phiHbyA phiHbyA; phi phi; rho rho; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 1410335358..868a333565 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::fixedInternalValueFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition provides a mechanism to set boundary (cell) values diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index caaa866306..983edbfa92 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::fixedJumpFvPatchField -\ingroup grpCoupledBoundaryConditions +Group + grpCoupledBoundaryConditions Description Base class for "jump" of a field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index 7fd5c515a9..bce30465cd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::fixedMeanFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition extrapolates field to the patch using the near-cell diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 1c387e48a5..21e4ae88ea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::fixedNormalSlipFvPatchField -\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions +Group + grpGenericBoundaryConditions grpWallBoundaryConditions Description This boundary condition sets the patch-normal component to a fixed value. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index af16f8e270..5f0cf8c403 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -24,22 +24,23 @@ License Class Foam::fixedPressureCompressibleDensityFvPatchScalarField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition calculates a (liquid) compressible density as a function of pressure and fluid properties: \f[ - rho = rho_{l,sat} + psi_l*(p - p_{sat}) + \rho = \rho_{l,sat} + \psi_l*(p - p_{sat}) \f] where /vartable - rho | density [kg/m3] - rho_{l,sat} | saturation liquid density [kg/m3] - psi_l | liquid compressibility + \rho | density [kg/m3] + \rho_{l,sat} | saturation liquid density [kg/m3] + \psi_l | liquid compressibility p | pressure [Pa] p_{sat} | saturation pressure [Pa] /endvartable diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 9875120c18..dac06b8ba8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::flowRateInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a velocity boundary condition, derived diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 37a508e5ef..9e9e6b638e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::fluxCorrectedVelocityFvPatchVectorField -\ingroup grpOutletBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition provides a velocity outlet boundary condition for @@ -32,7 +33,7 @@ Description by "zeroGradient" and then corrected from the flux: \f[ - U_p = U_c - n*(n.U_c) + n*phi/mag(Sf) + U_p = U_c - n*(n.U_c) + \frac{n*\phi_p}{|Sf|} \f] where @@ -41,7 +42,7 @@ Description U_p | velocity at the patch [m/s] U_c | velocity in cells adjacent to the patch [m/s] n | patch normal vectors - phi | flux at the patch [m3/s or kg/s] + \phi_p | flux at the patch [m3/s or kg/s] Sf | patch face area vectors [m2] /endvartable diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 90fae4911b..57373b69cb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::freestreamFvPatchField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a free-stream condition. It is a 'mixed' diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index d1f8214bc3..28eedd1752 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::freestreamPressureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a free-stream condition for pressure. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 1ba72744df..b5b7fcf492 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::inletOutletFvPatchField -\ingroup grpOutletBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition provides a generic outflow condition, with diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index ef2f279e24..d6487efc93 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::inletOutletTotalTemperatureFvPatchScalarField -\ingroup grpOutletBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition provides an outflow condition for total diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 8c9c39b9d5..554f4ef868 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::mappedFieldFvPatchField -\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions +Group + grpGenericBoundaryConditions grpCoupledBoundaryConditions Description This boundary condition provides a self-contained version of the \c mapped diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index f5f2a5b167..30dd2f27b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::mappedFixedInternalValueFvPatchField -\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions +Group + grpGenericBoundaryConditions grpCoupledBoundaryConditions Description This boundary condition maps the boundary and internal values of a diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 12aa98c6b8..45ee30032d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::mappedFixedPushedInternalValueFvPatchField -\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions +Group + grpGenericBoundaryConditions grpCoupledBoundaryConditions Description This boundary condition maps the boundary values of a neighbour patch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 0a7e597e9a..4fc5f332dd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::mappedFixedValueFvPatchField -\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions +Group + grpGenericBoundaryConditions grpCoupledBoundaryConditions Description This boundary condition maps the value at a set of cells or patch faces diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 253294c0cd..76b5726e6e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,7 +24,8 @@ License Class Foam::mappedFlowRateFvPatchVectorField -\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions +Group + grpInletBoundaryConditions grpCoupledBoundaryConditions Description Describes a volumetric/mass flow normal vector boundary condition by its @@ -46,8 +47,8 @@ Description /endtable Example of the boundary condition specification: - /verbatim - inlet + \verbatim + myPatch { type mappedFlowRate; phi phi; @@ -55,7 +56,7 @@ Description neigPhi phi; value uniform (0 0 0); // placeholder } - /endverbatim + \endverbatim SourceFiles mappedFlowRateFvPatchVectorField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 0dea9e1ed1..175d2cd386 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::mappedVelocityFluxFixedValueFvPatchField -\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions +Group + grpInletBoundaryConditions grpCoupledBoundaryConditions Description This boundary condition maps the velocity and flux from a neighbour patch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index daf1a77df4..e4706c3d37 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::movingWallVelocityFvPatchVectorField -\ingroup grpWallBoundaryConditions +Group + grpWallBoundaryConditions Description This boundary condition provides a velocity condition for cases with diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index a03bf05439..cf2b0c95b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -24,23 +24,26 @@ License Class Foam::multiphaseFixedFluxPressureFvPatchScalarField -\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions +Group + grpWallBoundaryConditions grpGenericBoundaryConditions Description This boundary condition adjusts the pressure gradient such that the flux on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as \f$(phi - phiHbyA)\f$, both of which are looked-up from the database, as + as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as is the pressure diffusivity Dp used to calculate the gradient using: \f[ - grad(pressure) = \frac{phiHbyA - phi}{mag(Sf)*Dp} + \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| Dp} \f] where /vartable + \phi | flux + Dp | pressure diffusivity Sf | patch face areas [m2] /endvartable diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index 4cb745fad5..d42c23f5dd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::oscillatingFixedValueFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition provides an oscillating condition in terms of diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 13973910b1..a26db47e41 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::outletInletFvPatchField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a generic inflow condition, with diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 4e5c3ff062..8098a68b7e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::outletMappedUniformInletFvPatchField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary conditon averages the field over the "outlet" patch specified diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index eb883458f7..8d081efa06 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::partialSlipFvPatchField -\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions +Group + grpWallBoundaryConditions grpGenericBoundaryConditions Description This boundary condition provides a partial slip condition. The amount of diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 673e51c072..0cdc4650f5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -24,14 +24,15 @@ License Class Foam::phaseHydrostaticPressureFvPatchScalarField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition provides a phase-based hydrostatic pressure condition, calculated as: \f[ - p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) + p_{hyd} = p_{ref} + \rho g (x - x_{ref}) \f] where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index bfe5aab9f5..c6e2a8c0c5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureDirectedInletOutletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This velocity inlet/outlet boundary condition is applied to pressure diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index c4c0a57092..47cfd0e22a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureDirectedInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This velocity inlet boundary condition is applied to patches where the diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index dab033544b..128dc1ec26 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureInletOutletParSlipVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This velocity inlet/outlet boundary condition for pressure boundary where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 71b4ce4238..a162c6d254 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureInletOutletVelocityFvPatchVectorField -\ingroup grpInletletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletletBoundaryConditions grpOutletBoundaryConditions Description This velocity inlet/outlet boundary condition is applied to pressure diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index ed9cf68188..56750ed091 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureInletUniformVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This velocity inlet boundary condition is applied to patches where the diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 3acb22984b..13bc501b21 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This velocity inlet boundary condition is applied to patches where the diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 7cfb0c639a..86ef8bc4e4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::pressureNormalInletOutletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This velocity inlet/outlet boundary condition is applied to patches where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 2a5254195d..a48f2c3782 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::rotatingPressureInletOutletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This velocity inlet/outlet boundary condition is applied to patches in a diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index 29c9eb822c..c3000b4f15 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::rotatingTotalPressureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a total pressure condition for patches @@ -36,8 +37,8 @@ Description Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi - rho | density field name | no | rho - psi | compressibility field name | no | psi + rho | density field name | no | none + psi | compressibility field name | no | none gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | omega | angular velocty of the frame [rad/s] | yes | diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index bfdce14ba7..5d7ae1dd7d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::rotatingWallVelocityFvPatchVectorField -\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions +Group + grpWallBoundaryConditions grpGenericBoundaryConditions Description This boundary condition provides a rotational velocity condition. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index f216b358ed..1d936aa811 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::slipFvPatchField -\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions +Group + grpWallBoundaryConditions grpGenericBoundaryConditions Description This boundary condition provides a slip constraint. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index fca7044c78..e614212296 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::supersonicFreestreamFvPatchVectorField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a supersonic free-stream condition. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 5f223d6dbc..71200d9512 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::surfaceNormalFixedValueFvPatchVectorField -\ingroup grpGenericBoundaryConditions grpInletBoundaryConditions +Group + grpGenericBoundaryConditions grpInletBoundaryConditions Description This boundary condition provides a surface-normal vector boundary condition diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 1be1e1ca92..d827e8cd46 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::swirlFlowRateInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a volumetric- OR mass-flow normal vector diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 8e40b42d9a..8fe219d412 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::syringePressureFvPatchScalarField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a pressure condition, obtained from a @@ -40,16 +41,16 @@ Description /table Property | Description | Required | Default value - Ap | syringe piston area | yes | - Sp | syringe piston speed | yes | - VsI | initial syringe volume | yes | - tas | start of piston acceleration | yes | - tae | end of piston acceleration | yes | - tds | start of piston deceleration | yes | - tde | end of piston deceleration | yes | - psI | initial syringe pressure | yes | - psi | gas compressibility | yes | - ams | added (or removed) gas mass | yes | + Ap | syringe piston area [m2] | yes | + Sp | syringe piston speed [m/s] | yes | + VsI | initial syringe volume [m3] | yes | + tas | start of piston acceleration [s] | yes | + tae | end of piston acceleration [s] | yes | + tds | start of piston deceleration [s] | yes | + tde | end of piston deceleration [s] | yes | + psI | initial syringe pressure [Pa] | yes | + psi | gas compressibility [m2/s2] | yes | + ams | added (or removed) gas mass [kg] | yes | /endtable Example of the BC specification: @@ -57,17 +58,17 @@ Description myPatch { type syringePressure; - Ap 1.388e-6; // syringe piston area - Sp 0.01; // syringe piston speed - VsI 1.388e-8; // Initial syringe volume - tas 0.001; // Start of piston acceleration - tae 0.002; // End of piston acceleration - tds 0.005; // Start of piston deceleration - tde 0.006; // end of piston deceleration - psI 1e5; // Initial syringe pressure - psi 1e-5; // Gas compressibility - ams 0; // Added (or removed) gas mass - value uniform 0 // Initially 0 but used for restarting + Ap 1.388e-6; + Sp 0.01; + VsI 1.388e-8; + tas 0.001; + tae 0.002; + tds 0.005; + tde 0.006; + psI 1e5; + psi 1e-5; + ams 0; + value uniform 0; } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index 8433ddfa21..28719fd964 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::temperatureJumpFvPatchScalarField -\ingroup grpCoupledBoundaryConditions +Group + grpCoupledBoundaryConditions Description This boundary condition provides a temperature jump condition across a diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 9566c298b4..e6dc3fdc2b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -24,12 +24,13 @@ License Class Foam::timeVaryingMappedFixedValueFvPatchField -\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions +Group + grpInletBoundaryConditions grpCoupledBoundaryConditions Description This boundary conditions interpolates the values from a set of supplied points in space and time. Supplied data should be specified in - constant/boundaryData/ where: + constant/boundaryData/\ where: - points : pointField with locations - ddd : supplied values at time ddd The points should be more or less on a plane since they get triangulated diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index 715c993cf4..a98adc9910 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -24,15 +24,16 @@ License Class Foam::totalPressureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a total pressure condition. Four variants are possible: - - incompressible subsonic: + 1. incompressible subsonic: \f[ - p_T = p_0 + 0.5*|U|^2 + p_T = p_0 + 0.5 |U|^2 \f] where /vartable @@ -41,9 +42,9 @@ Description U | velocity /endvartable - - compressible subsonic: + 2. compressible subsonic: \f[ - p_T = p_0 + 0.5*\rho*|U|^2 + p_T = p_0 + 0.5 \rho |U|^2 \f] where /vartable @@ -53,26 +54,27 @@ Description U | velocity /endvartable - - compressible supersonic (\gamma > 1): + 3. compressible transonic (\gamma <= 1): \f[ - p_T = \frac{p_0}{(1 + 0.5*\psi*G)^{\frac{1}{G}}} + p_T = \frac{p_0}{1 + 0.5 \psi |U|^2} \f] where /vartable p_T | total pressure [Pa] p_0 | reference pressure [Pa] - \psi | compressibility [m2/s2] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ /endvartable - - compressible transonic (\gamma <= 1): + 4. compressible supersonic (\gamma > 1): \f[ - p_T = \frac{p_0}{1 + 0.5*\psi*|U|^2} + p_T = \frac{p_0}{(1 + 0.5 \psi G)^{\frac{1}{G}}} \f] where /vartable + \gamma | ratio of specific heats (Cp/Cv) p_T | total pressure [Pa] p_0 | reference pressure [Pa] + \psi | compressibility [m2/s2] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ /endvartable diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index c095b2fbd0..465b02d370 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::totalTemperatureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a total temperature condition. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index bff3ffeccb..821a6e36b5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::translatingWallVelocityFvPatchVectorField -\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions +Group + grpWallBoundaryConditions grpGenericBoundaryConditions Description This boundary condition provides a velocity condition for translational diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 2d61ae94d3..8f30d3a6cc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -24,14 +24,15 @@ License Class Foam::turbulentInletFvPatchField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition generates a fluctuating inlet condition by adding a random component to a reference (mean) field. \f[ - x_p = (1 - \alpha)*x_p^{n-1} + \alpha*(x_{ref}+C_{RMS}*s*x_{ref}) + x_p = (1 - \alpha) x_p^{n-1} + \alpha (x_{ref} + s C_{RMS} x_{ref}) \f] where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index 1774e06f02..b7acbae470 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a turbulent kinetic energy condition, @@ -32,7 +33,7 @@ Description mean velocity: \f[ - k_p = 1.5*(I)*|U|^2 + k_p = 1.5 I |U|^2 \f] where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index a8002088a2..4c162ec16a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -24,14 +24,15 @@ License Class Foam::uniformDensityHydrostaticPressureFvPatchScalarField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition provides a hydrostatic pressure condition, calculated as: \f[ - p_{hyd} = p_{ref} + \rho*g.(x - x_{ref}) + p_{hyd} = p_{ref} + \rho g (x - x_{ref}) \f] where diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 4953b2ef2c..38a13d398d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::uniformFixedValueFvPatchField -\ingroup grpGenericBoundaryConditions +Group + grpGenericBoundaryConditions Description This boundary condition provides a uniform fixed value condition. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 4aab5f54fe..a23db5daa2 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::uniformTotalPressureFvPatchScalarField -\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions +Group + grpInletBoundaryConditions grpOutletBoundaryConditions Description This boundary condition provides a time-varying form of the uniform total diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index e9b764fe53..67faf746de 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::variableHeightFlowRateFvPatchScalarField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a phase fraction condition based on the @@ -58,7 +59,7 @@ Description upperBound 0.9; value uniform 0; } - \verbatim + \endverbatim SourceFiles variableHeightFlowRateFvPatchScalarField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index cef322e614..f14dc5c1b5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::variableHeightFlowRateInletVelocityFvPatchVectorField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This boundary condition provides a velocity boundary condition for diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index feab7a21c0..1687542e49 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -24,7 +24,8 @@ License Class Foam::waveSurfacePressureFvPatchScalarField -\ingroup grpInletBoundaryConditions +Group + grpInletBoundaryConditions Description This is a pressure boundary condition, whose value is calculated as diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 9e30f3701b..9940415bce 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -24,7 +24,8 @@ License Class Foam::waveTransmissiveFvPatchField -\ingroup grpOutletBoundaryConditions +Group + grpOutletBoundaryConditions Description This boundary condition provides a wave transmissive outflow condition, diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox new file mode 100644 index 0000000000..89aef25aa3 --- /dev/null +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -0,0 +1,39 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\page pageBoundaryConditions Boundary Conditions + +\ref grpBoundaryConditions + +\section secBoundaryConditionsOverview Overview + +- \ref grpConstraintBoundaryConditions +- \ref grpInletBoundaryConditions +- \ref grpOutletBoundaryConditions +- \ref grpGenericBoundaryConditions +- \ref grpCoupledBoundaryConditions +- \ref grpWallBoundaryConditions + +\*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H similarity index 93% rename from src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H rename to src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H index 4918858612..e4461605f6 100644 --- a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H +++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H @@ -52,7 +52,7 @@ License This group contains generic boundary condition types @} -\defgroup grpGenericBoundaryConditions Coupled boundary Conditions +\defgroup grpCoupledBoundaryConditions Coupled boundary Conditions @{ \ingroup grpBoundaryConditions This group contains coupled boundary condition types @@ -64,4 +64,4 @@ License This group contains wall boundary condition types @} -// ************************************************************************* // +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index d2a878618b..bf0afd49a6 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index 644f2f3853..c621047a0b 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -21,19 +21,17 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpIOFunctionObjects -@{ - Class Foam::removeRegisteredObject +\ingroup grpIOFunctionObjects + Description Removes registered IO objects if present in the database SourceFiles removeRegisteredObject.C IOremoveRegisteredObject.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index aaaf68044e..d894fb392d 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -21,19 +21,17 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpIOFunctionObjects -@{ - Class Foam::writeRegisteredObject +\ingroup grpIOFunctionObjects + Description Takes over the writing of registered IO objects SourceFiles writeRegisteredObject.C IOwriteRegisteredObject.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 1c1494864e..f45591d924 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 948733c18f..ec00c29359 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index c257b0617f..618b5da574 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 55198bff72..15e25484fe 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index 414d19bbcf..2c12c2d024 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -21,18 +21,16 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::fieldValue +\ingroup grpFieldFunctionObjects + Description Base class for field value -based function objects. SourceFiles fieldValue.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index bbfc352afe..151b8cd959 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::nearWallFields +\ingroup grpFieldFunctionObjects + Description Samples near-patch volFields @@ -56,7 +55,6 @@ Description SourceFiles nearWallFields.C IOnearWallFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index 1bf8282685..c748e17fd1 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 400036e2fd..32cc119cbf 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 3a7a29ccf9..95cedb6517 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index 16d26e2a7b..7ee9abec12 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -21,18 +21,16 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::streamLine +\ingroup grpFieldFunctionObjects + Description Generation of streamlines. Samples along track of passive particle. SourceFiles streamLine.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 4d4697426c..b91fd64632 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::surfaceInterpolateFields +\ingroup grpFieldFunctionObjects + Description Linear interpolates volFields to surfaceFields @@ -52,7 +51,6 @@ Description SourceFiles surfaceInterpolateFields.C IOsurfaceInterpolateFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 33a6f44d11..9cabbd0eb1 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 7e20da7e0b..a9d54a2ba8 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -21,18 +21,16 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::wallBoundedStreamLine +\ingroup grpFieldFunctionObjects + Description Generation of streamlines. Samples along track of passive particle. SourceFiles wallBoundedStreamLine.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index 56351be370..f51f180d24 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index abf9df97ef..d2c224abaa 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/functionObjects.dox b/src/postProcessing/functionObjects/functionObjects.dox new file mode 100644 index 0000000000..ee4355a656 --- /dev/null +++ b/src/postProcessing/functionObjects/functionObjects.dox @@ -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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 + +
    +\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. + + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 3d9a3f19e2..143b7b38b6 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index 3a3d9965af..9726836d80 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -21,19 +21,17 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpFunctionObjects -@{ - Class Foam::systemCall +\ingroup grpFunctionObjects + Description Executes system calls, entered in the form of a string list SourceFiles systemCall.C IOsystemCall.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 1171951b33..8e2f1795ce 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -21,18 +21,16 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::codedFunctionObject +\ingroup grpUtilitiesFunctionObjects + Description functionObject using dynamic code compilation. SourceFiles codedFunctionObject.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index 57b9c317c2..0a037a2aec 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::dsmcFields +\ingroup grpUtilitiesFunctionObjects + Description Calculate intensive fields: - UMean @@ -38,7 +37,6 @@ Description SourceFiles dsmcFields.C IOdsmcFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 93be6c8344..db5f1dcc4b 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index fae08db94a..56586b256d 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index 9d6a2a578f..afb63cb323 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -21,39 +21,38 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index b0225aab16..14a2ba895b 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 1ed5275561..3e35bb4bfb 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -21,12 +21,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\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 -@} \*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H new file mode 100644 index 0000000000..152f631578 --- /dev/null +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H @@ -0,0 +1,38 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpRASBoundaryConditions RAS compressible boundary conditions +@{ + This group contains compressible RAS turbulence model boundary conditions +@} + +\defgroup grpCmpWallFunctions RAS compressible wall functions +@{ + \ingroup grpCmpRASBoundaryConditions + This group contains compressible RAS turbulence model wall functions +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index 8731d01a6e..e2dedbb2f5 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -24,8 +24,50 @@ License Class Foam::compressible::RASModels::convectiveHeatTransferFvPatchScalarField +Group + grpCmpRASBoundaryConditions + Description - Convective heat transfer boundary condition + This boundary condition provides a convective heat transfer coefficient + condition + + if Re > 500000 + \f[ + htc_p = \frac{0.664 Re^{0.5} Pr^{0.333} \kappa_p}{L} + \f] + else + \f[ + htc_p = \frac{0.037 Re^{0.8} Pr^{0.333} \kappa_p}{L} + \f] + + where + + /vartable + htc_p | patch convective heat transfer coefficient + Re | Reynolds number + Pr | Prandtl number + \kappa_p | thermal conductivity + L | length scale + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + L | Length scale [m] | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type turbulentInlet; + L 0.1; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles convectiveHeatTransferFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C index 25a34bf82e..2811ea2579 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,14 +48,15 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField : inletOutletFvPatchScalarField(p, iF), mixingLength_(0.0), - phiName_("undefined-phi"), - kName_("undefined-k") + phiName_("phi"), + kName_("k") { this->refValue() = 0.0; this->refGrad() = 0.0; this->valueFraction() = 0.0; } + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -71,6 +72,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -91,6 +93,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField this->valueFraction() = 0.0; } + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -103,6 +106,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 25a401239a..9f827b8745 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,19 +25,52 @@ Class Foam::compressible:: turbulentMixingLengthDissipationRateInletFvPatchScalarField +Group + grpCmpRASBoundaryConditions grpInletBoundaryConditions + Description - Calculate epsilon via the mixing length [m] + This boundary condition provides a turbulence dissipation, \f$\epsilon\f$ + (epsilon) inlet condition based on a specified mixing length. The patch + values are calculated using: + + \f[ + \epsilon_p = \frac{C_{\mu}^{0.75} k^{1.5}}{L} + \f] + + where + + /vartable + \epsilon_p | patch epsilon values + C_{\mu} | Model coefficient, set to 0.09 + k | turbulence kinetic energy + L | length scale + /endvartable + + \note + In the event of reverse flow, a zero-gradient condition is applied + + /heading Patch usage + + /table + Property | Description | Required | Default value + mixingLength | Length scale [m] | yes | + phi | flux field name | no | phi + k | turbulence kinetic energy field name | no | k + /endtable Example of the boundary condition specification: \verbatim - inlet - { - type compressible::turbulentMixingLengthDissipationRateInlet; - mixingLength 0.005; // 5 mm - value uniform 200; // placeholder - } + myPatch + { + type compressible::turbulentMixingLengthDissipationRateInlet; + mixingLength 0.005; + value uniform 200; // placeholder + } \endverbatim +SeeAlso + Foam::inletOutletFvPatchField + SourceFiles turbulentMixingLengthDissipationRateInletFvPatchScalarField.C @@ -56,7 +89,7 @@ namespace compressible { /*---------------------------------------------------------------------------*\ - Class turbulentMixingLengthDissipationRateInletFvPatch Declaration + Class turbulentMixingLengthDissipationRateInletFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class turbulentMixingLengthDissipationRateInletFvPatchScalarField diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.C b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.C index f60fb9555f..eda8faf324 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.C +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,14 +48,15 @@ turbulentMixingLengthFrequencyInletFvPatchScalarField : inletOutletFvPatchScalarField(p, iF), mixingLength_(0.0), - phiName_("undefined-phi"), - kName_("undefined-k") + phiName_("phi"), + kName_("k") { this->refValue() = 0.0; this->refGrad() = 0.0; this->valueFraction() = 0.0; } + turbulentMixingLengthFrequencyInletFvPatchScalarField:: turbulentMixingLengthFrequencyInletFvPatchScalarField ( @@ -71,6 +72,7 @@ turbulentMixingLengthFrequencyInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthFrequencyInletFvPatchScalarField:: turbulentMixingLengthFrequencyInletFvPatchScalarField ( @@ -91,6 +93,7 @@ turbulentMixingLengthFrequencyInletFvPatchScalarField this->valueFraction() = 0.0; } + turbulentMixingLengthFrequencyInletFvPatchScalarField:: turbulentMixingLengthFrequencyInletFvPatchScalarField ( @@ -103,6 +106,7 @@ turbulentMixingLengthFrequencyInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthFrequencyInletFvPatchScalarField:: turbulentMixingLengthFrequencyInletFvPatchScalarField ( diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 288a9e30de..539d5f892d 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,20 +24,52 @@ License Class Foam::compressible::turbulentMixingLengthFrequencyInletFvPatchScalarField +Group + grpCmpRASBoundaryConditions grpInletBoundaryConditions + Description - Calculate omega via the mixing length + This boundary condition provides a turbulence specific dissipation, + \f$\omega\f$ (omega) inlet condition based on a specified mixing length. + The patch values are calculated using: + + \f[ + \omega_p = \frac{k^{0.5}}{C_{\mu}^{0.25} L} + \f] + + where + + /vartable + \omega_p | patch omega values + C_{\mu} | Model coefficient, set to 0.09 + k | turbulence kinetic energy + L | length scale + /endvartable + + \note + In the event of reverse flow, a zero-gradient condition is applied + + /heading Patch usage + + /table + Property | Description | Required | Default value + mixingLength | Length scale [m] | yes | + phi | flux field name | no | phi + k | turbulence kinetic energy field name | no | k + /endtable Example of the boundary condition specification: \verbatim - inlet - { - type compressible::turbulentMixingLengthFrequencyInlet; - mixingLength 0.005; // 5 mm - k k; // turbulent k field - value uniform 5; // initial value - } + myPatch + { + type compressible::turbulentMixingLengthFrequencyInlet; + mixingLength 0.005; + value uniform 200; // placeholder + } \endverbatim +SeeAlso + Foam::inletOutletFvPatchField + SourceFiles turbulentMixingLengthFrequencyInletFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index a3cf15a47b..b098ffca89 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -24,22 +24,38 @@ License Class alphatJayatillekeWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Thermal wall function for turbulent thermal diffusivity (usually - \c alphaSgs) based on the Jayatilleke model. + This boundary condition provides a thermal wall function for turbulent + thermal diffusivity (usually\c alphat) based on the Jayatilleke model. + + /heading Patch usage + + /table + Property | Description | Required | Default value + Prt | turbulent Prandtl number | no | 0.85 + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type alphaSgsJayatillekeWallFunction; - Prt 0.85; // turbulent Prandtl number (default = 0.85) - kappa 0.41; // Von Karman constant (default = 0.41) - E 9.8; // E coefficient (default = 9.8) - value uniform 0; // optional value entry - } + myPatch + { + type alphaSgsJayatillekeWallFunction; + Prt 0.85; + kappa 0.41; + E 9.8; + value uniform 0; // optional value entry + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles alphatJayatillekeWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 0e6b27275d..41d9abbfd3 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -24,29 +24,50 @@ License Class Foam::compressible::RASModels::alphatWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Boundary condition for turbulent thermal diffusivity when using wall - functions + This boundary condition provides a turbulent thermal diffusivity conditon + when using wall functions + - replicates OpenFOAM v1.5 (and earlier) behaviour - \li replicates OpenFOAM v1.5 (and earlier) behaviour - - Turbulent thermal diffusivity calculated using: + The turbulent thermal diffusivity calculated using: \f[ - alphat = mut/Prt + \alpha_t = \frac{\mu_t}{Pr_t} \f] + where + + /vartable + \alpha_t| turblence thermal diffusivity + \mu_t | turblence viscosity + Pr_t | turblent Prandtl number + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + mut | turbulence viscosity field name | no | mut + Prt | turbulent Prandtl number | no | 0.85 + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type alphatWallFunction; - mut mut; // turbulent viscosity field (default = mut) - Prt 0.85; // turbulent Prandtl number (default = 085) - value uniform 0; // optional value entry - } + myPatch + { + type alphatWallFunction; + mut mut; + Prt 0.85; + value uniform 0; // optional value entry + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles alphatWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index d523c8d38f..515b605403 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -24,10 +24,45 @@ License Class Foam::compressible::RASModels::epsilonWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Boundary condition for epsilon when using wall functions - - calculates epsilon and G - - epsilon values added directly into the matrix to act as a constraint + This boundary condition provides a turbulence dissipation wall function + condition for high Reynolds number, turbulent flow cases. + + The condition can be applied to wall boundaries, whereby it + - calculates \c epsilon and \c G + - inserts near wall epsilon values directly into the epsilon equation + to act as a constraint + + where + + /vartable + epsilon | turblence dissipation field + G | turblence generation field + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + G | turbulence generation field name | no | G + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type compressible::epsilonWallFunction; + } + \endverbatim + +SeeAlso + Foam::fixedInternalValueFvPatchField SourceFiles epsilonWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index a2756319a5..95953977da 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -24,9 +24,25 @@ License Class Foam::compressible::RASModels::kqRWallFunctionFvPatchField +Group + grpIcoWallFunctions + Description - Boundary condition for turbulence k, Q, and R when using wall functions. - Simply acts as a zero gradient condition. + This boundary condition is applied to turbulence \c k, \c q, and \c R + when using wall functions, and simply enforces a zero-gradient condition. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type compressible::kqRWallFunction; + } + \endverbatim + +SeeAlso + Foam::zeroGradientFvPatchField SourceFiles kqRWallFunctionFvPatchField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H index bbed4a8bbf..886eb0ef7c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H @@ -24,11 +24,26 @@ License Class Foam::compressible::RASModels::mutLowReWallFunctionFvPatchScalarField -Description - Boundary condition for turbulent (kinematic) viscosity when for use with - low Reynolds number models. +Group + grpCmpWallFunctions - Sets mut to zero, and provides an access to calculate y+. +Description + This boundary condition provides a turbulent viscosity condition for use + with low Reynolds number models. It sets \c nut to zero, and provides an + access function to calculate y+. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutLowReWallFunction; + } + \endverbatim + +SeeAlso + Foam::mutWallFunctionFvPatchScalarField SourceFiles mutLowReWallFunctionFvPatchScalarField.C 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 05f82c57f6..8174270466 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -24,11 +24,38 @@ License Class Foam::compressible::RASModels::mutURoughWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Wall function boundary condition for rough walls, based on velocity. + This boundary condition provides a turbulent viscosity condition when + using wall functions for rough walls, based on velocity. + + /heading Patch usage + + /table + Property | Description | Required | Default value + roughnessHeight | roughness height | yes | + roughnessConstant | roughness constanr | yes | + roughnessFactor | scaling factor | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutURoughWallFunction; + roughnessHeight 1e-5; + roughnessConstant 0.5; + roughnessFactor 1; + } + \endverbatim + +SeeAlso + Foam::mutWallFunctionFvPatchScalarField SourceFiles - mutSpalartAllamarasStandardWallFunctionFvPatchScalarField.C + mutURoughWallFunctionFvPatchScalarField.C \*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H index 4157f384a1..0060806b6b 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H @@ -24,8 +24,26 @@ License Class Foam::compressible::RASModels::mutUSpaldingWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Wall function boundary condition for walls + This boundary condition provides a turbulent viscosity condition when + using wall functions for rough walls, based on velocity, using Spaldings + law to give a continuous nut profile to the wall (y+ = 0) + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutUSpaldingWallFunction; + } + \endverbatim + +SeeAlso + Foam::mutWallFunctionFvPatchScalarField SourceFiles mutUSpaldingWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H index 6071a32128..8f9d1becf4 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H @@ -24,8 +24,25 @@ License Class Foam::compressible::RASModels::mutUWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Wall function boundary condition for walls, based on velocity. + This boundary condition provides a turbulent viscosity condition when + using wall functions, based on velocity. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutUWallFunction; + } + \endverbatim + +SeeAlso + Foam::mutWallFunctionFvPatchScalarField SourceFiles mutUWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H index ab0478508f..a3f1f6db2f 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H @@ -24,11 +24,27 @@ License Class Foam::compressible::RASModels::mutWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions, based on turbulence kinetic energy. + This boundary condition provides a turbulent viscosity condition when + using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutWallFunction; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles mutWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H index da413fed1c..13dbc72121 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H @@ -24,15 +24,39 @@ License Class Foam::compressible::RASModels::mutkRoughWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions for rough walls, based on turbulence kinetic energy. - - Manipulates the E parameter to account for roughness effects, based on - KsPlus. + This boundary condition provides a turbulent viscosity condition when + using wall functions for rough walls, based on turbulence kinetic energy. + The condition manipulates the E parameter to account for roughness + effects. + Parameter ranges - roughness height = sand-grain roughness (0 for smooth walls) - - roughness constant = 0.5-1.0 (0.5 default) + - roughness constant = 0.5-1.0 + + /heading Patch usage + + /table + Property | Description | Required | Default value + Ks | sand-grain roughness height | yes | + Cs | roughness constant | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type nutkAtmRoughWallFunction; + Ks uniform 0; + Cs uniform 0.5; + } + \endverbatim + +SeeAlso + Foam::mutkRoughWallFunctionFvPatchScalarField SourceFiles mutkRoughWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H index 0aa935d59b..400a300a55 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H @@ -24,11 +24,27 @@ License Class Foam::compressible::RASModels::mutkWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions, based on turbulence kinetic energy. + This boundary condition provides a turbulent viscosity condition when + using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutkWallFunction; + } + \endverbatim + +SeeAlso + Foam::mutWallFunctionFvPatchScalarField + SourceFiles mutkWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index db1b91b688..63fd4823e8 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -24,16 +24,23 @@ License Class Foam::compressible::RASModels::omegaWallFunctionFvPatchScalarField +Group + grpCmpWallFunctions + Description - Provides a wall function boundary condition/constraint on omega + This boundary condition provides a wall function constraint on turbulnce + specific dissipation, omega. The values are computed using: - Computed value is: - - omega = sqrt(omega_vis^2 + omega_log^2) + \f[ + \omega = sqrt(\omega_{vis}^2 + \omega_{log}^2) + \f] where - omega_vis = omega in viscous region - omega_log = omega in logarithmic region + + /vartable + \omega_{vis} | omega in viscous region + \omega_{log} | omega in logarithmic region + /endvartable Model described by Eq.(15) of: \verbatim @@ -43,6 +50,25 @@ Description Nov. 2001 \endverbatim + /heading Patch usage + + /table + Property | Description | Required | Default value + G | turbulence generation field name | no | G + Cmu | model coefficient | no | 0.09 + kappa | Von Karman constant | no | 0.41 + E | model coefficient | no | 9.8 + beta1 | model coefficient | no | 0.075 + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type compressible::omegaWallFunction; + } + \endverbatim + SourceFiles omegaWallFunctionFvPatchScalarField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 2dcd5c9214..2dc42c3f02 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -24,16 +24,17 @@ License Class Foam::incompressible::atmBoundaryLayerInletEpsilonFvPatchScalarField -\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions +Group + grpIcoRASBoundaryConditions grpInletBoundaryConditions Description This boundary condition specifies an inlet value for the turbulence - dissipation \c epsilon, appropriate for atmospheric boundary layers (ABL), - and designed to be used in conjunction with the \c ABLInletVelocity inlet - velocity boundary condition. + dissipation, \f$\epsilon\f$ (\c epsilon), appropriate for atmospheric + boundary layers (ABL), and designed to be used in conjunction with the + \c ABLInletVelocity inlet velocity boundary condition. \f[ - epsilon = (U^*)^3 / (K(z - z_g + z_0)) + \epsilon = \frac{(U^*)^3}{(K(z - z_g + z_0))} \f] where @@ -48,7 +49,7 @@ Description and: \f[ - U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0}} + U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} \f] where: diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index d0fa2992bd..327e68d3bd 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -24,7 +24,8 @@ License Class Foam::incompressible::atmBoundaryLayerInletVelocityFvPatchVectorField -\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions +Group + grpIcoRASBoundaryConditions grpInletBoundaryConditions Description This boundary condition specifies a velocity inlet profile appropriate diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index cb3a0c9d17..cde69f91f0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,25 +22,41 @@ License along with OpenFOAM. If not, see . Class - Foam::turbulentHeatFluxTemperatureFvPatchScalarField + Foam::incompressible::turbulentHeatFluxTemperatureFvPatchScalarField + +Group + grpIcoRASBoundaryConditions grpWallBoundaryConditions Description Fixed heat boundary condition to specify temperature gradient. Input heat source either specified in terms of an absolute power [W], or as a flux [W/m2]. - Example usage: + /heading Patch usage - hotWall - { - type turbulentHeatFluxTemperature; - heatSource flux; // power [W]; flux [W/m2] - q uniform 10; // heat power or flux - alphaEff alphaEff; // alphaEff field name; - // alphaEff in [kg/m/s] - Cp Cp; // Cp field name; Cp in [J/kg/K] - value uniform 300; // initial temperature value - } + /table + Property | Description | Required | Default value + heatSource | heat source type: \c flux [W/m2] or \c power [W]| yes | + q | heat source value | yea | + alphaEff | turbulent thermal diffusivity field name | yes | + /endtable + + \note + - it is assumed that the units of \c alphaEff are [kg/m/s] + - the specific heat capcaity is read from the transport dictionary entry + \c Cp0 + + Example of the boundary condition specification: + \verbatim + myPatch + { + type turbulentHeatFluxTemperature; + heatSource flux; + q uniform 10; + alphaEff alphaEff; + value uniform 300; // place holder + } + \endverbatim SourceFiles turbulentHeatFluxTemperatureFvPatchScalarField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C index a0fee136ca..f0e9d5bdfe 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,14 +48,15 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField : inletOutletFvPatchScalarField(p, iF), mixingLength_(0.0), - phiName_("undefined-phi"), - kName_("undefined-k") + phiName_("phi"), + kName_("k") { this->refValue() = 0.0; this->refGrad() = 0.0; this->valueFraction() = 0.0; } + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -71,6 +72,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -91,6 +93,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField this->valueFraction() = 0.0; } + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( @@ -103,6 +106,7 @@ turbulentMixingLengthDissipationRateInletFvPatchScalarField kName_(ptf.kName_) {} + turbulentMixingLengthDissipationRateInletFvPatchScalarField:: turbulentMixingLengthDissipationRateInletFvPatchScalarField ( diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 1cfb9013b3..a9cce6cbd8 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,19 +25,52 @@ Class Foam::incompressible:: turbulentMixingLengthDissipationRateInletFvPatchScalarField +Group + grpIcoRASBoundaryConditions grpInletBoundaryConditions + Description - Calculate epsilon via the mixing length [m] + This boundary condition provides a turbulence dissipation, \f$\epsilon\f$ + (epsilon) inlet condition based on a specified mixing length. The patch + values are calculated using: + + \f[ + \epsilon_p = \frac{C_{\mu}^{0.75} k^{1.5}}{L} + \f] + + where + + /vartable + \epsilon_p | patch epsilon values + C_{\mu} | Model coefficient, set to 0.09 + k | turbulence kinetic energy + L | length scale + /endvartable + + \note + In the event of reverse flow, a zero-gradient condition is applied + + /heading Patch usage + + /table + Property | Description | Required | Default value + mixingLength | Length scale [m] | yes | + phi | flux field name | no | phi + k | turbulence kinetic energy field name | no | k + /endtable Example of the boundary condition specification: \verbatim - inlet - { - type turbulentMixingLengthDissipationRateInlet; - mixingLength 0.005; // 5 mm - value uniform 200; // placeholder - } + myPatch + { + type turbulentMixingLengthDissipationRateInlet; + mixingLength 0.005; + value uniform 200; // placeholder + } \endverbatim +SeeAlso + Foam::inletOutletFvPatchField + SourceFiles turbulentMixingLengthDissipationRateInletFvPatchScalarField.C @@ -56,7 +89,7 @@ namespace incompressible { /*---------------------------------------------------------------------------*\ - Class turbulentMixingLengthDissipationRateInletFvPatch Declaration + Class turbulentMixingLengthDissipationRateInletFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class turbulentMixingLengthDissipationRateInletFvPatchScalarField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 41a871b8df..59b56dbd36 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,20 +24,53 @@ License Class Foam::incompressible::turbulentMixingLengthFrequencyInletFvPatchScalarField +Group + grpIcoRASBoundaryConditions grpInletBoundaryConditions + Description - Calculate omega via the mixing length + This boundary condition provides a turbulence specific dissipation, + \f$\omega\f$ (omega) inlet condition based on a specified mixing length. + The patch values are calculated using: + + \f[ + \omega_p = \frac{k^{0.5}}{C_{\mu}^{0.25} L} + \f] + + where + + /vartable + \omega_p | patch omega values + C_{\mu} | Model coefficient, set to 0.09 + k | turbulence kinetic energy + L | length scale + /endvartable + + \note + In the event of reverse flow, a zero-gradient condition is applied + + /heading Patch usage + + /table + Property | Description | Required | Default value + mixingLength | Length scale [m] | yes | + phi | flux field name | no | phi + k | turbulence kinetic energy field name | no | k + /endtable Example of the boundary condition specification: \verbatim - inlet - { - type turbulentMixingLengthFrequencyInlet; - mixingLength 0.005; // 5 mm - k k; // turbulent k field - value uniform 5; // initial value - } + myPatch + { + type turbulentMixingLengthFrequencyInlet; + mixingLength 0.005; + value uniform 200; // placeholder + } \endverbatim +SeeAlso + Foam::inletOutletFvPatchField + + SourceFiles turbulentMixingLengthFrequencyInletFvPatchScalarField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index 807813d1e3..a8979e059d 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::epsilonWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulence dissipation wall function condition for high Reynolds number, turbulent flow cases. @@ -67,8 +67,6 @@ SeeAlso SourceFiles epsilonWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef epsilonWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index 97a01567ea..601fbda71c 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -8,26 +8,26 @@ 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 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. + 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 . - -\addtogroup grpIcoWallFunctions -@{ + You should have received a copy of the GNU General Public License along with + OpenFOAM. If not, see . Class Foam::incompressible::RASModels:: kappatJayatillekeWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a kinematic turbulent thermal conductivity for using wall functions, using the Jayatilleke 'P' function. @@ -59,8 +59,6 @@ SeeAlso SourceFiles kappatJayatillekeWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef kappatJayatillekeWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 007401a499..6ec6b7270b 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -21,15 +21,15 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::kqRWallFunctionFvPatchField +Group + grpIcoWallFunctions + Description - This boundary condition is applied to turbulence \c k, \c Q, and \c R - when using wall functions, and simply enforces a zer-gradient condition. + This boundary condition is applied to turbulence \c k, \c q, and \c R + when using wall functions, and simply enforces a zero-gradient condition. /heading Patch usage @@ -47,8 +47,6 @@ SeeAlso SourceFiles kqRWallFunctionFvPatchField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef kqRWallFunctionFvPatchField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 28861bbc65..3f14f07338 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutLowReWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition for use with low Reynolds number models. It sets \c nut to zero, and @@ -48,8 +48,6 @@ SeeAlso SourceFiles nutLowReWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutLowReWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 89113aa58a..97d70cf3bc 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutURoughWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. @@ -55,9 +55,7 @@ SeeAlso Foam::nutWallFunctionFvPatchScalarField SourceFiles - nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C - -@} + nutURoughWallFunctionFvPatchScalarField.C \*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index abb1f0c683..5ae948a614 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutUSpaldingWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity, using @@ -48,8 +48,6 @@ SeeAlso SourceFiles nutUSpaldingWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutUSpaldingWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index efabcfb58f..7c43c75319 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutUTabulatedWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions. As input, the user specifies a look-up table @@ -59,8 +59,6 @@ SeeAlso SourceFiles nutUTabulatedWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutUTabulatedWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index 3fd38c9e37..d39142bc26 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutUWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on velocity. @@ -47,8 +47,6 @@ SeeAlso SourceFiles nutUWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutUWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index dfdebdc2ee..ecd2959720 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy. @@ -48,8 +48,6 @@ SeeAlso SourceFiles nutWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index bef03208d0..3ba2b450a8 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -21,13 +21,13 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels:: nutkAtmRoughWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity for atmospheric velocity profiles. It is desinged to be used in conjunction @@ -35,7 +35,7 @@ Description are calculated using: \f[ - U = (U_f/K) ln((z + z_0)/z_0) + U = frac{U_f}{K} ln(\frac{z + z_0}{z_0}) \f] where @@ -69,8 +69,6 @@ SeeAlso SourceFiles nutkAtmRoughWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutkAtmRoughWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 57cb2c27cb..0682defc2d 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutkRoughWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on turbulence kinetic @@ -60,8 +60,6 @@ SeeAlso SourceFiles nutkRoughWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutkRoughWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 61363a9c46..91156935d0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::nutkWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy. @@ -48,8 +48,6 @@ SeeAlso SourceFiles nutkWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef nutkWallFunctionFvPatchScalarField_H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index e7c41731aa..ece53d3b1d 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.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 grpIcoWallFunctions -@{ - Class Foam::incompressible::RASModels::omegaWallFunctionFvPatchScalarField +Group + grpIcoWallFunctions + Description This boundary condition provides a wall function constraint on turbulnce specific dissipation, omega. The values are computed using: @@ -72,8 +72,6 @@ Description SourceFiles omegaWallFunctionFvPatchScalarField.C -@} - \*---------------------------------------------------------------------------*/ #ifndef omegaWallFunctionFvPatchScalarField_H From e2ed99034744e4b0dcae5c3ed3f9ae2c37190dde Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 13 Jul 2012 16:15:14 +0100 Subject: [PATCH 039/109] ENH: relocated functionObject doc file to doc sub-folder --- src/postProcessing/functionObjects/{ => doc}/functionObjects.dox | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/postProcessing/functionObjects/{ => doc}/functionObjects.dox (100%) diff --git a/src/postProcessing/functionObjects/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox similarity index 100% rename from src/postProcessing/functionObjects/functionObjects.dox rename to src/postProcessing/functionObjects/doc/functionObjects.dox From 5e86700b8571f7ecc5939d5be0f4bdda783f7ffa Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 13 Jul 2012 16:16:50 +0100 Subject: [PATCH 040/109] ENH: Added doxygen documentation for thermo BCs --- .../fvPatchFields/doc/boundaryConditions.dox | 31 ++++++++++++++---- .../doc/thermophysicalBoundaryConditionsDoc.H | 31 ++++++++++++++++++ .../energyJump/energyJumpFvPatchScalarField.H | 27 ++++++++++++++-- .../fixedEnergyFvPatchScalarField.H | 21 ++++++++++-- .../gradientEnergyFvPatchScalarField.H | 22 +++++++++++-- .../mixedEnergyFvPatchScalarField.H | 10 ++++-- .../wallHeatTransferFvPatchScalarField.H | 32 ++++++++++++++++--- .../MarshakRadiationFvPatchScalarField.C | 6 ++-- .../MarshakRadiationFvPatchScalarField.H | 26 +++++++++++---- ...iationFixedTemperatureFvPatchScalarField.H | 26 +++++++++++---- ...iffusiveRadiationMixedFvPatchScalarField.C | 8 ++--- ...iffusiveRadiationMixedFvPatchScalarField.H | 27 +++++++++++----- ...veViewFactorFixedValueFvPatchScalarField.H | 29 +++++++++++------ ...iffusiveRadiationMixedFvPatchScalarField.C | 7 ++-- ...iffusiveRadiationMixedFvPatchScalarField.H | 25 +++++++++++++-- 15 files changed, 265 insertions(+), 63 deletions(-) create mode 100644 src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index 89aef25aa3..b8787fe010 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -27,13 +27,32 @@ License \ref grpBoundaryConditions + \section secBoundaryConditionsOverview Overview -- \ref grpConstraintBoundaryConditions -- \ref grpInletBoundaryConditions -- \ref grpOutletBoundaryConditions -- \ref grpGenericBoundaryConditions -- \ref grpCoupledBoundaryConditions -- \ref grpWallBoundaryConditions +\subsection secBC1 Basic boundary conditions + - \ref grpConstraintBoundaryConditions + - \ref grpInletBoundaryConditions + - \ref grpOutletBoundaryConditions + - \ref grpGenericBoundaryConditions + - \ref grpCoupledBoundaryConditions + - \ref grpWallBoundaryConditions + +\subsection secBC2 Turbulent flow boundary conditions + - \ref grpIcoRASBoundaryConditions + - \ref grpCmpRASBoundaryConditions + +\subsection secBC3 Thermophysical boundary conditions + - \ref grpThermoBoundaryConditions + + +\section secWallFunctions Wall functions + +Wall functions for incompressible flow + - \ref grpIcoWallFunctions + +Wall functions for compressible flow + - \ref grpCmpWallFunctions + \*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H new file mode 100644 index 0000000000..610d554454 --- /dev/null +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpThermoBoundaryConditions Thermophysical boundary conditions +@{ + This group contains thermophysical model boundary conditions +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H index 6fb7820ee3..806c33e6c3 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H @@ -24,7 +24,31 @@ License Class Foam::energyJumpFvPatchScalarField +Group + grpThermoBoundaryConditions grpCoupledBoundaryConditions + Description + This boundary condition provides an energy jump condition across a pair + of coupled patches. + + /heading Patch usage + + /table + Property | Description | Required | Default value + jump | energy jump values | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type energyJump; + jump uniform 100; + } + \endverbatim + +SeeAlso + Foam::fixedJumpFvPatchField SourceFiles energyJumpFvPatchScalarField.C @@ -43,7 +67,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class energyJumpFvPatchScalarField Declaration + Class energyJumpFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class energyJumpFvPatchScalarField @@ -120,7 +144,6 @@ public: // Member functions - // Evaluation functions //- Update the coefficients diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index 2c3b83ed60..a86577d02a 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -24,8 +24,25 @@ License Class Foam::fixedEnergyFvPatchScalarField +Group + grpThermoBoundaryConditions + Description - A fixed boundary condition for internal energy + This boundary condition provides a fixed condition for internal energy + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type fixedEnergy; + value uniform 100; + } + \endverbatim + +SeeAlso + Foam::fixedValueFvPatchField SourceFiles fixedEnergyFvPatchScalarField.C @@ -43,7 +60,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class fixedEnergyFvPatchScalarField Declaration + Class fixedEnergyFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class fixedEnergyFvPatchScalarField diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index 6a5bc19f9e..074a8b2f80 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -22,10 +22,26 @@ License along with OpenFOAM. If not, see . Class - Foam::gradientInternalEnergyFvPatchScalarField + Foam::gradientEnergyFvPatchScalarField + +Group + grpThermoBoundaryConditions Description - Gradient boundary condition for internal energy + This boundary condition provides a gradient condition for internal energy + + /heading Patch usage + Example of the boundary condition specification: + \verbatim + myPatch + { + type gradientEnergy; + gradient uniform 10; + } + \endverbatim + +SeeAlso + Foam::fixedGradientFvPatchField SourceFiles gradientEnergyFvPatchScalarField.C @@ -43,7 +59,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class gradientEnergyFvPatchScalarField Declaration + Class gradientEnergyFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class gradientEnergyFvPatchScalarField diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H index 204e7c2938..97c55cbd1e 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H @@ -24,8 +24,14 @@ License Class Foam::mixedEnergyFvPatchScalarField +Group + grpThermoBoundaryConditions + Description - Mixed boundary conditions for internal energy + This boundary condition provides a mixed condition for internal energy + +SeeAlso + Foam::mixedFvPatchField SourceFiles mixedEnergyFvPatchScalarField.C @@ -43,7 +49,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mixedEnergyFvPatchScalarField Declaration + Class mixedEnergyFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class mixedEnergyFvPatchScalarField diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H index 3a30ea1660..8661df5c61 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,8 +24,30 @@ License Class Foam::wallHeatTransferFvPatchScalarField +Group + grpThermoBoundaryConditions grpWallBoundaryConditions + Description - Enthalpy boundary conditions for wall heat transfer + This boundary condition provides an enthalpy condition for wall heat + transfer + + /heading Patch usage + + /table + Property | Description | Required | Default value + Tinf | wall temperature | yes | + alphaWall | thermal diffusivity | yes | + /endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type wallHeatTransfer; + Tif uniform 500; + alphaWall uniform 1; + } + \endverbatim SourceFiles wallHeatTransferFvPatchScalarField.C @@ -43,7 +65,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class wallHeatTransferFvPatch Declaration + Class wallHeatTransferFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class wallHeatTransferFvPatchScalarField @@ -52,10 +74,10 @@ class wallHeatTransferFvPatchScalarField { // Private data - //- Tinf + //- Temperature at the wall scalarField Tinf_; - //- alphaWall + //- Thermal diffusivity at the wall scalarField alphaWall_; diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C index 9bd7d0f827..2bd7a38f3d 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.C @@ -40,7 +40,7 @@ Foam::MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, "undefined", scalarField::null()), - TName_("undefined") + TName_("T") { refValue() = 0.0; refGrad() = 0.0; @@ -76,7 +76,7 @@ Foam::MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, dict), - TName_(dict.lookup("T")) + TName_(dict.lookupOrDefault("T", "T")) { if (dict.found("value")) { @@ -191,7 +191,7 @@ void Foam::MarshakRadiationFvPatchScalarField::write(Ostream& os) const { mixedFvPatchScalarField::write(os); radiationCoupledBase::write(os); - os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl; + writeEntryIfDifferent(os, "T", "T", TName_); } diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index bb159c3b8b..5d9de5c213 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -24,6 +24,9 @@ License Class Foam::MarshakRadiationFvPatchScalarField +Group + grpThermoBoundaryConditions + Description A 'mixed' boundary condition that implements a Marshak condition for the incident radiation field (usually written as G) @@ -31,16 +34,27 @@ Description The radiation temperature is retrieved from the mesh database, using a user specified temperature field name. + /heading Patch usage + + /table + Property | Description | Required | Default value + T | temperature field name | no | T + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type MarshakRadiation; - T T; // name of temperature field - value uniform 0; // optional value entry - } + myPatch + { + type MarshakRadiation; + T T; + value uniform 0; + } \endverbatim +SeeAlso + Foam::radiationCoupledBase + Foam::mixedFvPatchField + SourceFiles MarshakRadiationFvPatchScalarField.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index 32b003ccd0..b2b913c763 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -24,6 +24,9 @@ License Class Foam::MarshakRadiationFixedTemperatureFvPatchScalarField +Group + grpThermoBoundaryConditions + Description A 'mixed' boundary condition that implements a Marshak condition for the incident radiation field (usually written as G) @@ -31,16 +34,27 @@ Description The radiation temperature field across the patch is supplied by the user using the \c Trad entry. + /heading Patch usage + + /table + Property | Description | Required | Default value + T | temperature field name | no | T + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type MarshakRadiationFixedT; - Trad uniform 1000; // radiation temperature field - value uniform 0; // place holder - } + myPatch + { + type MarshakRadiationFixedTemperature; + Trad uniform 1000; // radiation temperature field + value uniform 0; // place holder + } \endverbatim +SeeAlso + Foam::radiationCoupledBase + Foam::mixedFvPatchField + SourceFiles MarshakRadiationFixedTemperatureFvPatchScalarField.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C index 02637c203a..5817279076 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -45,7 +45,7 @@ greyDiffusiveRadiationMixedFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, "undefined", scalarField::null()), - TName_("undefinedT") + TName_("T") { refValue() = 0.0; refGrad() = 0.0; @@ -83,7 +83,7 @@ greyDiffusiveRadiationMixedFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, dict), - TName_(dict.lookup("T")) + TName_(dict.lookupOrDefault("T", "T")) { if (dict.found("refValue")) { @@ -262,7 +262,7 @@ void Foam::radiation::greyDiffusiveRadiationMixedFvPatchScalarField::write { mixedFvPatchScalarField::write(os); radiationCoupledBase::write(os); - os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl; + writeEntryIfDifferent(os, "T", "T", TName_); } diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index 51dd2d4ad3..cdd4b09a05 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -22,7 +22,10 @@ License along with OpenFOAM. If not, see . Class - Foam::greyDiffusiveRadiationMixedFvPatchScalarField + Foam::radiation::greyDiffusiveRadiationMixedFvPatchScalarField + +Group + grpThermoBoundaryConditions Description This boundary condition provides a grey-diffuse condition for radiation @@ -30,15 +33,23 @@ Description (fvDOM), in which the radiation temperature is retrieved from the temperature field boundary condition. + /heading Patch usage + + /table + Property | Description | Required | Default value + T | temperature field name | no | T + emissivityMode | emissivity mode: solidThermo or lookup | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type greyDiffusiveRadiation; - T T; // name of temperature field - emissivityMode solidThermo; // solidThermo | lookup - value uniform 0; // initial value - } + myPatch + { + type greyDiffusiveRadiation; + T T; + emissivityMode solidThermo; + value uniform 0; + } \endverbatim SeeAlso diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index e2ada393e9..3197e50c2e 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,21 +22,32 @@ License along with OpenFOAM. If not, see . Class - Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField + Foam::radiation::greyDiffusiveViewFactorFixedValueFvPatchScalarField + +Group + grpThermoBoundaryConditions Description This boundary condition provides a grey-diffuse condition for radiative heat flux, \c Qr, for use with the view factor model + /heading Patch usage + + /table + Property | Description | Required | Default value + Qro | external radiative heat flux | yes | + emissivityMode | emissivity mode: solidThermo or lookup | yes | + /endtable + Example of the boundary condition specification: \verbatim - myPatch - { - type greyDiffusiveRadiationViewFactor; - Qro uniform 0; // external radiative heat flux - emissivityMode solidThermo; // solidThermo | lookup - value uniform 0; // initial value - } + myPatch + { + type greyDiffusiveRadiationViewFactor; + Qro uniform 0; + emissivityMode solidThermo; + value uniform 0; + } \endverbatim SeeAlso diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C index ff0bb83b46..e6e7b4b225 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C @@ -46,7 +46,7 @@ wideBandDiffusiveRadiationMixedFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, "undefined", scalarField::null()), - TName_("undefinedT") + TName_("T") { refValue() = 0.0; refGrad() = 0.0; @@ -84,7 +84,7 @@ wideBandDiffusiveRadiationMixedFvPatchScalarField : mixedFvPatchScalarField(p, iF), radiationCoupledBase(p, dict), - TName_(dict.lookup("T")) + TName_(dict.lookupOrDefault("T", "T")) { if (dict.found("value")) { @@ -249,8 +249,7 @@ void Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::write { mixedFvPatchScalarField::write(os); radiationCoupledBase::write(os); - os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl; - + writeEntryIfDifferent(os, "T", "T", TName_); } diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index cd9fb9aece..f23cd3e6e2 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,10 +22,29 @@ License along with OpenFOAM. If not, see . Class - Foam::wideBandDiffusiveRadiationMixedFvPatchScalarField + Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField + +Group + grpThermoBoundaryConditions Description - Radiation temperature specified + This boundary condition provides a wide-band, diffusive radiation + condition, where the patch temperature is specified. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type wideBandDiffusiveRadiation; + value uniform 0; + } + \endverbatim + +SeeAlso + Foam::mixedFvPatchScalarField + Foam::radiationCoupledBase SourceFiles wideBandDiffusiveRadiationMixedFvPatchScalarField.C From b44f84ad39b20c89520e78927c37a6d83dde43d2 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 13 Jul 2012 16:17:48 +0100 Subject: [PATCH 041/109] ENH: Further updates to doxygen docs --- src/OpenFOAM/global/foamDoc.H | 3 +- .../SRFFreestreamVelocityFvPatchVectorField.H | 29 +++++++----- .../SRFVelocityFvPatchVectorField.H | 26 ++++++---- .../inletOutlet/inletOutletFvPatchField.H | 8 ++-- .../oscillatingFixedValueFvPatchField.H | 4 +- .../fvPatchFields/doc/boundaryConditions.dox | 30 ++++++++++++ .../fvPatchFields/doc/fvPatchFieldDoc.H | 15 +++++- .../functionObjects/doc/functionObjects.dox | 1 + .../mappedVariableThicknessWallFvPatch.H | 3 ++ .../doc/surfaceFilmBoundaryConditionsDoc.H | 32 +++++++++++++ ...ilmHeightInletVelocityFvPatchVectorField.H | 47 +++++++++++++------ ...alphatFilmWallFunctionFvPatchScalarField.H | 44 ++++++++++++----- .../mutkFilmWallFunctionFvPatchScalarField.H | 26 ++++++++-- .../doc/thermoBaffleBoundaryConditionsDoc.H | 32 +++++++++++++ ...emperatureThermoBaffleFvPatchScalarField.H | 9 +++- .../compressibleRASBoundaryConditionsDoc.H | 0 .../incompressibleRASBoundaryConditionsDoc.H | 0 17 files changed, 245 insertions(+), 64 deletions(-) create mode 100644 src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H create mode 100644 src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H rename src/turbulenceModels/compressible/RAS/derivedFvPatchFields/{ => doc}/compressibleRASBoundaryConditionsDoc.H (100%) rename src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/{ => doc}/incompressibleRASBoundaryConditionsDoc.H (100%) diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H index 27389e27a0..cd3f1998a5 100644 --- a/src/OpenFOAM/global/foamDoc.H +++ b/src/OpenFOAM/global/foamDoc.H @@ -36,6 +36,7 @@ License turbulence and heat transfer, to solid dynamics and electromagnetics. More ... + \section layout Code Layout The OpenFOAM source code comprises of four main components: @@ -53,11 +54,11 @@ License - doc: supporting documentation + \section usingTheCode Using the code - \subpage pagePostProcessing - \subpage pageBoundaryConditions - - \subpage grpIcoRASBoundaryConditions \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index e29d0a0864..b51f472c71 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -33,24 +33,29 @@ Description determine the local velocity using: \f[ - Up = cos(theta)*UInf + sin(theta)*(n^UInf) - Up_srf + U_p = cos(\theta)*U_{Inf} + sin(theta) (n^UInf) - U_{p,srf} \f] where - \var Up = patch velocity [m/s] - \var UInf = free stream velocity in the absolute frame [m/s] - \var theta = swept angle [rad] - \var n = axis direction of the SRF - \var Up_srf = SRF velocity of the patch + /vartable + U_p = patch velocity [m/s] + U_{Inf} = free stream velocity in the absolute frame [m/s] + theta = swept angle [rad] + n = axis direction of the SRF + U_{p,srf} = SRF velocity of the patch + /endvartable + + + /heading Patch usage Example of the boundary condition specification: \verbatim - myPatch - { - type SRFFreestreamVelocity; - UInf (0 0 0); // free stream velocity - value uniform (0 0 0); // optional value entry - } + myPatch + { + type SRFFreestreamVelocity; + UInf (0 0 0); // free stream velocity + value uniform (0 0 0); // optional value entry + } \endverbatim SourceFiles diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 376f8ae27e..890744bc41 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -24,6 +24,9 @@ License Class Foam::SRFVelocityFvPatchVectorField +Group + grpInletBoundaryConditions grpWallBoundaryConditions + Description Velocity condition to be used in conjunction with the single rotating frame (SRF) model (see: SRFModel class) @@ -35,29 +38,34 @@ Description The optional \c relative flag switches the behaviour of the patch such that: - \li relative = yes: inlet velocity applied 'as is': + - relative = yes: inlet velocity applied 'as is': \f[ Up = U_in \f] - \li relative = no : SRF velocity is subtracted from the inlet velocity: + - relative = no : SRF velocity is subtracted from the inlet velocity: \f[ Up = U_in - U_srf \f] + /heading Patch usage + Example of the boundary condition specification: \verbatim - myPatch - { - type SRFVelocity; - relative yes; // relative motion to the SRF? - inletValue uniform (0 0 0); // inlet velocity - value uniform (0 0 0); // initial value - } + myPatch + { + type SRFVelocity; + relative yes; // relative motion to the SRF? + inletValue uniform (0 0 0); // inlet velocity + value uniform (0 0 0); // initial value + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles SRFVelocityFvPatchVectorField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index b5b7fcf492..449f4e8631 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -36,7 +36,7 @@ Description /table Property | Description | Required | Default value phi | flux field name | no | phi - inletValue | inlet value | yes | + inletValue | inlet value for reverse flow | yes | /endtable Example of the boundary condition specification: @@ -44,9 +44,9 @@ Description myPatch { type inletOutlet; - phi phi; // name of flux field (default = phi) - inletValue uniform 0; // reverse flow (inlet) value - value uniform 0; // initial value + phi phi; + inletValue uniform 0; + value uniform 0; } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index d42c23f5dd..e134124954 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -32,7 +32,7 @@ Description amplitude and frequency. /f[ - x_p = (1 + a.sin(\pi f t))x_{ref} + x_o + x_p = (1 + a sin(\pi f t))x_{ref} + x_o /f] where @@ -58,7 +58,7 @@ Description Example of the boundary condition specification: \verbatim - inlet + myPatch { type oscillatingFixedValue; refValue uniform 5.0; diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index b8787fe010..d89698dc9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -55,4 +55,34 @@ Wall functions for compressible flow - \ref grpCmpWallFunctions +\section secBoundaryConditions Typical usage for pressure-velocity systems + +subsonic inlet (flow specified): +/table + Variable | Symbol | Type + pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink + velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink + transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink + derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink +/endtable + +subsonic outlet: +/table + Variable | Symbol | Type + pressure | p | \link Foam::fixedValueFvPatchField fixedValue\endlink + velocity | U | \link Foam::inletOutletFvPatchField inletOutlet\endlink or \link Foam::pressureInletOutletVelocityFvPatchVectorField pressureInletOutletVelocity\endlink + transported property | - | \link Foam::inletOutletFvPatchField inletOutlet\endlink + derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink +/endtable + +wall: +/table + Variable | Symbol | Type + pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink + velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink + transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink + derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink +/endtable + + \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H index e4461605f6..4cd593a213 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H +++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H @@ -25,13 +25,24 @@ License \defgroup grpBoundaryConditions Boundary Conditions @{ - This group contains OpenFOAM boundary condition types + This group contains OpenFOAM boundary condition types. All conditions + are derived from the base Foam::fvPatchField class. Patch values are + typically updated using the virtual functions + - Foam::fvPatchField::updateCoeffs() + - Foam::fvPatchField::evaluate() + + The difference between the methods is based on when the patch values are + updated. When the condition is applied to a solution variable, the + call to updateCoeffs() occurs as a preliminary step of the + \.solve(). The evaluate() method is invoked after, or idependent + of the matrix solve, via a call to \.correctBoundaryConditions(). @} \defgroup grpConstraintBoundaryConditions Constraint boundary Conditions @{ \ingroup grpBoundaryConditions - This group contains constraint boundary condition types + This group contains constraint boundary condition types. These conditions + are mainly employed to reduced dimensioned cases. @} \defgroup grpInletBoundaryConditions Inlet boundary Conditions diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox index ee4355a656..d6ae894685 100644 --- a/src/postProcessing/functionObjects/doc/functionObjects.dox +++ b/src/postProcessing/functionObjects/doc/functionObjects.dox @@ -51,6 +51,7 @@ functions { type functionObjectType; libs ("libMyFunctionObjectlib.so"); + active yes; // active by default outputControl outputTime; // output or timeStep outputInterval 1; // only necessary for outputControl=timeStep ... diff --git a/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H b/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H index a203fc0169..f4709bb62e 100644 --- a/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H +++ b/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H @@ -24,6 +24,9 @@ License Class Foam::mappedVariableThicknessWallFvPatch +Group + grpRegionBoundaryConditions + Description Take thickness field and number of layers and returns deltaCoeffs as 2.0/thickness/nLayers. diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H new file mode 100644 index 0000000000..600a85bf2d --- /dev/null +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpSurfaceFilmBoundaryConditions Surface film boundary conditions +@{ + \ingroup grpRegionBoundaryConditions + This group contains surface film model boundary conditions +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 571b597204..16e7e0db1f 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -24,6 +24,9 @@ License Class Foam::filmHeightInletVelocityFvPatchVectorField +Group + grpSurfaceFilmBoundaryConditions + Description This boundary condition is designed to be used in conjunction with surface film modelling. It provides a velocity inlet boundary condition @@ -31,29 +34,43 @@ Description obtained from the flux with a direction normal to the patch faces using: \f[ - Up = \frac{n*phi}{rho*mag(Sf)*delta} + U_p = \frac{n \phi}{\rho |Sf| \delta} \f] where - \var Up = patch velocity [m/s] - \var n = patch normal vector - \var phi = mass flux [kg/s] - \var rho = density [kg/m3] - \var Sf = patch face area vectors [m2] - \var delta = film height [m] + /vartable + U_p | patch velocity [m/s] + n | patch normal vector + \phi | mass flux [kg/s] + \rho | density [kg/m3] + Sf | patch face area vectors [m2] + \delta | film height [m] + /endvartable + + /heading Patch usage + + /table + Property | Description | Required | Default value + phi | Flux field name | no | phi + rho | density field name | no | rho + deltaf | height field name | no | deltaf + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type filmHeightInletVelocity; - phi phi; // name of flux field (default = phi) - rho rho; // name of density field (default = rho) - deltaf deltaf; // name of height field (default = deltaf) - value uniform (0 0 0); // initial velocity / [m/s] - } + myPatch + { + type filmHeightInletVelocity; + phi phi; + rho rho; + deltaf deltaf; + value uniform (0 0 0); // initial velocity / [m/s] + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles filmHeightInletVelocityFvPatchVectorField.C diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index e01028532a..fd8ef90041 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -24,25 +24,43 @@ License Class Foam::compressible::RASModels::alphatFilmWallFunctionFvPatchScalarField +Group + grpSurfaceFilmBoundaryConditions grpCmpWallFunctions + Description - Turbulent thermal diffusivity boundary condition for use with surface - film models. This condition varies from the standard wall function by - taking into account any mass released from the film model. + This boundary condition provides a turbulent thermal diffusivity condition + when using wall functions, for use with surface film models. This + condition varies from the standard wall function by taking into account any + mass released from the film model. + + /heading Patch usage + + /table + Property | Description | Required | Default value + B | model coefficient | no | 5.5 + yPlusCrit | critical y+ for transition to turbulent flow | no|11.05 + Cmu | model coefficient | no | 0.09 + kappa | Von-Karman constant | no | 0.41 + Prt | turbulent Prandtl number | no | 0.85 + /endtable Example of the boundary condition specification: \verbatim - myPatch - { - type alphatFilmWallFunction; - B 5.5; // B coefficient (default = 5.5) - yPlusCrit 11.05; // critical y+ (default = 11.05) - Cmu 0.09; // Cmu coefficient (default = 0.09) - kappa 0.41; // kappa coefficient (default = 0.41) - Prt 0.85; // turbulent Prandtl number (default = 0.85) - value uniform 0; // optional value entry - } + myPatch + { + type alphatFilmWallFunction; + B 5.5; + yPlusCrit 11.05; + Cmu 0.09; + kappa 0.41; + Prt 0.85; + value uniform 0; + } \endverbatim +SeeAlso + Foam::fixedValueFvPatchField + SourceFiles alphatFilmWallFunctionFvPatchScalarField.C diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H index aab054effb..1370214146 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -22,11 +22,29 @@ License along with OpenFOAM. If not, see . Class - Foam::compressible::RASModels:: - mutkFilmWallFunctionFvPatchScalarField + Foam::compressible::RASModels::mutkFilmWallFunctionFvPatchScalarField + +Group + grpSurfaceFilmBoundaryConditions grpCmpWallFunctions Description - Wall function boundary condition for use with surface film models. + This boundary condition provides a turbulent viscosity condition when + using wall functions, based on turbulence kinetic energy, for use with + surface film models. + + /heading Patch usage + + Example of the boundary condition specification: + \verbatim + myPatch + { + type mutkFilmWallFunction; + value uniform 0; + } + \endverbatim + +SeeAlso + Foam::mutkWallFunctionFvPatchScalarField SourceFiles mutkFilmWallFunctionFvPatchScalarField.C diff --git a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H new file mode 100644 index 0000000000..ac1553d104 --- /dev/null +++ b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpThermoBoundaryConditions Thermo baffle boundary conditions +@{ + \ingroup grpRegionBoundaryConditions + This group contains thermo baffle model boundary conditions +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H index 82392d123e..cc1ee4bd9e 100644 --- a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H +++ b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H @@ -24,9 +24,12 @@ License Class Foam::temperatureThermoBaffleFvPatchScalarField +Group + grpThermoBoundaryConditions + Description - Thermal boundary applied to both sides:the baffle region and - in the primary region. + This boundary condition provides a coupled condition between the primary + baffle mesh regions. The primary region creates it and evolves the thermal baffle heat transfer equation. @@ -95,6 +98,8 @@ Description value uniform 300; +SeeAlso + Foam::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField SourceFiles temperatureThermoBaffleFvPatchScalarField.C diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H similarity index 100% rename from src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H rename to src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H similarity index 100% rename from src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H rename to src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H From f1f261afa101a762d1a002eb029920d6158676a8 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 15:11:27 +0100 Subject: [PATCH 042/109] ENH: Added 'Group' option to doxygen sed filter --- bin/tools/doxyFilter.sed | 11 +++++++ .../doc/regionBoundaryConditionsDoc.H | 31 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 src/regionModels/doc/regionBoundaryConditionsDoc.H diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index b1bbfc20de..67ba9d7eba 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -64,6 +64,17 @@ s/^ /\\class / } +# Group +# groupName +# => +# \ingroup namespaceName +# +/^Group *$/,/^[^ ]/{ +s/^Group// +s/^ /\\ingroup / +} + + # Namespace # namespaceName # => diff --git a/src/regionModels/doc/regionBoundaryConditionsDoc.H b/src/regionModels/doc/regionBoundaryConditionsDoc.H new file mode 100644 index 0000000000..7f4981d4ad --- /dev/null +++ b/src/regionModels/doc/regionBoundaryConditionsDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpRegionBoundaryConditions Region boundary conditions +@{ + This group contains region model boundary conditions +@} + +\*---------------------------------------------------------------------------*/ From 7aa29c9f8713873df3ab3297fb03c5b92091718b Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 16:06:31 +0100 Subject: [PATCH 043/109] ENH: Converted doxygen tags to \ from / --- bin/tools/doxyFilter-table.awk | 10 +++++----- bin/tools/doxyFilter.sed | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/bin/tools/doxyFilter-table.awk b/bin/tools/doxyFilter-table.awk index a8bc23bd90..df08cab6e1 100644 --- a/bin/tools/doxyFilter-table.awk +++ b/bin/tools/doxyFilter-table.awk @@ -6,14 +6,14 @@ BEGIN { } -/\/table/ { +/\\table/ { flag = 1; firstRow = 1; next; } -/\/endtable/ { +/\\endtable/ { if (data != "") { printf "\n"; @@ -27,14 +27,14 @@ BEGIN { } -/\/vartable/ { +/\\vartable/ { flag = 2; firstRow = 1; next; } -/\/endvartable/ { +/\\endvartable/ { if (data != "") { printf "
    \n"; @@ -51,7 +51,7 @@ BEGIN { { if (flag > 0) { - data = (data ""); + data = (data "\n"); if (flag == 1) { for (i = 0; i <= NF; i++) diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 67ba9d7eba..9fd65302d1 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -163,7 +163,7 @@ s/.*\*\//\*\// # convert /heading in source files to bold font and add some space -s#/heading \(.*\)#
    \1#g +s#\\heading \(.*\)#
    \1#g } From 78c03fb65ba17f704f8cbb851c2f7b240d941680 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 16:07:50 +0100 Subject: [PATCH 044/109] ENH: Added .dox extension to doxygen file patterns --- doc/Doxygen/Doxyfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index 7c72c4595e..4e3829d65a 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -608,7 +608,8 @@ INPUT_ENCODING = UTF-8 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.H \ - *.C + *.C \ + *.dox # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. From 30619cbf58e28566f677fade26128f09aa135419 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 16:09:31 +0100 Subject: [PATCH 045/109] STYLE: Refactored doxygen tags --- .../SRFFreestreamVelocityFvPatchVectorField.H | 6 ++--- .../SRFVelocityFvPatchVectorField.H | 2 +- .../basic/calculated/calculatedFvPatchField.H | 2 +- .../fixedGradient/fixedGradientFvPatchField.H | 10 +++---- .../basic/fixedValue/fixedValueFvPatchField.H | 6 ++--- .../basic/mixed/mixedFvPatchField.H | 4 +-- .../zeroGradient/zeroGradientFvPatchField.H | 2 +- .../constraint/cyclic/cyclicFvPatchField.H | 2 +- .../cyclicAMI/cyclicAMIFvPatchField.H | 2 +- .../cyclicSlip/cyclicSlipFvPatchField.H | 2 +- .../constraint/empty/emptyFvPatchField.H | 2 +- .../processor/processorFvPatchField.H | 2 +- .../processorCyclicFvPatchField.H | 2 +- .../symmetry/symmetryFvPatchField.H | 2 +- .../constraint/wedge/wedgeFvPatchField.H | 2 +- .../activeBaffleVelocityFvPatchVectorField.H | 10 +++---- ...ureForceBaffleVelocityFvPatchVectorField.H | 10 +++---- .../derived/advective/advectiveFvPatchField.H | 6 ++--- .../buoyantPressureFvPatchScalarField.H | 14 +++++----- .../codedFixedValueFvPatchField.H | 2 +- .../codedMixed/codedMixedFvPatchField.H | 2 +- ...lindricalInletVelocityFvPatchVectorField.H | 6 ++--- .../derived/fan/fanFvPatchField.H | 6 ++--- .../fixedFluxPressureFvPatchScalarField.H | 10 +++---- .../fixedInternalValueFvPatchField.H | 2 +- .../derived/fixedMean/fixedMeanFvPatchField.H | 6 ++--- .../fixedNormalSlipFvPatchField.H | 6 ++--- ...ureCompressibleDensityFvPatchScalarField.H | 10 +++---- .../flowRateInletVelocityFvPatchVectorField.H | 6 ++--- .../fluxCorrectedVelocityFvPatchVectorField.H | 8 +++--- .../freestream/freestreamFvPatchField.H | 6 ++--- .../freestreamPressureFvPatchScalarField.H | 2 +- .../inletOutlet/inletOutletFvPatchField.H | 6 ++--- ...OutletTotalTemperatureFvPatchScalarField.H | 6 ++--- .../mappedField/mappedFieldFvPatchField.H | 6 ++--- .../mappedFixedInternalValueFvPatchField.H | 6 ++--- ...ppedFixedPushedInternalValueFvPatchField.H | 6 ++--- .../mappedFixedValueFvPatchField.H | 6 ++--- .../mappedFlowRateFvPatchVectorField.H | 6 ++--- ...mappedVelocityFluxFixedValueFvPatchField.H | 6 ++--- .../movingWallVelocityFvPatchVectorField.H | 6 ++--- ...phaseFixedFluxPressureFvPatchScalarField.H | 10 +++---- .../oscillatingFixedValueFvPatchField.H | 10 +++---- .../outletInlet/outletInletFvPatchField.H | 6 ++--- .../outletMappedUniformInletFvPatchField.H | 6 ++--- .../partialSlip/partialSlipFvPatchField.H | 6 ++--- ...aseHydrostaticPressureFvPatchScalarField.H | 10 +++---- ...tedInletOutletVelocityFvPatchVectorField.H | 6 ++--- ...eDirectedInletVelocityFvPatchVectorField.H | 6 ++--- ...tOutletParSlipVelocityFvPatchVectorField.H | 6 ++--- ...ureInletOutletVelocityFvPatchVectorField.H | 6 ++--- ...reInletUniformVelocityFvPatchVectorField.H | 2 +- .../pressureInletVelocityFvPatchVectorField.H | 2 +- ...malInletOutletVelocityFvPatchVectorField.H | 6 ++--- ...ureInletOutletVelocityFvPatchVectorField.H | 6 ++--- .../rotatingTotalPressureFvPatchScalarField.H | 6 ++--- .../rotatingWallVelocityFvPatchVectorField.H | 6 ++--- .../derived/slip/slipFvPatchField.H | 2 +- .../supersonicFreestreamFvPatchVectorField.H | 6 ++--- ...urfaceNormalFixedValueFvPatchVectorField.H | 6 ++--- ...lFlowRateInletVelocityFvPatchVectorField.H | 6 ++--- .../syringePressureFvPatchScalarField.H | 6 ++--- .../temperatureJumpFvPatchScalarField.H | 6 ++--- .../timeVaryingMappedFixedValueFvPatchField.H | 6 ++--- .../totalPressureFvPatchScalarField.H | 26 +++++++++---------- .../totalTemperatureFvPatchScalarField.H | 6 ++--- ...ranslatingWallVelocityFvPatchVectorField.H | 6 ++--- .../turbulentInletFvPatchField.H | 10 +++---- ...sityKineticEnergyInletFvPatchScalarField.H | 10 +++---- ...ityHydrostaticPressureFvPatchScalarField.H | 10 +++---- .../uniformFixedValueFvPatchField.H | 6 ++--- .../uniformTotalPressureFvPatchScalarField.H | 6 ++--- .../variableHeightFlowRateFvPatchField.H | 6 ++--- ...tFlowRateInletVelocityFvPatchVectorField.H | 6 ++--- .../waveSurfacePressureFvPatchScalarField.H | 10 +++---- .../waveTransmissiveFvPatchField.H | 10 +++---- .../fvPatchFields/doc/boundaryConditions.dox | 12 ++++----- ...ilmHeightInletVelocityFvPatchVectorField.H | 10 +++---- ...alphatFilmWallFunctionFvPatchScalarField.H | 6 ++--- .../mutkFilmWallFunctionFvPatchScalarField.H | 2 +- .../energyJump/energyJumpFvPatchScalarField.H | 6 ++--- .../fixedEnergyFvPatchScalarField.H | 2 +- .../gradientEnergyFvPatchScalarField.H | 2 +- .../wallHeatTransferFvPatchScalarField.H | 6 ++--- .../MarshakRadiationFvPatchScalarField.H | 6 ++--- ...iationFixedTemperatureFvPatchScalarField.H | 6 ++--- ...iffusiveRadiationMixedFvPatchScalarField.H | 6 ++--- ...veViewFactorFixedValueFvPatchScalarField.H | 6 ++--- ...iffusiveRadiationMixedFvPatchScalarField.H | 2 +- ...convectiveHeatTransferFvPatchScalarField.H | 10 +++---- ...thDissipationRateInletFvPatchScalarField.H | 10 +++---- ...ngLengthFrequencyInletFvPatchScalarField.H | 10 +++---- ...ayatillekeWallFunctionFvPatchScalarField.H | 6 ++--- .../alphatWallFunctionFvPatchScalarField.H | 10 +++---- .../epsilonWallFunctionFvPatchScalarField.H | 10 +++---- .../kqRWallFunctionFvPatchField.H | 2 +- .../mutLowReWallFunctionFvPatchScalarField.H | 2 +- .../mutURoughWallFunctionFvPatchScalarField.H | 6 ++--- ...tUSpaldingWallFunctionFvPatchScalarField.H | 2 +- .../mutUWallFunctionFvPatchScalarField.H | 2 +- .../mutWallFunctionFvPatchScalarField.H | 2 +- .../mutkRoughWallFunctionFvPatchScalarField.H | 6 ++--- .../mutkWallFunctionFvPatchScalarField.H | 2 +- .../omegaWallFunctionFvPatchScalarField.H | 10 +++---- .../fixedShearStressFvPatchVectorField.H | 2 ++ ...ndaryLayerInletEpsilonFvPatchScalarField.H | 14 +++++----- ...daryLayerInletVelocityFvPatchVectorField.H | 14 +++++----- ...entHeatFluxTemperatureFvPatchScalarField.H | 6 ++--- ...thDissipationRateInletFvPatchScalarField.H | 10 +++---- ...ngLengthFrequencyInletFvPatchScalarField.H | 10 +++---- .../epsilonWallFunctionFvPatchScalarField.H | 10 +++---- ...ayatillekeWallFunctionFvPatchScalarField.H | 6 ++--- .../kqRWallFunctionFvPatchField.H | 2 +- .../nutLowReWallFunctionFvPatchScalarField.H | 2 +- .../nutURoughWallFunctionFvPatchScalarField.H | 6 ++--- ...tUSpaldingWallFunctionFvPatchScalarField.H | 2 +- ...UTabulatedWallFunctionFvPatchScalarField.H | 6 ++--- .../nutUWallFunctionFvPatchScalarField.H | 2 +- .../nutWallFunctionFvPatchScalarField.H | 2 +- ...tkAtmRoughWallFunctionFvPatchScalarField.H | 10 +++---- .../nutkRoughWallFunctionFvPatchScalarField.H | 6 ++--- .../nutkWallFunctionFvPatchScalarField.H | 2 +- .../omegaWallFunctionFvPatchScalarField.H | 10 +++---- 123 files changed, 375 insertions(+), 373 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index b51f472c71..fe50e35cac 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -37,16 +37,16 @@ Description \f] where - /vartable + \vartable U_p = patch velocity [m/s] U_{Inf} = free stream velocity in the absolute frame [m/s] theta = swept angle [rad] n = axis direction of the SRF U_{p,srf} = SRF velocity of the patch - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 890744bc41..71bb989bcd 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -50,7 +50,7 @@ Description Up = U_in - U_srf \f] - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index b7163e5bc0..7caa505a8d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -32,7 +32,7 @@ Description that the value is assigned via field assignment, and not via a call to e.g. \c updateCoeffs or \c evaluate. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index 6290d8f5a5..3d00735453 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -36,19 +36,19 @@ Description \f] where - /vartable + \vartable x_p | patch values x_c | internal field values \nabla(x)| gradient (user-specified) \Delta | inverse distance from patch face centre to cell centre - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value gradient | gradient | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index 50b986a760..3540c9254c 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value value | values | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 193dd6cb4d..3b1bc57c27 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -39,14 +39,14 @@ Description \f] where - /vartable + \vartable x_p | patch values x_c | patch internal cell values w | weight field, \c valueFraction_ A | fixed value, \c refValue_ B | patch normal gradient, \c refGrad_ \Delta| inverse distance from face centre to internal cell centre - /endvartable + \endvartable \note This condition is not usually applied directly; instead, use a derived diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 90f1dc25c6..99038a1240 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition appies a zero-gradient condition from the patch internal field onto the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 073f5015a4..85a03380f0 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -36,7 +36,7 @@ Description transformed to the neighbour patch, the patches should be identical (or very similar). - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index ac2e442921..cef14ae106 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -37,7 +37,7 @@ Description patch is transformed to the neighbour patch, the outer perimiter of each patch should be identical (or very similar). - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 3f77c1f8fc..3c68fe2b36 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index 9f1e8caf01..7b88714619 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -33,7 +33,7 @@ Description patches whose normal is aligned to geometric directions that do not constitue solution directions. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 6278a3567f..a913aaf606 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enables processor communication across patches. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 12ad60fcbc..c03236b0da 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition enables processor communication across cyclic patches. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index 26fa081eb7..a5812c09b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enforces a symmetry constraint - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index de4072625b..6ab1a7f081 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 08423e848f..1c3dfa4dd4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -44,19 +44,19 @@ Description where - /vartable + \vartable x | baffle open fraction [0-1] x_{old} | baffle open fraction on previous evaluation dt | simulation time step DT | time taken to open the baffle F_{net} | net force across the baffle - /endvartable + \endvartable The open fraction is then applied to scale the patch areas. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p cyclicPatch | cylclic patch name | yes | @@ -64,7 +64,7 @@ Description openFraction | current opatch open fraction [0-1]| yes | openingTime | time taken to open the baffle | yes | maxOpenFractionDelta | max open fraction change per timestep | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 0957852428..c313f296fe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -44,18 +44,18 @@ Description where - /vartable + \vartable x | baffle open fraction [0-1] x_{old} | baffle open fraction on previous evaluation dt | simulation time step DT | time taken to open the baffle - /endvartable + \endvartable The open fraction is then applied to scale the patch areas. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p cyclicPatch | cylclic patch name | yes | @@ -65,7 +65,7 @@ Description maxOpenFractionDelta | max open fraction change per timestep | yes | minThresholdValue | minimum open fraction for activation | yes | forceBased | force (true) or pressure-based (false) activation | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index b5f143acac..305beeaced 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -48,15 +48,15 @@ Description the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho fieldInf | value of field beyond patch | no | lInf | distance beyond patch for \c fieldInf | no | - /endtable + \endtable \note If \c lInf is specified, \c fieldInf will be required; \c rho is only diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 39e59bfcc6..19b7930b86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -43,11 +43,11 @@ Description where - /vartable + \vartable \rho | density [kg/m3] g | acceleration due to gravity [m/s2] h | patch face centres [m] - /endvartable + \endvartable Otherwise we assume that it is the static pressure, and the gradient calculated using: @@ -56,16 +56,16 @@ Description \f] where - /vartable + \vartable n | patch face normal vectors - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 04c2562f49..ba32afbd63 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField) which is then used to evaluate. - /heading Patch usage + \heading Patch usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index e35c4af2c3..c631b20b86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField) which is then used to evaluate. - /heading Patch usage + \heading Patch usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 6ffa995cde..482b365f2a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -32,16 +32,16 @@ Description cylindrical co-ordinates given a central axis, central point, rpm, axial and radial velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value axis | axis of rotation | yes | centre | centre of rotation | yes | axialVelocity | axial velocity profile [m/s] | yes | radialVelocity | radial velocity profile [m/s] | yes | rpm | rotational speed (revolutions per minute) | yes| - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index bb0f3574c7..be28d24448 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -34,14 +34,14 @@ Description The jump is specified as a \c DataEntry type, to enable the use of, e.g. contant, polynomial, table values. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | jump | current jump value | yes | jumpTable | jump data, e.g. \c csvFile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index 5bc8a2281c..de9f6fb701 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -41,21 +41,21 @@ Description where - /vartable + \vartable phi | flux D_p | pressure diffusivity Sf | patch face areas [m2] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phiHbyA | name of predicted flux field | no | phiHbyA phi | name of flux field | no | phi rho | name of density field | no | rho Dp | name of pressure diffusivity field | no | Dp - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 868a333565..2fdd5f71b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -32,7 +32,7 @@ Description directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index bce30465cd..ed31cfb998 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified mean value. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value meanValue | mean value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 21e4ae88ea..bbaf0a257b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -30,12 +30,12 @@ Group Description This boundary condition sets the patch-normal component to a fixed value. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fixedValue | fixed value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 5f0cf8c403..47aab74d5c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -37,23 +37,23 @@ Description where - /vartable + \vartable \rho | density [kg/m3] \rho_{l,sat} | saturation liquid density [kg/m3] \psi_l | liquid compressibility p | pressure [Pa] p_{sat} | saturation pressure [Pa] - /endvartable + \endvartable The variables \c rholSat, \c pSat and \c psil are retrieved from the \c thermodynamicProperties dictionary. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index dac06b8ba8..f15d4e666a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -43,12 +43,12 @@ Description For a volumetric-based flux: - the flow rate is in m3/s - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value flowRate | volumetric [m3/s] OR mass flow rate [kg/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 9e9e6b638e..059c3addfd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -38,21 +38,21 @@ Description where - /vartable + \vartable U_p | velocity at the patch [m/s] U_c | velocity in cells adjacent to the patch [m/s] n | patch normal vectors \phi_p | flux at the patch [m3/s or kg/s] Sf | patch face area vectors [m2] - /endvartable + \endvartable where - /table + \table Property | Description | Required | Default value phi | name of flux field | no | phi rho | name of density field | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 57373b69cb..adcb570f93 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -33,12 +33,12 @@ Description operation switches between fixed (free stream) value and zero gradient based on the sign of the flux. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 28eedd1752..ae082c5da3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -32,7 +32,7 @@ Description It is a zero-gradient condition that constrains the flux across the patch based on the free-stream velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 449f4e8631..d97e6eb817 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi inletValue | inlet value for reverse flow | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index d6487efc93..430ee1e51f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -32,9 +32,9 @@ Description temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | heat capacity ration (Cp/Cv) | yes | inletValue | reverse flow (inlet) value | yes | T0 | static temperature [K] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 554f4ef868..bb413a141c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -32,14 +32,14 @@ Description condition. It does not use information on the patch; instead it holds thr data locally. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 30dd2f27b9..dbf6595879 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -31,14 +31,14 @@ Description This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable \verbatim myPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 45ee30032d..18884da980 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -31,14 +31,14 @@ Description This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 4fc5f332dd..672889d325 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -34,15 +34,15 @@ Description The sample mode is set by the underlying mapping engine, provided by the mappedPatchBase class. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | interpolationScheme | type of interpolation scheme | no | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 76b5726e6e..cb06375c10 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -37,14 +37,14 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho neigPhi | name of flux field on neighbour mesh | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 175d2cd386..a160e2c292 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition maps the velocity and flux from a neighbour patch to this patch - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index e4706c3d37..be5b50e6f8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -33,12 +33,12 @@ Description for moving reference frame (MRF) calculations. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velociy field name | no | U - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index cf2b0c95b4..f71feaa1e3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -41,21 +41,21 @@ Description where - /vartable + \vartable \phi | flux Dp | pressure diffusivity Sf | patch face areas [m2] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phiHbyA | name of predicted flux field | no | phiHbyA phi | name of flux field | no | phi rho | name of density field | no | rho Dp | name of pressure diffusivity field | no | Dp - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index e134124954..af8ac75a74 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -37,24 +37,24 @@ Description where - /vartable + \vartable x_p | patch values x_{ref} | patch reference values x_o | patch offset values a | amplitude f | frequency [1/s] t | time [s] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value refValue | reference value | yes | offset | offset value | no | 0.0; // optional amplitude | oscillation amplitude | yes | frequency | oscillation frequency | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index a26db47e41..53d47a3592 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a generic inflow condition, with specified outflow for the case of return flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi inletValue | inlet value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 8098a68b7e..059faeab09 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -32,13 +32,13 @@ Description by name "outletPatchName" and applies this as the uniform value of the field over this patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value outletPatchName | name of outlet patch | yes | phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 8d081efa06..b4fd5e7ce7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a partial slip condition. The amount of slip is controlled by a user-supplied field. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value valueFraction | fraction od value used for boundary [0-1] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 0cdc4650f5..cb0c472da4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -36,27 +36,27 @@ Description \f] where - /vartable + \vartable p_{hyd} | hyrostatic pressure [Pa] p_{ref} | reference pressure [Pa] x_{ref} | reference point in Cartesian co-ordinates \rho | density (assumed uniform) g | acceleration due to gravity [m/s2] - /endtable + \endtable The values are assigned according to the phase-fraction field: - 1: apply \$fp_{hyd}\$f - 0: apply a zero-gradient condition - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phaseName | phase field name | no | alpha rho | density field name | no | rho pRefValue | reference pressure [Pa] | yes | pRefPoint | reference pressure location | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index c6e2a8c0c5..d12d390ea1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -33,14 +33,14 @@ Description applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho inletDirection | inlet direction per patch face | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 47cfd0e22a..a7ea670a9b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -32,14 +32,14 @@ Description pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" direction. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho inletDirection | inlet direction per patch face | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 128dc1ec26..7fbb307d04 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -35,13 +35,13 @@ Description A slip condition is applied tangential to the patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index a162c6d254..36680dd7d8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -35,13 +35,13 @@ Description The tangential patch velocity can be optionally specified. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi tangentialVelocity | tangential velocity field | no | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 56750ed091..d22757c672 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description averaging the flux over the patch, and then applying it in the direction normal to the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 13bc501b21..2ea77ceeff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description pressure is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 86ef8bc4e4..3df7b5ed9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -33,13 +33,13 @@ Description outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index a48f2c3782..5a95fa75bf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -33,14 +33,14 @@ Description for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi tangentialVelocity | tangential velocity field | no | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index c3000b4f15..22d806c377 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -31,9 +31,9 @@ Description This boundary condition provides a total pressure condition for patches in a rotating frame. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 5d7ae1dd7d..a3d5d5686e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -30,14 +30,14 @@ Group Description This boundary condition provides a rotational velocity condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value origin | origin of rotation in Cartesian co-ordinates | yes| axis | axis of rotation | yes | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 1d936aa811..ee50d19881 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a slip constraint. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index e614212296..ca013bb04c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -36,15 +36,15 @@ Description - subsonic outflow is applied via a zero-gradient condition from inside the domain. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value UInf | free-stream velocity | yes | pInf | free-stream pressure | yes | TInf | free-stream temperature | yes | gamma | heat capacity ratio (cp/Cv) | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 71200d9512..5906f790a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a surface-normal vector boundary condition by its magnitude. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value refValue | reference value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index d827e8cd46..307d9486a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -37,15 +37,15 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho flowRate | flow rate profile | yes | rpm | rotational speed profile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 8fe219d412..c4dc0a1e4f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -37,9 +37,9 @@ Description pressure and compressibility which is assumed constant, i.e. isothermal expansion/compression. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ap | syringe piston area [m2] | yes | Sp | syringe piston speed [m/s] | yes | @@ -51,7 +51,7 @@ Description psI | initial syringe pressure [Pa] | yes | psi | gas compressibility [m2/s2] | yes | ams | added (or removed) gas mass [kg] | yes | - /endtable + \endtable Example of the BC specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index 28719fd964..d788f543be 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -34,14 +34,14 @@ Description The jump is specified as a \c DataEntry type, to enable the use of, e.g. contant, polynomial, table values. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | jump | current jump value | yes | jumpTable | jump data, e.g. \c csvFile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index e6dc3fdc2b..86a8029cdf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -42,14 +42,14 @@ Description Values are interpolated linearly between times. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value setAverage | flag to activate setting of average value | yes | perturb | perturb points for regular geometries | no | 1e-5 fieldTableName | alternative field name to sample | no| this field name - /endtable + \endtable /verbatim myPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index a98adc9910..dd49014a32 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -36,62 +36,62 @@ Description p_T = p_0 + 0.5 |U|^2 \f] where - /vartable + \vartable p_T | incompressible total pressure [m2/s2] p_0 | incompressible reference pressure [m2/s2] U | velocity - /endvartable + \endvartable 2. compressible subsonic: \f[ p_T = p_0 + 0.5 \rho |U|^2 \f] where - /vartable + \vartable p_T | total pressure [Pa] p_0 | reference pressure [Pa] \rho | density [kg/m3] U | velocity - /endvartable + \endvartable 3. compressible transonic (\gamma <= 1): \f[ p_T = \frac{p_0}{1 + 0.5 \psi |U|^2} \f] where - /vartable + \vartable p_T | total pressure [Pa] p_0 | reference pressure [Pa] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ - /endvartable + \endvartable 4. compressible supersonic (\gamma > 1): \f[ p_T = \frac{p_0}{(1 + 0.5 \psi G)^{\frac{1}{G}}} \f] where - /vartable + \vartable \gamma | ratio of specific heats (Cp/Cv) p_T | total pressure [Pa] p_0 | reference pressure [Pa] \psi | compressibility [m2/s2] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ - /endvartable + \endvartable The modes of operation are set via the combination of \c phi, \c rho, and \c psi entries: - /table + \table Mode | phi | rho | psi incompressible subsonic | phi | none | none compressible subsonic | phi | rho | none compressible transonic | phi | none | psi compressible supersonic | phi | none | psi - /endtable + \endtable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -99,7 +99,7 @@ Description psi | compressibility field name | no | none gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | - /endtable + \endtable \note The default boundary behaviour is for subsonic, incompressible flow. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index 465b02d370..d793696ade 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -30,16 +30,16 @@ Group Description This boundary condition provides a total temperature condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | Velocity field name | no | U phi | Flux field name | no | phi psi | Compressibility field name | no | psi gamma | ratio of specific heats (Cp/Cv) | yes | T0 | reference temperature | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index 821a6e36b5..d32a1ba460 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a velocity condition for translational motion on walls. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | translational velocity | yes| - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 8f30d3a6cc..3917d167bd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -37,23 +37,23 @@ Description where - /vartable + \vartable x_p | patch values x_{ref} | refernce patch values n | time level \alpha | fraction of new random component added to previous time value C_{RMS} | RMS coefficient s | fluctuation scale - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fluctuationScale | RMS fluctuation scale (fraction of mean) | yes | referenceField | reference (mean) field | yes | alpha | fraction of new random component added to previous| no| 0.1 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index b7acbae470..b2d1f2123e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -38,22 +38,22 @@ Description where - /vartable + \vartable k_p | kinetic energy at the patch I | turbulence intensity U | velocity field - /endvartable + \endvartable In the event of reverse flow, a zero-gradient condition is applied. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value intensity | fraction of mean field [0-1] | yes | U | velocity field name | no | U phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index 4c162ec16a..ff3c925863 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -36,22 +36,22 @@ Description \f] where - /vartable + \vartable p_{hyd} | hyrostatic pressure [Pa] p_{ref} | reference pressure [Pa] x_{ref} | reference point in Cartesian co-ordinates \rho | density (assumed uniform) g | acceleration due to gravity [m/s2] - /endtable + \endtable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value rho | uniform density [kg/m3] | yes | pRefValue | reference pressure [Pa] | yes | pRefPoint | reference pressure location | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 38a13d398d..3b09b75a4c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -30,12 +30,12 @@ Group Description This boundary condition provides a uniform fixed value condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value uniformValue | uniform value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index a23db5daa2..46f81be514 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -31,9 +31,9 @@ Description This boundary condition provides a time-varying form of the uniform total pressure boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | pressure | total pressure as a function of time | yes | - /endtable + \endtable \note The default boundary behaviour is for subsonic, incompressible flow. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index 67faf746de..858dd6c1ce 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -41,14 +41,14 @@ Description if alpha < lowerBound: - apply a fixed value condition, with a uniform level of the lower bound - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi lowerBound | lower bound for clipping | yes | upperBound | upper bound for clipping | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index f14dc5c1b5..c4322d6a57 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -34,12 +34,12 @@ Description The flow rate is made proportional to the phase fraction alpha at each face of the patch and alpha is ensured to be bound between 0 and 1. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value flowRate | volumetric flow rate [m3/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 1687542e49..3babe28eff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -35,23 +35,23 @@ Description p = -\rho*g*\zeta \f] - /vartable + \vartable \rho | density [kg/m3] g | acceleration due to gravity [m/s2] \zeta | wave amplitude [m] - /endvartable + \endvartable The wave amplitude is updated as part of the calculation, derived from the local volumetric flux. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho zeta | wave amplitude field name | no | zeta - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 9940415bce..9ff79884d6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -39,23 +39,23 @@ Description where - /vartable + \vartable x_p | patch values \phi_p | patch face flux \psi_p | patch compressibility Sf | patch face area vector \gamma | ratio of specific heats - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho psi | compressibility field name | no | psi gamma | ratio of specific heats (Cp/Cv) | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index d89698dc9a..72a3078da4 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -58,31 +58,31 @@ Wall functions for compressible flow \section secBoundaryConditions Typical usage for pressure-velocity systems subsonic inlet (flow specified): -/table +\table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable subsonic outlet: -/table +\table Variable | Symbol | Type pressure | p | \link Foam::fixedValueFvPatchField fixedValue\endlink velocity | U | \link Foam::inletOutletFvPatchField inletOutlet\endlink or \link Foam::pressureInletOutletVelocityFvPatchVectorField pressureInletOutletVelocity\endlink transported property | - | \link Foam::inletOutletFvPatchField inletOutlet\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable wall: -/table +\table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable \*---------------------------------------------------------------------------*/ diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 16e7e0db1f..98b8f49808 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -38,23 +38,23 @@ Description \f] where - /vartable + \vartable U_p | patch velocity [m/s] n | patch normal vector \phi | mass flux [kg/s] \rho | density [kg/m3] Sf | patch face area vectors [m2] \delta | film height [m] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | Flux field name | no | phi rho | density field name | no | rho deltaf | height field name | no | deltaf - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index fd8ef90041..de61d62b94 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -33,16 +33,16 @@ Description condition varies from the standard wall function by taking into account any mass released from the film model. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value B | model coefficient | no | 5.5 yPlusCrit | critical y+ for transition to turbulent flow | no|11.05 Cmu | model coefficient | no | 0.09 kappa | Von-Karman constant | no | 0.41 Prt | turbulent Prandtl number | no | 0.85 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H index 1370214146..7e7a2a99f8 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy, for use with surface film models. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H index 806c33e6c3..aae2d9597b 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H @@ -31,12 +31,12 @@ Description This boundary condition provides an energy jump condition across a pair of coupled patches. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value jump | energy jump values | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index a86577d02a..b37cb57e49 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a fixed condition for internal energy - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index 074a8b2f80..2ee94c08cc 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a gradient condition for internal energy - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim myPatch diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H index 8661df5c61..da2ab661ef 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H @@ -31,13 +31,13 @@ Description This boundary condition provides an enthalpy condition for wall heat transfer - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Tinf | wall temperature | yes | alphaWall | thermal diffusivity | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index 5d9de5c213..53506a5ed4 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -34,12 +34,12 @@ Description The radiation temperature is retrieved from the mesh database, using a user specified temperature field name. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index b2b913c763..646b0ca267 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -34,12 +34,12 @@ Description The radiation temperature field across the patch is supplied by the user using the \c Trad entry. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index cdd4b09a05..f1a38077e0 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -33,13 +33,13 @@ Description (fvDOM), in which the radiation temperature is retrieved from the temperature field boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T emissivityMode | emissivity mode: solidThermo or lookup | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 3197e50c2e..3dff551ee7 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a grey-diffuse condition for radiative heat flux, \c Qr, for use with the view factor model - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Qro | external radiative heat flux | yes | emissivityMode | emissivity mode: solidThermo or lookup | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index f23cd3e6e2..8019e61017 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a wide-band, diffusive radiation condition, where the patch temperature is specified. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index e2dedbb2f5..aaaee1c650 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -42,20 +42,20 @@ Description where - /vartable + \vartable htc_p | patch convective heat transfer coefficient Re | Reynolds number Pr | Prandtl number \kappa_p | thermal conductivity L | length scale - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value L | Length scale [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 9f827b8745..a55997915c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -39,24 +39,24 @@ Description where - /vartable + \vartable \epsilon_p | patch epsilon values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 539d5f892d..68f2a00884 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -38,24 +38,24 @@ Description where - /vartable + \vartable \omega_p | patch omega values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index b098ffca89..0998193046 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -31,15 +31,15 @@ Description This boundary condition provides a thermal wall function for turbulent thermal diffusivity (usually\c alphat) based on the Jayatilleke model. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 41d9abbfd3..c9031e53ed 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -40,19 +40,19 @@ Description where - /vartable + \vartable \alpha_t| turblence thermal diffusivity \mu_t | turblence viscosity Pr_t | turblent Prandtl number - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mut | turbulence viscosity field name | no | mut Prt | turbulent Prandtl number | no | 0.85 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index 515b605403..24172ea21e 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -38,20 +38,20 @@ Description where - /vartable + \vartable epsilon | turblence dissipation field G | turblence generation field - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 95953977da..3ce69d19c0 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is applied to turbulence \c k, \c q, and \c R when using wall functions, and simply enforces a zero-gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H index 886eb0ef7c..2cbbef359c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description with low Reynolds number models. It sets \c nut to zero, and provides an access function to calculate y+. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim 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 8174270466..ee89a45f6c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -31,14 +31,14 @@ Description This boundary condition provides a turbulent viscosity condition when using wall functions for rough walls, based on velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | roughnessFactor | scaling factor | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H index 0060806b6b..4eeefb74cc 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions for rough walls, based on velocity, using Spaldings law to give a continuous nut profile to the wall (y+ = 0) - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H index 8f9d1becf4..08a938b52c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a turbulent viscosity condition when using wall functions, based on velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H index a3f1f6db2f..9228b60924 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H index 13dbc72121..8daa978a22 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H @@ -37,13 +37,13 @@ Description - roughness height = sand-grain roughness (0 for smooth walls) - roughness constant = 0.5-1.0 - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ks | sand-grain roughness height | yes | Cs | roughness constant | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H index 400a300a55..8d952a6428 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index 63fd4823e8..d6516c5449 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -37,10 +37,10 @@ Description where - /vartable + \vartable \omega_{vis} | omega in viscous region \omega_{log} | omega in logarithmic region - /endvartable + \endvartable Model described by Eq.(15) of: \verbatim @@ -50,16 +50,16 @@ Description Nov. 2001 \endverbatim - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 beta1 | model coefficient | no | 0.075 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H index 13b16e86d2..e8d9cc0376 100644 --- a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H @@ -25,6 +25,8 @@ License Class Foam::fixedShearStressFvPatchVectorField +Group grpWallBoundaryConditions + Description Set a constant shear stress as tau0 = -nuEff dU/dn. diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 2dc42c3f02..10e6691933 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -38,13 +38,13 @@ Description \f] where - /vartable + \vartable U^* | frictional velocity K | Karman's constant z | vertical co-ordinate [m] z_0 | surface roughness length [m] z_g | minimum vlaue in z direction [m] - /endvartable + \endvartable and: @@ -53,14 +53,14 @@ Description \f] where: - /vartable + \vartable U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] Z_{ref} | reference height [m] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value z | vertical co-ordinate [m] | yes | kappa | Karman's constanat | no | 0.41 @@ -68,7 +68,7 @@ Description Href | reference height [m] | yes | z0 | surface roughness length [m] | yes | zGround | minimum z co-ordinate [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 327e68d3bd..79b3dc08b6 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -38,13 +38,13 @@ Description \f] where - /vartable + \vartable U^* | frictional velocity K | Karman's constant z | vertical co-ordinate [m] z_0 | surface roughness length [m] z_g | minimum vlaue in z direction [m] - /endvartable + \endvartable and: @@ -53,10 +53,10 @@ Description \f] where: - /vartable + \vartable U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] Z_{ref} | reference height [m] - /endvartable + \endvartable Reference: D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model @@ -70,9 +70,9 @@ Description The roughness height (Er) is given by Er = 20 z0 following the same reference. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value n | flow direction | yes | z | vertical co-ordinate [m] | yes | @@ -81,7 +81,7 @@ Description Href | reference height [m] | yes | z0 | surface roughness length [m] | yes | zGround | minimum z co-ordinate [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index cde69f91f0..6e686dfbdd 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -32,14 +32,14 @@ Description heat source either specified in terms of an absolute power [W], or as a flux [W/m2]. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value heatSource | heat source type: \c flux [W/m2] or \c power [W]| yes | q | heat source value | yea | alphaEff | turbulent thermal diffusivity field name | yes | - /endtable + \endtable \note - it is assumed that the units of \c alphaEff are [kg/m/s] diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index a9cce6cbd8..6f812db1e6 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -39,24 +39,24 @@ Description where - /vartable + \vartable \epsilon_p | patch epsilon values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 59b56dbd36..602c382b9f 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -38,24 +38,24 @@ Description where - /vartable + \vartable \omega_p | patch omega values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index a8979e059d..abd360cba4 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -38,20 +38,20 @@ Description where - /vartable + \vartable epsilon | turblence dissipation field G | turblence generation field - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index 601fbda71c..aaa71c3f47 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -35,15 +35,15 @@ Description \note The units of kinematic turbulent thermal conductivity are m2/s - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 6ec6b7270b..0626b3c1b9 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is applied to turbulence \c k, \c q, and \c R when using wall functions, and simply enforces a zero-gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 3f14f07338..008fe9c96c 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description for use with low Reynolds number models. It sets \c nut to zero, and provides an access function to calculate y+. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 97d70cf3bc..c0f8066e97 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -31,14 +31,14 @@ Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | roughnessFactor | scaling factor | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index 5ae948a614..ba1dde4514 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions for rough walls, based on velocity, using Spaldings law to give a continuous nut profile to the wall (y+ = 0) - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 7c43c75319..591cf8da77 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -37,12 +37,12 @@ Description the tables are not registered since the same table object may be used for more than one patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value uPlusTable | U+ as a function of Re table name | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index d39142bc26..6f32734149 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index ecd2959720..01355ec454 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index 3ba2b450a8..3e0f67a4fc 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -40,19 +40,19 @@ Description where - /vartable + \vartable U_f | frictional velocity K | Von Karman's constant z_0 | surface roughness length z | vertical co-ordinate - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value z0 | surface roughness length| yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 0682defc2d..8bbe8b16b8 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -36,13 +36,13 @@ Description - roughness height = sand-grain roughness (0 for smooth walls) - roughness constant = 0.5-1.0 - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ks | sand-grain roughness height | yes | Cs | roughness constant | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 91156935d0..49a2257e09 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index ece53d3b1d..9c03a85f25 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -37,10 +37,10 @@ Description where - /vartable + \vartable \omega_{vis} | omega in viscous region \omega_{log} | omega in logarithmic region - /endvartable + \endvartable Model described by Eq.(15) of: \verbatim @@ -50,16 +50,16 @@ Description Nov. 2001 \endverbatim - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 beta1 | model coefficient | no | 0.075 - /endtable + \endtable Example of the boundary condition specification: \verbatim From 15636809ebcce0aa0bb2e9e1b3233b7cc08e0f8c Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 16:18:45 +0100 Subject: [PATCH 046/109] ENH: Updated illegal doxy tags --- .../explicitSetValue/ExplicitSetValue.H | 20 ++++++++------ .../explicitSource/ExplicitSource.H | 26 +++++++++++-------- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/src/fieldSources/basicSource/explicitSetValue/ExplicitSetValue.H b/src/fieldSources/basicSource/explicitSetValue/ExplicitSetValue.H index ec0a9d2ce1..1c3adcb279 100644 --- a/src/fieldSources/basicSource/explicitSetValue/ExplicitSetValue.H +++ b/src/fieldSources/basicSource/explicitSetValue/ExplicitSetValue.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,19 +25,23 @@ Class Foam::explicitSetValue Description - Explicit set values on fields. + Set values field values explicity. Sources described by: - ExplicitSetValueCoeffs + \verbatim + ExplicitSetValueCoeffs + { + injectionRate { - injectionRate - { - k 30.7; - epsilon 1.5; - } + k 30.7; + epsilon 1.5; } + } + \endverbatim +SeeAlso + Foam::basicSource SourceFiles explicitSetValue.C diff --git a/src/fieldSources/basicSource/explicitSource/ExplicitSource.H b/src/fieldSources/basicSource/explicitSource/ExplicitSource.H index 95e752d17b..30a18dd5d3 100644 --- a/src/fieldSources/basicSource/explicitSource/ExplicitSource.H +++ b/src/fieldSources/basicSource/explicitSource/ExplicitSource.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,20 +29,24 @@ Description Sources described by: - ExplicitSourceCoeffs + \verbatim + ExplicitSourceCoeffs + { + volumeMode absolute; // specific + injectionRate { - volumeMode absolute; // specific - injectionRate - { - k 30.7; - epsilon 1.5; - } + k 30.7; + epsilon 1.5; } + } + \verbatim - If volumeMode = - - absolute: values are given as - - specific: values are given as /m3 + Valid options for the \c volumeMode entry include: + - absolute: values are given as \ + - specific: values are given as \/m3 +SeeAlso + Foam::basicSource SourceFiles ExplicitSource.C From e6a41726e2a6b6d498179ceb98fc9c57c2861607 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 17:16:03 +0100 Subject: [PATCH 047/109] ENH: Updates to BC documentation --- .../SRFFreestreamVelocityFvPatchVectorField.H | 7 ++- .../SRFVelocityFvPatchVectorField.H | 22 +++++-- .../basic/mixed/mixedFvPatchField.H | 17 ++++-- .../zeroGradient/zeroGradientFvPatchField.H | 4 +- .../derived/fan/fanFvPatchField.H | 2 +- .../fanPressureFvPatchScalarField.H | 33 ++++++----- ...ppedFixedPushedInternalValueFvPatchField.H | 4 +- ...mappedVelocityFluxFixedValueFvPatchField.H | 2 +- ...phaseFixedFluxPressureFvPatchScalarField.H | 2 +- ...urfaceNormalFixedValueFvPatchVectorField.H | 2 +- ...ranslatingWallVelocityFvPatchVectorField.H | 2 +- .../gradientEnergyFvPatchScalarField.C | 6 +- .../gradientEnergyFvPatchScalarField.H | 18 +++++- .../alphaContactAngleFvPatchScalarField.H | 18 +++--- ...convectiveHeatTransferFvPatchScalarField.H | 2 +- ...ayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../mutURoughWallFunctionFvPatchScalarField.H | 4 +- ...tUSpaldingWallFunctionFvPatchScalarField.H | 15 ++++- .../mutkRoughWallFunctionFvPatchScalarField.H | 4 +- .../fixedShearStressFvPatchVectorField.H | 3 +- .../porousBafflePressureFvPatchField.H | 59 +++++++++++++++---- ...ndaryLayerInletEpsilonFvPatchScalarField.H | 6 +- ...entHeatFluxTemperatureFvPatchScalarField.H | 2 +- .../nutURoughWallFunctionFvPatchScalarField.H | 2 +- ...tUSpaldingWallFunctionFvPatchScalarField.H | 15 ++++- .../nutkRoughWallFunctionFvPatchScalarField.H | 2 +- 26 files changed, 186 insertions(+), 69 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index fe50e35cac..58c7ab9ce0 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -48,12 +48,17 @@ Description \heading Patch usage + \table + Property | Description | Required | Default value + UInf | free stream velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFFreestreamVelocity; - UInf (0 0 0); // free stream velocity + UInf (0 0 0); value uniform (0 0 0); // optional value entry } \endverbatim diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 71bb989bcd..32aaa246a7 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -41,24 +41,38 @@ Description - relative = yes: inlet velocity applied 'as is': \f[ - Up = U_in + U_p = U_{in} \f] - relative = no : SRF velocity is subtracted from the inlet velocity: \f[ - Up = U_in - U_srf + U_p = U_{in} - U_{p,srf} \f] + where + \vartable + U_p = patch velocity [m/s] + U_{in} = user-specified inlet velocity + U_{p,srf} = SRF velocity + \endvartable + + \heading Patch usage + \table + Property | Description | Required | Default value + relative | relative motion to the SRF? | yes | + inletValue | inlet velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFVelocity; - relative yes; // relative motion to the SRF? - inletValue uniform (0 0 0); // inlet velocity + relative yes; + inletValue uniform (0 0 0); value uniform (0 0 0); // initial value } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 3b1bc57c27..7c475c1111 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -35,19 +35,28 @@ Description The respective contributions from each is determined by a weight field: \f[ - x_p = w*A + (1-w)*(x_c + B/\Delta) + x_p = w x_p + (1-w) \left(x_c + \frac{\nabla_\perp x}{\Delta}\right) \f] where \vartable x_p | patch values x_c | patch internal cell values - w | weight field, \c valueFraction_ - A | fixed value, \c refValue_ - B | patch normal gradient, \c refGrad_ + w | weight field \Delta| inverse distance from face centre to internal cell centre + w | weighting (0-1) \endvartable + + \heading Patch usage + + \table + Property | Description | Required | Default value + valueFraction | weight field | yes | + refValue | fixed value | yes | + refGrad | patch normal gradient | yes | + \endtable + \note This condition is not usually applied directly; instead, use a derived mixed condition such as \c inletOutlet diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 99038a1240..cb238253f1 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -28,7 +28,7 @@ Group grpGenericBoundaryConditions Description - This boundary condition appies a zero-gradient condition from the patch + This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces. \heading Patch usage @@ -57,7 +57,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class zeroGradientFvPatch Declaration + Class zeroGradientFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index be28d24448..9306796d79 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -28,7 +28,7 @@ Group grpCoupledBoundaryConditions Description - This boundary condition supplies a jump condition, using the \c cyclic + This boundary condition provides a jump condition, using the \c cyclic condition as a base. The jump is specified as a \c DataEntry type, to enable the use of, e.g. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index a8124bb38b..022fb48ccb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -31,31 +31,36 @@ Description This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan. - User specifies: - \li pressure drop vs volumetric flow rate table (fan curve) file name; - \li direction of normal flow through the fan, in or out; - \li total pressure of the environment. + \heading Patch usage + + \table + Property | Description | Required | Default value + fileName | fan curve file name | yes | + outOfBounds | out of bounds handling | yes | + direction | direction of flow through fan [in/out] | yes | + p0 | environmental total pressure | yes | + \endtable Example of the boundary condition specification: \verbatim inlet { type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction in; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure + fileName "fanCurve"; + outOfBounds clamp; + direction in; + p0 uniform 0; + value uniform 0; } outlet { type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction out; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure + fileName "fanCurve"; + outOfBounds clamp; + direction out; + p0 uniform 0; + value uniform 0; } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 18884da980..04ec0c4ef7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -44,7 +44,7 @@ Description \verbatim myPatch { - type mappedFixedInternalValue; + type mappedFixedPushedInternalValue; fieldName T; setAverage no; average 0; @@ -78,7 +78,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mappedFixedPushedInternalValueFvPatchField Declaration + Class mappedFixedPushedInternalValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index a160e2c292..8dac3f6f56 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type mappedFixedInternalValue; + type mappedVelocityFlux; phi phi; value uniform 0; // place holder } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index f71feaa1e3..c7f13d7506 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -61,7 +61,7 @@ Description \verbatim myPatch { - type externalWallHeatFluxTemperature; + type multiphaseFixedFluxPressure; phiHbyA phiHbyA; phi phi; rho rho; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 5906f790a6..2b6242a42d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type inletOutlet; + type surfaceNormalFixedValue; refValue -10; // 10 INTO the domain } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index d32a1ba460..c6e9c70b88 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type rotatingWallVelocity; + type translatingWallVelocity; U (100 0 0); } \endverbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C index 42ed096ea6..5f0e009d13 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C @@ -97,10 +97,8 @@ void Foam::gradientEnergyFvPatchScalarField::updateCoeffs() return; } - const basicThermo& thermo = db().lookupObject - ( - "thermophysicalProperties" - ); + const basicThermo& thermo = + db().lookupObject("thermophysicalProperties"); const label patchi = patch().index(); diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index 2ee94c08cc..a510d3ac82 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -28,9 +28,25 @@ Group grpThermoBoundaryConditions Description - This boundary condition provides a gradient condition for internal energy + This boundary condition provides a gradient condition for internal energy, + where the gradient is calculated using: + + \f[ + \nabla(e_p) = \nabla_\perp C_p(p, T) + \frac{e_p - e_c}{\Delta} + \f] + + where + \vartable + e_p | energy at patch faces [J] + e_c | energy at patch internal cells [J] + p | pressure [bar] + T | temperature [K] + C_p | specific heat [J/kg/K] + \Delta | distance between patch face and internal cell centres [m] + \endvartable \heading Patch usage + Example of the boundary condition specification: \verbatim myPatch diff --git a/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H index de6086c906..6d1f65fe73 100644 --- a/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::alphaContactAngleFvPatchScalarField +Group + grpWallBoundaryConditions grpGenericBoundaryConditions + Description Abstract base class for alphaContactAngle boundary conditions. @@ -47,11 +50,12 @@ Description on p_rgh must set to guarantee that the flux is corrected to be zero at the wall e.g. - walls - { - type fixedFluxPressure; - adjoint no; - } + \verbatim + myPatch + { + type alphaContactAngle; + } + \endverbatim If "limit zeroGradient;" is used the pressure BCs can be left as before. @@ -72,7 +76,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class alphaContactAngleFvPatch Declaration + Class alphaContactAngleFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class alphaContactAngleFvPatchScalarField diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index aaaee1c650..2bc06bb0e4 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -61,7 +61,7 @@ Description \verbatim myPatch { - type turbulentInlet; + type convectiveHeatTransfer; L 0.1; } \endverbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 0998193046..60271aae48 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -45,7 +45,7 @@ Description \verbatim myPatch { - type alphaSgsJayatillekeWallFunction; + type alphatJayatillekeWallFunction; Prt 0.85; kappa 0.41; E 9.8; 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 ee89a45f6c..479cb18b40 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -37,14 +37,14 @@ Description Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | - roughnessFactor | scaling factor | + roughnessFactor | scaling factor | yes | \endtable Example of the boundary condition specification: \verbatim myPatch { - type nutURoughWallFunction; + type mutURoughWallFunction; roughnessHeight 1e-5; roughnessConstant 0.5; roughnessFactor 1; diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H index 4eeefb74cc..2501fa5b71 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H @@ -29,9 +29,22 @@ Group Description This boundary condition provides a turbulent viscosity condition when - using wall functions for rough walls, based on velocity, using Spaldings + using wall functions for rough walls, based on velocity, using Spalding's law to give a continuous nut profile to the wall (y+ = 0) + \f[ + y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, + - 0.5 (\kappa u^+)^2 - \frac{1}{6} (\kappa u^+)^3\right] + \f] + + where + \vartable + y^+ | non-dimensional position + u^+ | non-dimensional velocity + \kappa | Von Karman constant + \endvartable + + \heading Patch usage Example of the boundary condition specification: diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H index 8daa978a22..fdf5a0a7d6 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,7 +49,7 @@ Description \verbatim myPatch { - type nutkAtmRoughWallFunction; + type mutkRoughWallFunction; Ks uniform 0; Cs uniform 0.5; } diff --git a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H index e8d9cc0376..d1ad27977f 100644 --- a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H @@ -25,7 +25,8 @@ License Class Foam::fixedShearStressFvPatchVectorField -Group grpWallBoundaryConditions +Group + grpWallBoundaryConditions Description Set a constant shear stress as tau0 = -nuEff dU/dn. diff --git a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index 8e0dccd0cc..b45b7a330c 100644 --- a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,18 +24,57 @@ License Class Foam::porousBafflePressureFvPatchField +Group + grpCoupledBoundaryConditions + Description - Foam::porousBafflePressureFvPatchField - the porous baffle operates on a cyclic patch and introduce a jump on the p - field as follow: + This boundary condition provides a jump condition, using the \cyclic + condition as a base. - deltaP = -(I*mu*U + 0.5*D*rho*magSqr(U)*L) + The porous baffle introduces a pressure jump defined by: - where: + \f[ + \Delta p = -(I \mu U + 0.5 D \rho |U|^2 L) + \f] - I is the inertial coefficient - D is the darcy coeafficient - L is the porous media lenght in the flow direction + where + + \vartable + p | pressure [Pa] + \rho | density [kg/m3] + \mu | viscosity [Pa s] + I | inertial coefficient + D | Darcy coefficient + L | porous media length in the flow direction + \endvartable + + + \heading Patch usage + + \table + Property | Description | Required | Default value + patchType | underlying patch type should be \c cyclic| yes | + D | Darcy coefficient | yes | + I | inertial coefficient | yes | + L | porous media length in the flow direction | yes | + \endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type porousBafflePressure; + patchType cyclic; + jump uniform 0; + D 1000000; + I 0.001; + L 0.1; + value uniform 0; + } + \endverbatim + + \note + The underlying \c patchType should be set to \c cyclic SourceFiles porousBafflePressureFvPatchField.C @@ -63,7 +102,7 @@ class porousBafflePressureFvPatchField { // Private data - //- Darcy pressure lost coefficient + //- Darcy pressure loss coefficient scalar D_; //- Inertia pressure lost coefficient diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 10e6691933..f52dbac173 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -34,7 +34,7 @@ Description \c ABLInletVelocity inlet velocity boundary condition. \f[ - \epsilon = \frac{(U^*)^3}{(K(z - z_g + z_0))} + \epsilon = \frac{(U^*)^3}{K(z - z_g + z_0)} \f] where @@ -49,7 +49,7 @@ Description and: \f[ - U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} + U^* = K \frac{U_{ref}}{ln\left(\frac{Z_{ref} + z_0}{z_0}\right)} \f] where: @@ -74,7 +74,7 @@ Description \verbatim myPatch { - type atmBoundaryLayerInletVelocity; + type atmBoundaryLayerInletEpsilon; z 1.0; kappa 0.41; Uref 1.0; diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 6e686dfbdd..60d150deb0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -37,7 +37,7 @@ Description \table Property | Description | Required | Default value heatSource | heat source type: \c flux [W/m2] or \c power [W]| yes | - q | heat source value | yea | + q | heat source value | yes | alphaEff | turbulent thermal diffusivity field name | yes | \endtable diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index c0f8066e97..881752d9f5 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -37,7 +37,7 @@ Description Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | - roughnessFactor | scaling factor | + roughnessFactor | scaling factor | yes | \endtable Example of the boundary condition specification: diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index ba1dde4514..b9f75ed1b1 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -30,7 +30,20 @@ Group Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity, using - Spaldings law to give a continuous nut profile to the wall (y+ = 0) + Spalding's law to give a continuous nut profile to the wall (y+ = 0) + + \f[ + y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, + - 0.5 (\kappa u^+)^2 - \frac{1}{6} (\kappa u^+)^3\right] + \f] + + where + \vartable + y^+ | non-dimensional position + u^+ | non-dimensional velocity + \kappa | Von Karman constant + \endvartable + \heading Patch usage diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 8bbe8b16b8..980f55f3b1 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -48,7 +48,7 @@ Description \verbatim myPatch { - type nutkAtmRoughWallFunction; + type nutkRoughWallFunction; Ks uniform 0; Cs uniform 0.5; } From 477abea289b24235c02560d4b5afa20bf2d6c819 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 17:16:03 +0100 Subject: [PATCH 048/109] ENH: Updates to BC documentation --- .../SRFFreestreamVelocityFvPatchVectorField.H | 7 +++++- .../SRFVelocityFvPatchVectorField.H | 22 +++++++++++++++---- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index fe50e35cac..58c7ab9ce0 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -48,12 +48,17 @@ Description \heading Patch usage + \table + Property | Description | Required | Default value + UInf | free stream velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFFreestreamVelocity; - UInf (0 0 0); // free stream velocity + UInf (0 0 0); value uniform (0 0 0); // optional value entry } \endverbatim diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 71bb989bcd..32aaa246a7 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -41,24 +41,38 @@ Description - relative = yes: inlet velocity applied 'as is': \f[ - Up = U_in + U_p = U_{in} \f] - relative = no : SRF velocity is subtracted from the inlet velocity: \f[ - Up = U_in - U_srf + U_p = U_{in} - U_{p,srf} \f] + where + \vartable + U_p = patch velocity [m/s] + U_{in} = user-specified inlet velocity + U_{p,srf} = SRF velocity + \endvartable + + \heading Patch usage + \table + Property | Description | Required | Default value + relative | relative motion to the SRF? | yes | + inletValue | inlet velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFVelocity; - relative yes; // relative motion to the SRF? - inletValue uniform (0 0 0); // inlet velocity + relative yes; + inletValue uniform (0 0 0); value uniform (0 0 0); // initial value } \endverbatim From a17b0c75c651f32a44e0f486f23d62cb1d00827e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:23:35 +0100 Subject: [PATCH 049/109] ENH: Updates to function object documentation --- .../IO/partialWrite/partialWrite.H | 3 ++- .../removeRegisteredObject.H | 3 ++- .../writeRegisteredObject.H | 3 ++- .../cloud/cloudInfo/cloudInfo.H | 3 ++- .../fieldAverage/fieldAverage/fieldAverage.H | 3 ++- .../fieldCoordinateSystemTransform.H | 3 ++- .../field/fieldMinMax/fieldMinMax.H | 3 ++- .../field/fieldValues/fieldValue/fieldValue.H | 3 ++- .../field/nearWallFields/nearWallFields.H | 3 ++- .../field/processorField/processorField.H | 3 ++- .../field/readFields/readFields.H | 3 ++- .../regionSizeDistribution.H | 3 ++- .../field/streamLine/streamLine.H | 3 ++- .../surfaceInterpolateFields.H | 2 +- .../field/turbulenceFields/turbulenceFields.H | 3 ++- .../wallBoundedStreamLine.H | 3 ++- .../forces/forceCoeffs/forceCoeffs.H | 3 ++- .../functionObjects/forces/forces/forces.H | 3 ++- .../abortCalculation/abortCalculation.H | 3 ++- .../functionObjects/systemCall/systemCall.H | 3 ++- .../codedFunctionObject/codedFunctionObject.H | 3 ++- .../utilities/dsmcFields/dsmcFields.H | 3 ++- .../pressureCoefficient/pressureCoefficient.H | 18 ++++++++++++++---- .../utilities/staticPressure/staticPressure.H | 3 ++- .../timeActivatedFileUpdate.H | 3 ++- .../utilities/yPlusLES/yPlusLES.H | 3 ++- .../utilities/yPlusRAS/yPlusRAS.H | 3 ++- src/sampling/probes/probes.H | 7 +++---- .../sampledSet/sampledSet/sampledSet.H | 7 +++---- .../sampledSurface/sampledSurface.H | 7 +++---- 30 files changed, 74 insertions(+), 42 deletions(-) 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 -@} \*---------------------------------------------------------------------------*/ From c293b14bb758f432171571a805300b8c62af42c3 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:33:53 +0100 Subject: [PATCH 050/109] STYLE: use symbol for infinity instead of inf in docs --- .../utilities/pressureCoefficient/pressureCoefficient.H | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 265ac0f656..327dbb10c1 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -31,11 +31,11 @@ Description Calculates pressure coefficient, \f$c_p\f$ \f[ - c_p = \frac{p}{p_{dyn,inf}} + c_p = \frac{p}{p_{dyn,\infty}} \f] where: \f[ - p_{dyn,inf} = 0.5 \rho |U_{inf}|^2 + p_{dyn,\infty} = 0.5 \rho |U_{\infty}|^2 \f] where From 5cbb50e1fdeae5131daaf84458f03a3ea78053e2 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:53:46 +0100 Subject: [PATCH 051/109] ENH: Make thermo BCs a subset of general BCs --- .../doc/thermophysicalBoundaryConditionsDoc.H | 1 + 1 file changed, 1 insertion(+) diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H index 610d554454..f7f9389b71 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpThermoBoundaryConditions Thermophysical boundary conditions @{ + \ingroup grpBoundaryConditions This group contains thermophysical model boundary conditions @} From ea062b8e98ec0333358d1f3ed2ad613f640b7153 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:54:21 +0100 Subject: [PATCH 052/109] BUG: corrected class to Class for doxy docs --- .../fieldCoordinateSystemTransform.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index bda640e009..dce7cbc144 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -class +Class Foam::fieldCoordinateSystemTransform Group From 7db6ec1bffa7d14e5eb735b6c9a1cf56121bd71b Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:54:46 +0100 Subject: [PATCH 053/109] BUG: Corrected group for compressible kqR wall function --- .../kqRWallFunction/kqRWallFunctionFvPatchField.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 3ce69d19c0..d525d80b56 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -25,7 +25,7 @@ Class Foam::compressible::RASModels::kqRWallFunctionFvPatchField Group - grpIcoWallFunctions + grpCmpWallFunctions Description This boundary condition is applied to turbulence \c k, \c q, and \c R From 853a665aa5a057ab776002189c03c000dbee9e25 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:55:09 +0100 Subject: [PATCH 054/109] STLE: minor code formatting --- src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H | 2 +- .../atmBoundaryLayerInletVelocityFvPatchVectorField.H | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H index 4cd593a213..8b6889ea03 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H +++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H @@ -34,7 +34,7 @@ License The difference between the methods is based on when the patch values are updated. When the condition is applied to a solution variable, the call to updateCoeffs() occurs as a preliminary step of the - \.solve(). The evaluate() method is invoked after, or idependent + \.solve(). The evaluate() method is invoked after, or independent of the matrix solve, via a call to \.correctBoundaryConditions(). @} diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 79b3dc08b6..58813df8ce 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -34,7 +34,7 @@ Description co-ordinate \c z. \f[ - U = \frac{U^*}{K} ln(\frac{z - z_g + z_0}{z_0}) + U = \frac{U^*}{K} ln\left(\frac{z - z_g + z_0}{z_0}\right) \f] where @@ -49,7 +49,7 @@ Description and: \f[ - U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} + U^* = K \frac{U_{ref}}{ln\left(\frac{Z_{ref} + z_0}{z_0}\right)} \f] where: From 05dad2aa10b29a203bbd11b37fe9f8bfb2af900e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 17:10:02 +0100 Subject: [PATCH 055/109] ENH: Added preliminary docs for RAS turbulence --- .../compressible/RAS/LRR/LRR.H | 5 ++- .../RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H | 5 ++- .../RAS/LaunderSharmaKE/LaunderSharmaKE.H | 5 ++- .../compressible/RAS/RASModel/RASModel.H | 1 - .../compressible/RAS/RASModel/RASModelDoc.H | 31 +++++++++++++++++++ .../RAS/RNGkEpsilon/RNGkEpsilon.H | 5 ++- .../RAS/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../compressibleRASBoundaryConditionsDoc.H | 1 + .../compressible/RAS/kEpsilon/kEpsilon.H | 5 ++- .../compressible/RAS/kOmegaSST/kOmegaSST.H | 5 ++- .../compressible/RAS/laminar/laminar.H | 5 ++- .../RAS/realizableKE/realizableKE.H | 5 ++- .../incompressible/RAS/LRR/LRR.H | 5 ++- .../RAS/LamBremhorstKE/LamBremhorstKE.H | 5 ++- .../RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H | 5 ++- .../RAS/LaunderSharmaKE/LaunderSharmaKE.H | 5 ++- .../RAS/LienCubicKE/LienCubicKE.H | 3 ++ .../RAS/LienCubicKELowRe/LienCubicKELowRe.H | 3 ++ .../LienLeschzinerLowRe/LienLeschzinerLowRe.H | 5 ++- .../RAS/NonlinearKEShih/NonlinearKEShih.H | 3 ++ .../incompressible/RAS/RASModel/RASModel.H | 3 ++ .../incompressible/RAS/RASModel/RASModelDoc.H | 31 +++++++++++++++++++ .../RAS/RNGkEpsilon/RNGkEpsilon.H | 5 ++- .../RAS/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../incompressibleRASBoundaryConditionsDoc.H | 1 + .../incompressible/RAS/kEpsilon/kEpsilon.H | 5 ++- .../incompressible/RAS/kOmega/kOmega.H | 5 ++- .../incompressible/RAS/kOmegaSST/kOmegaSST.H | 3 ++ .../incompressible/RAS/kkLOmega/kkLOmega.H | 5 ++- .../incompressible/RAS/laminar/laminar.H | 5 ++- .../incompressible/RAS/qZeta/qZeta.H | 5 ++- .../RAS/realizableKE/realizableKE.H | 5 ++- 32 files changed, 167 insertions(+), 23 deletions(-) create mode 100644 src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H create mode 100644 src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H diff --git a/src/turbulenceModels/compressible/RAS/LRR/LRR.H b/src/turbulenceModels/compressible/RAS/LRR/LRR.H index 14237fd20a..6ff918abc7 100644 --- a/src/turbulenceModels/compressible/RAS/LRR/LRR.H +++ b/src/turbulenceModels/compressible/RAS/LRR/LRR.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LRR +Group + grpCmpRASTurbulence + Description Launder, Reece and Rodi Reynolds-stress turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H b/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H index 4266e05e5d..4d8208dd3c 100644 --- a/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H +++ b/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LaunderGibsonRSTM +Group + grpCmpRASTurbulence + Description Launder-Gibson Reynolds stress turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H b/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H index 7afa0d232c..149b4cc9c3 100644 --- a/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H +++ b/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LaunderSharmaKE +Group + grpCmpRASTurbulence + Description Launder and Sharma low-Reynolds k-epsilon turbulence model for compressible and combusting flows. diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H index 1a24cb78ee..ba86355602 100644 --- a/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H @@ -27,7 +27,6 @@ Namespace Description Namespace for compressible RAS turbulence models. - Class Foam::compressible::RASModel diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H new file mode 100644 index 0000000000..552123ed17 --- /dev/null +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpRASTurbulence Compressible RAS turbulence +@{ + This group contains compressible RAS models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H b/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H index 477cfba15f..87c2918f1d 100644 --- a/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H +++ b/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::RNGkEpsilon +Group + grpCmpRASTurbulence + Description Renormalisation group k-epsilon turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H index f3b83a1148..a7fb64b73c 100644 --- a/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::SpalartAllmaras +Group + grpCmpRASTurbulence + Description Spalart-Allmaras one-eqn mixing-length model for compressible external flows. diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H index 152f631578..d0ef1e1af9 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpCmpRASBoundaryConditions RAS compressible boundary conditions @{ + \ingroup grpCmpRASTurbulence This group contains compressible RAS turbulence model boundary conditions @} diff --git a/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H b/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H index 62e2f65c38..3cd23cf6a5 100644 --- a/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H +++ b/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::kEpsilon +Group + grpCmpRASTurbulence + Description Standard k-epsilon turbulence model for compressible flows diff --git a/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H b/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H index f4798d852d..fc28cdebb1 100644 --- a/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H +++ b/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::kOmegaSST +Group + grpCmpRASTurbulence + Description Implementation of the k-omega-SST turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/laminar/laminar.H b/src/turbulenceModels/compressible/RAS/laminar/laminar.H index 09597983ce..953dbc5e97 100644 --- a/src/turbulenceModels/compressible/RAS/laminar/laminar.H +++ b/src/turbulenceModels/compressible/RAS/laminar/laminar.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::laminar +Group + grpCmpRASTurbulence + Description Dummy turbulence model for laminar compressible flow. diff --git a/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H b/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H index 8098dd0ee6..b173013a58 100644 --- a/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H +++ b/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::realizableKE +Group + grpCmpRASTurbulence + Description Realizable k-epsilon turbulence model for compressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LRR/LRR.H b/src/turbulenceModels/incompressible/RAS/LRR/LRR.H index 2f1a119b9c..9b03c598eb 100644 --- a/src/turbulenceModels/incompressible/RAS/LRR/LRR.H +++ b/src/turbulenceModels/incompressible/RAS/LRR/LRR.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LRR +Group + grpIcoRASTurbulence + Description Launder, Reece and Rodi Reynolds-stress turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H b/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H index 449055f4c5..9f826ce1ee 100644 --- a/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H +++ b/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LamBremhorstKE +Group + grpIcoRASTurbulence + Description Lam and Bremhorst low-Reynolds number k-epsilon turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H b/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H index 0b6fc91b4b..909844a5ed 100644 --- a/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H +++ b/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LaunderGibsonRSTM +Group + grpIcoRASTurbulence + Description Launder-Gibson Reynolds stress turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H b/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H index 3f2338e18e..92a53434d7 100644 --- a/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H +++ b/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LaunderSharmaKE +Group + grpIcoRASTurbulence + Description Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H b/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H index ebe7c373d8..bbeedbff05 100644 --- a/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H +++ b/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienCubicKE +Group + grpIcoRASTurbulence + Description Lien cubic non-linear k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H b/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H index 0efd63a454..cae720d40d 100644 --- a/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H +++ b/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienCubicKELowRe +Group + grpIcoRASTurbulence + Description Lien cubic non-linear low-Reynolds k-epsilon turbulence models for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H b/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H index 3fa1c790fe..2131ac8784 100644 --- a/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H +++ b/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienLeschzinerLowRe +Group + grpIcoRASTurbulence + Description Lien and Leschziner low-Reynolds k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H b/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H index c7ad8a3713..19f5b9c427 100644 --- a/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H +++ b/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::NonlinearKEShih +Group + grpIcoRASTurbulence + Description Shih's quadratic non-linear k-epsilon turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H index 0d0d41ea1e..b1a97681c2 100644 --- a/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H @@ -24,6 +24,9 @@ License Namespace Foam::incompressible::RASModels +Group + grpIcoRASTurbulence + Description Namespace for incompressible RAS turbulence models. diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H new file mode 100644 index 0000000000..95b87a7c92 --- /dev/null +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoRASTurbulence Incompressible RAS turbulence +@{ + This group contains incompressible RAS models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H b/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H index 62b60b9804..0b7951ad85 100644 --- a/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H +++ b/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::RNGkEpsilon +Group + grpIcoRASTurbulence + Description Renormalisation group k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H index fbd1248181..26c38db037 100644 --- a/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::SpalartAllmaras +Group + grpIcoRASTurbulence + Description Spalart-Allmaras 1-eqn mixing-length model for incompressible external flows. diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H index 366f7e5c9e..c593102064 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpIcoRASBoundaryConditions RAS incompressible boundary conditions @{ + \ingroup grpIcoRASTurbulence This group contains incompressible RAS turbulence model boundary conditions @} diff --git a/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H b/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H index a3baf20513..2e07ffde49 100644 --- a/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H +++ b/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kEpsilon +Group + grpIcoRASTurbulence + Description Standard k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H b/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H index 10729f334e..098f55e811 100644 --- a/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H +++ b/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kOmega +Group + grpIcoRASTurbulence + Description Standard high Reynolds-number k-omega turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H b/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H index bd4b3742b5..f4d207cf84 100644 --- a/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H +++ b/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kOmegaSST +Group + grpIcoRASTurbulence + Description Implementation of the k-omega-SST turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H b/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H index 83db5f82d5..6151e8ca9f 100644 --- a/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H +++ b/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kkLOmega +Group + grpIcoRASTurbulence + Description Low Reynolds-number k-kl-omega turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/laminar/laminar.H b/src/turbulenceModels/incompressible/RAS/laminar/laminar.H index 90afadff13..18f824b284 100644 --- a/src/turbulenceModels/incompressible/RAS/laminar/laminar.H +++ b/src/turbulenceModels/incompressible/RAS/laminar/laminar.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::laminar +Group + grpIcoRASTurbulence + Description Dummy turbulence model for laminar incompressible flow. diff --git a/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H b/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H index ba8dc1b413..88e54c8a06 100644 --- a/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H +++ b/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::qZeta +Group + grpIcoRASTurbulence + Description Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H b/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H index 045f333390..c467b0b797 100644 --- a/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H +++ b/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::realizableKE +Group + grpIcoRASTurbulence + Description Realizable k-epsilon turbulence model for incompressible flows. From 645ed32eb7f7de2c316212ecc9e001c27498d37b Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:08:15 +0100 Subject: [PATCH 056/109] ENH: Added preliminary docs for LES turbulence --- .../DeardorffDiffStress/DeardorffDiffStress.H | 5 ++- .../LES/GenEddyVisc/GenEddyVisc.H | 5 ++- .../LES/GenSGSStress/GenSGSStress.H | 7 ++-- .../compressible/LES/LESModel/LESModel.H | 4 ++- .../compressible/LES/LESModel/LESModelDoc.H | 32 +++++++++++++++++++ .../LES/Smagorinsky/Smagorinsky.H | 3 ++ .../LES/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../homogeneousDynOneEqEddy.H | 5 ++- .../LES/lowReOneEqEddy/lowReOneEqEddy.H | 5 ++- .../compressible/LES/oneEqEddy/oneEqEddy.H | 5 ++- .../compressible/RAS/RASModel/RASModelDoc.H | 1 + .../turbulenceModel/turbulenceModelDoc.H | 31 ++++++++++++++++++ .../DeardorffDiffStress/DeardorffDiffStress.H | 19 ++++++----- .../LES/GenEddyVisc/GenEddyVisc.H | 5 ++- .../LES/GenSGSStress/GenSGSStress.H | 5 ++- .../incompressible/LES/LESModel/LESModel.H | 3 ++ .../incompressible/LES/LESModel/LESModelDoc.H | 32 +++++++++++++++++++ .../LES/LRRDiffStress/LRRDiffStress.H | 5 ++- .../LES/Smagorinsky/Smagorinsky.H | 5 ++- .../LES/Smagorinsky2/Smagorinsky2.H | 5 ++- .../LES/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../SpalartAllmarasDDES/SpalartAllmarasDDES.H | 5 ++- .../SpalartAllmarasIDDES.H | 5 ++- .../LES/dynLagrangian/dynLagrangian.H | 5 ++- .../LES/dynOneEqEddy/dynOneEqEddy.H | 5 ++- .../homogeneousDynOneEqEddy.H | 5 ++- .../homogeneousDynSmagorinsky.H | 5 ++- .../LES/kOmegaSSTSAS/kOmegaSSTSAS.H | 5 ++- .../LES/mixedSmagorinsky/mixedSmagorinsky.H | 5 ++- .../incompressible/LES/oneEqEddy/oneEqEddy.H | 5 ++- .../LES/scaleSimilarity/scaleSimilarity.H | 5 ++- .../LES/spectEddyVisc/spectEddyVisc.H | 5 ++- .../incompressible/RAS/RASModel/RASModelDoc.H | 1 + .../turbulenceModel/turbulenceModelDoc.H | 31 ++++++++++++++++++ 34 files changed, 245 insertions(+), 34 deletions(-) create mode 100644 src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H create mode 100644 src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H create mode 100644 src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H create mode 100644 src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H diff --git a/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index 9e57d10e11..3581ca5191 100644 --- a/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::DeardorffDiffStress +Group + grpCmpLESTurbulence + Description Differential SGS Stress Equation Model for compressible flows diff --git a/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H b/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H index f11a06da9b..0c8aaea8c6 100644 --- a/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H +++ b/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::GenEddyVisc +Group + grpCmpLESTurbulence + Description General base class for all compressible models that can be implemented as an eddy viscosity, i.e. algebraic and one-equation models. diff --git a/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H b/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H index 20309c3203..4fbb54be1b 100644 --- a/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H +++ b/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::GenSGSStress +Group + grpCmpLESTurbulence + Description General base class for all compressible models that directly solve for the SGS stress tensor B. @@ -52,7 +55,7 @@ namespace LESModels { /*---------------------------------------------------------------------------*\ - Class GenSGSStress Declaration + Class GenSGSStress Declaration \*---------------------------------------------------------------------------*/ class GenSGSStress diff --git a/src/turbulenceModels/compressible/LES/LESModel/LESModel.H b/src/turbulenceModels/compressible/LES/LESModel/LESModel.H index 32bd44971d..7e0f0aace2 100644 --- a/src/turbulenceModels/compressible/LES/LESModel/LESModel.H +++ b/src/turbulenceModels/compressible/LES/LESModel/LESModel.H @@ -24,10 +24,12 @@ License Namespace Foam::compressible::LESModels +Group + grpCmpLESTurbulence + Description Namespace for compressible LES models. - Class Foam::compressible::LESModel diff --git a/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H b/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H new file mode 100644 index 0000000000..ac8c52e36a --- /dev/null +++ b/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpLESTurbulence Compressible LES turbulence +@{ + \ingroup grpCmpTurbulence + This group contains compressible LES models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H b/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H index 947b49fa75..14f880450a 100644 --- a/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H +++ b/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::Smagorinsky +Group + grpCmpLESTurbulence + Description The choric Smagorinsky Model for compressible flows. diff --git a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H index 5caa292642..9597eed61b 100644 --- a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::SpalartAllmaras +Group + grpCmpLESTurbulence + Description SpalartAllmaras for compressible flows diff --git a/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H b/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H index 8464dd8cf7..3248bbabf0 100644 --- a/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::homogeneousDynOneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for compressible flows. diff --git a/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H b/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H index 42aca80291..cdd38223c3 100644 --- a/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::lowReOneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for compressible flow diff --git a/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H b/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H index aa00969499..bf3e527977 100644 --- a/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::oneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H index 552123ed17..53757f8141 100644 --- a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H @@ -25,6 +25,7 @@ License \defgroup grpCmpRASTurbulence Compressible RAS turbulence @{ + \ingroup grpCmpTurbulence This group contains compressible RAS models. @} diff --git a/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H b/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H new file mode 100644 index 0000000000..17bc210959 --- /dev/null +++ b/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpTurbulence Compressible turbulence +@{ + This group contains compressible turbulence models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index 7862490dc8..f9e87de208 100644 --- a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,26 +24,29 @@ License Class Foam::incompressible::LESModels::DeardorffDiffStress +Group + grpIcoLESTurbulence + Description Differential SGS Stress Equation Model for incompressible flows The DSEM uses a model version of the full balance equation for the SGS stress tensor to simulate the behaviour of B. Thus, - \verbatim - d/dt(B) + div(U*B) - div(nuSgs*grad(B)) - = - P - c1*epsilon/k*B - 0.667*(1 - c1)*epsilon*I - c2*(P - 0.333*trP*I) + \f[ + \frac{d}{dt}(B) + \nabla\cdot(U B) - \nabla\cdot(\nu_{sgs}\nabla B) + = + P - c_1 \frac{\epsilon}{k}B - 0.667(1 - c_1)\epsilon I + - c_2 (P - 0.333 trP I) + \f] where - k = 0.5*tr(B), epsilon = ce*k^3/2/delta, epsilon/k = ce*k^1/2/delta P = -(B'L + L'B) nuSgs = ck*sqrt(k)*delta nuEff = nuSgs + nu - \endverbatim SourceFiles DeardorffDiffStress.C @@ -65,7 +68,7 @@ namespace LESModels { /*---------------------------------------------------------------------------*\ - Class DeardorffDiffStress Declaration + Class DeardorffDiffStress Declaration \*---------------------------------------------------------------------------*/ class DeardorffDiffStress diff --git a/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H b/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H index 0746377eb7..c5a8119332 100644 --- a/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H +++ b/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::GenEddyVisc +Group + grpIcoLESTurbulence + Description General base class for all incompressible models that can be implemented as an eddy viscosity, i.e. algebraic and one-equation models. diff --git a/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H b/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H index 36d84f9c77..afe797b409 100644 --- a/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H +++ b/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::GenSGSStress +Group + grpIcoLESTurbulence + Description General base class for all incompressible models that directly solve for the SGS stress tensor B. diff --git a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H index deca26e793..ab1265b7d2 100644 --- a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H +++ b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H @@ -24,6 +24,9 @@ License Namespace Foam::incompressible::LESModels +Group + grpIcoLESTurbulence + Description Namespace for incompressible LES models. diff --git a/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H b/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H new file mode 100644 index 0000000000..9b400e23ee --- /dev/null +++ b/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoLESTurbulence Incompressible LES turbulence +@{ + \ingroup grpIcoTurbulence + This group contains incompressible LES models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H b/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H index afe530a00e..62aaaa3ef0 100644 --- a/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::LRRDiffStress +Group + grpIcoLESTurbulence + Description Differential SGS Stress Equation Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H b/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H index e110591917..8af2bbe08a 100644 --- a/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::Smagorinsky +Group + grpIcoLESTurbulence + Description The Isochoric Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H b/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H index 89c77912cd..139e66fe53 100644 --- a/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H +++ b/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::Smagorinsky2 +Group + grpIcoLESTurbulence + Description The Isochoric Smagorinsky Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H index 7ed507712a..9a4ee17388 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmaras +Group + grpIcoLESTurbulence + Description SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H index b721e8b8b8..eebe26cfa5 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmarasDDES +Group + grpIcoLESTurbulence + Description SpalartAllmaras DDES LES turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H index bf44430e5a..43f10eee33 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmarasIDDES +Group + grpIcoLESTurbulence + Description SpalartAllmarasIDDES LES turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H b/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H index 2d83299d4a..004efeaaed 100644 --- a/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H +++ b/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::dynLagrangian +Group + grpIcoLESTurbulence + Description Dynamic eddy-viscosity model with Lagrangian averaging for incompressible flow diff --git a/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H b/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H index 5b744eb0d2..6a9384f406 100644 --- a/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::dynOneEqEddy +Group + grpIcoLESTurbulence + Description Localised Dynamic One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H b/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H index 6de3992574..68e0183345 100644 --- a/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::homogeneousDynOneEqEddy +Group + grpIcoLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H b/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H index 05ac587a5b..cc95bb047a 100644 --- a/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::homogeneousDynSmagorinsky +Group + grpIcoLESTurbulence + Description The Isochoric homogeneous dynamic Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H index 2ca98380af..97354ff492 100644 --- a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H +++ b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::kOmegaSSTSAS +Group + grpIcoLESTurbulence + Description kOmegaSSTSAS LES turbulence model for incompressible flows based on: diff --git a/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H b/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H index c8557db239..1793c8053d 100644 --- a/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::mixedSmagorinsky +Group + grpIcoLESTurbulence + Description The mixed Isochoric Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H b/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H index 0f040d829a..dd68b53258 100644 --- a/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::oneEqEddy +Group + grpIcoLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H b/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H index 0dff31d87e..5a6a5d97a6 100644 --- a/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H +++ b/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::scaleSimilarity +Group + grpIcoLESTurbulence + Description General base class for all scale similarity models for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H b/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H index 9b3782e49b..a223a9d076 100644 --- a/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H +++ b/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::spectEddyVisc +Group + grpIcoLESTurbulence + Description The Isochoric spectral Eddy Viscosity Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H index 95b87a7c92..216165664d 100644 --- a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H @@ -25,6 +25,7 @@ License \defgroup grpIcoRASTurbulence Incompressible RAS turbulence @{ + \ingroup grpIcoTurbulence This group contains incompressible RAS models. @} diff --git a/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H b/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H new file mode 100644 index 0000000000..f9751dc542 --- /dev/null +++ b/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoTurbulence Incompressible turbulence +@{ + This group contains incompressible turbulence models. +@} + +\*---------------------------------------------------------------------------*/ From 5a6d6578c422fd6e9a3d7536bf8794c81948c183 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:08:56 +0100 Subject: [PATCH 057/109] ENH: Added boundary condition documentation --- .../fvPatchFields/doc/boundaryConditions.dox | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index 72a3078da4..7bb0894d70 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -24,11 +24,13 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // \page pageBoundaryConditions Boundary Conditions - -\ref grpBoundaryConditions - +\ref grpBoundaryConditions are required to 'close' the simulation problem. +Careful attention should be applied to their selection so as to create a +well-posed system of equations, which can be solved numerically. \section secBoundaryConditionsOverview Overview +The set of available \ref grpBoundaryConditions comprise of basic, turbulent and +thermophysical types. \subsection secBC1 Basic boundary conditions - \ref grpConstraintBoundaryConditions @@ -47,6 +49,10 @@ License \section secWallFunctions Wall functions +Wall functions in OpenFOAM are modelled as boundary conditions, applied to +the viscosity for momentum, and thermal diffusivity for energy. Two groups of +wall functions are available, which vary in terms of the underlying +compressibility assumption. Wall functions for incompressible flow - \ref grpIcoWallFunctions @@ -56,6 +62,9 @@ Wall functions for compressible flow \section secBoundaryConditions Typical usage for pressure-velocity systems +The choice as to the most appropriate set of boundary conditions is dictated by +the type of flow problem. In many cases, multiple possible selections exist; +the following tables offer suggestions for subsonic flow. subsonic inlet (flow specified): \table @@ -75,7 +84,7 @@ subsonic outlet: derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink \endtable -wall: +wall (impermeable, non-slip): \table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink From b57e6295c1c1417d557e7af06f0f8358759c7b1e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:24:31 +0100 Subject: [PATCH 058/109] ENH: updated DeardorffDiffStress header doc --- .../LES/DeardorffDiffStress/DeardorffDiffStress.H | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index f9e87de208..f3b8c6c448 100644 --- a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -41,12 +41,14 @@ Description \f] where - k = 0.5*tr(B), - epsilon = ce*k^3/2/delta, - epsilon/k = ce*k^1/2/delta - P = -(B'L + L'B) - nuSgs = ck*sqrt(k)*delta - nuEff = nuSgs + nu + \f{eqnarray*}{ + k &=& 0.5 tr(B) \\ + \epsilon &=& c_e k^{3/2}/\Delta \\ + \epsilon/k &=& c_e k^{1/2}/\Delta \\ + P &=& -(B'L + L'B) \\ + \nu_{sgs} &=& c_k k^{1/2} \Delta \\ + \nu_{eff} &=& \nu_{sgs} + \nu + \f} SourceFiles DeardorffDiffStress.C From 708a8e9ea0719d01be2e62e473123ae76170bb55 Mon Sep 17 00:00:00 2001 From: andy Date: Tue, 24 Jul 2012 10:59:53 +0100 Subject: [PATCH 059/109] BUG: Corrected typo --- .../turbulentIntensityKineticEnergyInletFvPatchScalarField.C | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C index cb3395f0a6..7689d3d763 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C @@ -85,7 +85,7 @@ turbulentIntensityKineticEnergyInletFvPatchScalarField "(" "const fvPatch&, " "const DimensionedField&, " - "const dictionary& + "const dictionary&" ")" ) << "Turbulence intensity should be specified as a fraction 0-1 " "of the mean velocity\n" From 01cf1d6f9eb2f14dc98851d69ef385519847f3c5 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 26 Jul 2012 13:00:11 +0100 Subject: [PATCH 060/109] ENH: Updated function object documentation --- .../cloud/cloudInfo/cloudInfo.H | 19 ++++++ .../fieldAverage/fieldAverage/fieldAverage.H | 63 ++++++++++++------- .../fieldAverageItem/fieldAverageItem.H | 16 ++--- .../fieldCoordinateSystemTransform.H | 36 ++++++++++- 4 files changed, 102 insertions(+), 32 deletions(-) diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index f0c56e71fb..4dd82e6b54 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -33,6 +33,25 @@ Description - total current number of parcels - total current mass of parcels + Example of function object specification: + \verbatim + cloudInfo1 + { + // Type of functionObject + type cloudInfo; + + // Where to load it from (if not already in solver) + functionObjectLibs ("libcloudFunctionObjects.so"); + + // Clouds to process + clouds + ( + kinematicCloud1 + thermoCloud1 + ); + } + \endverbatim + SourceFiles cloudInfo.C IOcloudInfo.H diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index c85ef60678..f76885fe02 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,8 +28,42 @@ Group grpFieldFunctionObjects Description - Calculates the field averages given list of fieldAverageItems, e.g. + This function object calculates average quantities for a user-specified + selection of fields. Fields are entered as a list of sub-dictionaries, + which indicate the type of averages to perform, and can be updated during + the calculation. The current options include: + - \c mean: arithmetic mean: + \f[ + \overline{x} = \frac{\Sigma x i}{\Sigma i} + \f] + - \c prime2Mean: prime-squared mean + \f[ + \overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i} + \f] + - base: average over 'time', or 'iteration' (\f$i\f$ in the above) + - window: optional averaging window, specified in 'base' units + \note + To employ the \c prime2Mean option, the \c mean option must be selecetd. + + Average field names are constructed by concatenating the base field with + the averaging type, e.g. when averaging field 'U', the resultant fields + are: + - arithmetic mean field, UMean + - prime-squared field, UPrime2Mean + + Information regarding the number of averaging steps, and total averaging + time are written on a per-field basis to the + \c fieldAveragingProperties dictionary, located in \/uniform + + When restarting form a previous calculation, the averaging is continuous. + However, the averaging process can be restarted using the \c cleanRestart + option. + + To restart the averaging process after each calculation output time, + the \c resetOnOutput option can be applied. + + Example of function object specification: \verbatim fieldAverage1 { @@ -39,16 +73,13 @@ Description // Where to load it from (if not already in solver) functionObjectLibs ("libfieldFunctionObjects.so"); - // Whether to perform a clean restart, or start from previous - // averaging info if available + // Perform a clean restart? cleanRestart true; - // Whether to reset the averaged fields after they have been written. - // Used to average over only the preceding write interval for transient - // cases. - resetOnOutput true; + // Reset the averaged fields after they have been written? + resetOnOutput false; - // Fields to be averaged. runTime modifiable! + // Fields to be averaged fields ( U @@ -67,22 +98,10 @@ Description } \endverbatim - Member function calcAverages() calculates the averages. - - Member function fieldAverage::write() calls calcAverages(). Average - field names are constructed by concatenating the base field with the - averaging type, e.g. - - base field, U - - arithmetic mean field, UMean - - prime-squared field, UPrime2Mean - - Information regarding the number of averaging steps, and total averaging - time are written on a (base) per-field basis to the - fieldAveragingProperties dictionary, located in \/uniform - SourceFiles fieldAverage.C fieldAverageTemplates.C + fieldAverageItem.C \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H index 10d1e08ad3..992b5e393f 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,16 +25,16 @@ Class Foam::fieldAverageItem Description - Helper class to describe what form of averaging to apply. A set will be + Helper class to describe what form of averaging to apply. A set will be applied to each base field in Foam::fieldAverage, of the form: \verbatim - { - mean on; - prime2Mean on; - base time; // iteration - window 200; // optional averaging window - } + { + mean on; + prime2Mean on; + base time; // iteration + window 200; // optional averaging window + } \endverbatim The averaging window corresponds to the averaging interval (iters or time) diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index dce7cbc144..ace8c48bfb 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -28,8 +28,40 @@ Group grpFieldFunctionObjects Description - Transforms fields from global cartesian co-ordinates to local co-ordinate - system + This function object transforms a user-specified selection of fields from + global Cartesian co-ordinates to a local co-ordinate system. The fields + are run-time modifiable. + + Example of function object specification: + \verbatim + fieldCoordinateSystemTransform1 + { + // Type of functionObject + type fieldCoordinateSystemTransform; + + // Where to load it from (if not already in solver) + functionObjectLibs ("libfieldFunctionObjects.so"); + + // Fields to be transformed + fields + ( + U + UMean + UPrime2Mean + ); + + // Co-ordinate system + coordinateSystem + { + origin (0.001 0 0); + e1 (1 0.15 0); + e3 (0 0 -1); + } + } + \endverbatim + +SeeAlso + Foam::coordinateSystem SourceFiles fieldCoordinateSystemTransform.C From 0f302e29125c20e45f51763df199c09186afd2e4 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 26 Jul 2012 13:09:42 +0100 Subject: [PATCH 061/109] ENH:removed unnecessary scoping --- .../singleStepCombustion/singleStepCombustion.C | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/src/combustionModels/singleStepCombustion/singleStepCombustion.C b/src/combustionModels/singleStepCombustion/singleStepCombustion.C index aab73f7abf..fcbf4249d9 100644 --- a/src/combustionModels/singleStepCombustion/singleStepCombustion.C +++ b/src/combustionModels/singleStepCombustion/singleStepCombustion.C @@ -92,8 +92,7 @@ singleStepCombustion::~singleStepCombustion() // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * // template -Foam::tmp -singleStepCombustion::R +tmp singleStepCombustion::R ( const volScalarField& Y ) const @@ -110,8 +109,8 @@ singleStepCombustion::R template -Foam::tmp -singleStepCombustion< CombThermoType, ThermoType>::Sh() const +tmp +singleStepCombustion::Sh() const { const label fuelI = singleMixturePtr_->fuelIndex(); const volScalarField& YFuel = this->thermoPtr_->composition().Y(fuelI); @@ -121,8 +120,8 @@ singleStepCombustion< CombThermoType, ThermoType>::Sh() const template -Foam::tmp -singleStepCombustion< CombThermoType, ThermoType>::dQ() const +tmp +singleStepCombustion::dQ() const { tmp tdQ ( @@ -153,7 +152,7 @@ singleStepCombustion< CombThermoType, ThermoType>::dQ() const template -bool singleStepCombustion< CombThermoType, ThermoType>::read() +bool singleStepCombustion::read() { if (CombThermoType::read()) { From db306003abca61797b7efadecf5ab8a39c995e9a Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 27 Jul 2012 18:06:24 +0100 Subject: [PATCH 062/109] ENH: Updates to doxygen docs --- .../fieldAverage/fieldAverage/fieldAverage.H | 7 ++- .../field/fieldValues/faceSource/faceSource.H | 57 ++++++++++--------- ...iffusiveRadiationMixedFvPatchScalarField.H | 5 ++ .../kqRWallFunctionFvPatchField.H | 7 ++- 4 files changed, 45 insertions(+), 31 deletions(-) diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index f76885fe02..1b5abb7644 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -34,13 +34,14 @@ Description the calculation. The current options include: - \c mean: arithmetic mean: \f[ - \overline{x} = \frac{\Sigma x i}{\Sigma i} + \overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i \f] - \c prime2Mean: prime-squared mean \f[ - \overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i} + \overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N + (x_i - \overline{x})^2 \f] - - base: average over 'time', or 'iteration' (\f$i\f$ in the above) + - base: average over 'time', or 'iteration' (\f$N\f$ in the above) - window: optional averaging window, specified in 'base' units \note diff --git a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H index fd95788894..786cd0caaf 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H @@ -28,6 +28,7 @@ Description Face source variant of field value function object. Values of user- specified fields reported for collections of faces. + \verbatim faceObj1 // Name also used to identify output folder { type faceSource; @@ -48,6 +49,7 @@ Description U ); } + \endverbatim source: - faceZone : requires a 'sourceName' entry to specify the faceZone @@ -56,34 +58,37 @@ Description sampleDict. operation is one of: - - none - - sum - - average - - weightedAverage - - areaAverage - - areaIntegrate - - min - - max - - CoV (Coefficient of variation: standard deviation/mean) - - areaNormalAverage (vector with first component (average of) inproduct - of value and face area vector) - - areaNormalIntegrate ( ,, ,, (sum of) ,, + - none + - sum + - average (ensemble) + - weightedAverage + - areaAverage + - areaIntegrate + - min + - max + - CoV (Coefficient of variation: standard deviation/mean) + - areaNormalAverage (vector with first component (average of) inproduct + of value and face area vector) + - areaNormalIntegrate ( ,, ,, (sum of) ,, - Notes: + For example, to calculate the volumetric or mass flux across a patch, + apply the 'sum' operator to the flux field (typically \c phi) + + \note - faces on empty patches get ignored - - if the field is a volField the faceZone can only consist of boundary - faces. - - all fields get oriented according to the faceZone (so you might e.g. see - negative pressure) - - using sampledSurfaces: - - they do not do surface fields - - if interpolate=true they use interpolationCellPoint - otherwise they use cell values - - each triangle in sampledSurface is logically only in one cell - so interpolation will be wrong when triangles are larger than - cells. This can only happen for sampling on triSurfaceMesh. - - take care when using isoSurfaces - these might have duplicate - triangles so integration might be wrong + - if the field is a volField the \c faceZone can only consist of boundary + faces + - all fields get oriented according to the \c faceZone (so you might + e.g. see negative pressure) + - using \c sampledSurfaces: + - they do not do surface fields + - if interpolate=true they use \c interpolationCellPoint + otherwise they use cell values + - each triangle in \c sampledSurface is logically only in one cell + so interpolation will be wrong when triangles are larger than + cells. This can only happen for sampling on \c triSurfaceMesh + - take care when using isoSurfaces - these might have duplicate + triangles so integration might be wrong SourceFiles faceSource.C diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index 8019e61017..4f7afc0fa0 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -33,6 +33,11 @@ Description \heading Patch usage + \table + Property | Description | Required | Default value + T | temperature field name | no | T + \endtable + Example of the boundary condition specification: \verbatim myPatch diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 0626b3c1b9..c63821fe9a 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -28,8 +28,11 @@ Group grpIcoWallFunctions Description - This boundary condition is applied to turbulence \c k, \c q, and \c R - when using wall functions, and simply enforces a zero-gradient condition. + This boundary condition provides a suitable condition for turbulence + \c k, \c q, and \c R fields for the case of high Reynolds number flow using + wall functions. + + It is a simple wrapper around the zero-gradient condition. \heading Patch usage From 5182c3bf976fc21b4b1f22611366acbef2a0fdf8 Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 27 Jul 2012 18:06:24 +0100 Subject: [PATCH 063/109] ENH: Updates to doxygen docs --- .../field/fieldAverage/fieldAverage/fieldAverage.H | 7 ++++--- .../kqRWallFunction/kqRWallFunctionFvPatchField.H | 7 +++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index f76885fe02..1b5abb7644 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -34,13 +34,14 @@ Description the calculation. The current options include: - \c mean: arithmetic mean: \f[ - \overline{x} = \frac{\Sigma x i}{\Sigma i} + \overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i \f] - \c prime2Mean: prime-squared mean \f[ - \overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i} + \overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N + (x_i - \overline{x})^2 \f] - - base: average over 'time', or 'iteration' (\f$i\f$ in the above) + - base: average over 'time', or 'iteration' (\f$N\f$ in the above) - window: optional averaging window, specified in 'base' units \note diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 0626b3c1b9..c63821fe9a 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -28,8 +28,11 @@ Group grpIcoWallFunctions Description - This boundary condition is applied to turbulence \c k, \c q, and \c R - when using wall functions, and simply enforces a zero-gradient condition. + This boundary condition provides a suitable condition for turbulence + \c k, \c q, and \c R fields for the case of high Reynolds number flow using + wall functions. + + It is a simple wrapper around the zero-gradient condition. \heading Patch usage From d9912c20036a52c8ad427ce659c551fe3b5f4fbd Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 3 Aug 2012 11:43:28 +0100 Subject: [PATCH 064/109] ENH: Doxygen docs - using Note instead of \note --- .../fvPatchFields/basic/mixed/mixedFvPatchField.H | 2 +- .../constraint/cyclic/cyclicFvPatchField.H | 10 +++++----- .../constraint/cyclicAMI/cyclicAMIFvPatchField.H | 10 +++++----- .../derived/advective/advectiveFvPatchField.H | 11 ++++------- .../cylindricalInletVelocityFvPatchVectorField.H | 2 +- .../fvPatchFields/derived/fan/fanFvPatchField.H | 2 +- .../fixedInternalValueFvPatchField.H | 2 +- .../derived/fixedJump/fixedJumpFvPatchField.H | 2 +- .../flowRateInletVelocityFvPatchVectorField.H | 2 +- .../fluxCorrectedVelocityFvPatchVectorField.H | 2 +- .../freestreamPressureFvPatchScalarField.H | 2 +- .../derived/inletOutlet/inletOutletFvPatchField.H | 2 +- .../derived/mappedField/mappedFieldFvPatchField.H | 2 +- .../mappedFixedInternalValueFvPatchField.H | 2 +- .../mappedFixedPushedInternalValueFvPatchField.H | 2 +- .../mappedFixedValue/mappedFixedValueFvPatchField.H | 2 +- .../mappedVelocityFluxFixedValueFvPatchField.H | 2 +- .../oscillatingFixedValueFvPatchField.H | 2 +- .../derived/outletInlet/outletInletFvPatchField.H | 2 +- ...reDirectedInletOutletVelocityFvPatchVectorField.H | 2 +- ...pressureDirectedInletVelocityFvPatchVectorField.H | 2 +- ...ureInletOutletParSlipVelocityFvPatchVectorField.H | 2 +- .../pressureInletOutletVelocityFvPatchVectorField.H | 2 +- .../pressureInletVelocityFvPatchVectorField.H | 2 +- ...sureNormalInletOutletVelocityFvPatchVectorField.H | 2 +- ...ngPressureInletOutletVelocityFvPatchVectorField.H | 2 +- .../supersonicFreestreamFvPatchVectorField.H | 2 +- .../surfaceNormalFixedValueFvPatchVectorField.H | 2 +- .../swirlFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../temperatureJumpFvPatchScalarField.H | 2 +- .../timeVaryingMappedFixedValueFvPatchField.H | 2 +- .../totalPressure/totalPressureFvPatchScalarField.H | 6 +++--- .../uniformFixedValueFvPatchField.H | 2 +- .../uniformTotalPressureFvPatchScalarField.H | 8 ++++---- ...leHeightFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../field/fieldAverage/fieldAverage/fieldAverage.H | 6 +++--- .../field/fieldValues/faceSource/faceSource.H | 2 +- ...ingLengthDissipationRateInletFvPatchScalarField.H | 6 +++--- ...entMixingLengthFrequencyInletFvPatchScalarField.H | 6 +++--- ...ternalWallHeatFluxTemperatureFvPatchScalarField.H | 4 ++-- .../porousBafflePressureFvPatchField.H | 2 +- ...atmBoundaryLayerInletVelocityFvPatchVectorField.H | 12 ++++++------ .../turbulentHeatFluxTemperatureFvPatchScalarField.H | 10 +++++----- ...ingLengthDissipationRateInletFvPatchScalarField.H | 6 +++--- ...entMixingLengthFrequencyInletFvPatchScalarField.H | 6 +++--- ...kappatJayatillekeWallFunctionFvPatchScalarField.H | 6 +++--- .../nutUTabulatedWallFunctionFvPatchScalarField.H | 8 ++++---- 47 files changed, 88 insertions(+), 91 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 7c475c1111..77dba4ada8 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -57,7 +57,7 @@ Description refGrad | patch normal gradient | yes | \endtable - \note +Note This condition is not usually applied directly; instead, use a derived mixed condition such as \c inletOutlet diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 85a03380f0..ded4696854 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -31,11 +31,6 @@ Description This boundary condition enforces a cyclic condition between a pair of boundaries. - \note - The patches must be topologically similar, i.e. if the owner patch is - transformed to the neighbour patch, the patches should be identical (or - very similar). - \heading Patch usage Example of the boundary condition specification: @@ -46,6 +41,11 @@ Description } \endverbatim +Note + The patches must be topologically similar, i.e. if the owner patch is + transformed to the neighbour patch, the patches should be identical (or + very similar). + SourceFiles cyclicFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index cef14ae106..c9ad16c6c9 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -32,11 +32,6 @@ Description boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation. - \note - The outer boundary of the patch pairs must be similar, i.e. if the owner - patch is transformed to the neighbour patch, the outer perimiter of each - patch should be identical (or very similar). - \heading Patch usage Example of the boundary condition specification: @@ -47,6 +42,11 @@ Description } \endverbatim +Note + The outer boundary of the patch pairs must be similar, i.e. if the owner + patch is transformed to the neighbour patch, the outer perimiter of each + patch should be identical (or very similar). + SeeAlso Foam::AMIInterpolation diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 305beeaced..5c62df1049 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -58,22 +58,19 @@ Description lInf | distance beyond patch for \c fieldInf | no | \endtable - \note - If \c lInf is specified, \c fieldInf will be required; \c rho is only - required in the case of a mass-based flux. - Example of the boundary condition specification: \verbatim myPatch { type advective; phi phi; - // rho rho; // Not needed for volumetric-based flux - // fieldInf 1e5; // Optional - // lInf 0.1; // Optional } \endverbatim +Note + If \c lInf is specified, \c fieldInf will be required; \c rho is only + required in the case of a mass-based flux. + SourceFiles advectiveFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 482b365f2a..4e3db2fdff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -56,7 +56,7 @@ Description } \endverbatim - \note +Note The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 9306796d79..3eea1382f3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -66,7 +66,7 @@ Description The above example shows the use of a comma separated (CSV) file to specify the jump condition. - \note +Note The underlying \c patchType should be set to \c cyclic SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 2fdd5f71b4..75a9742240 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -43,7 +43,7 @@ Description } \endverbatim - \note +Note This is used as a base for conditions such as the turbulence \c epsilon wall function, which applies a near-wall constraint for high Reynolds number flows. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 983edbfa92..30ec57fc54 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -30,7 +30,7 @@ Group Description Base class for "jump" of a field - \note +Note not used directly SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index f15d4e666a..0b78dddc22 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -64,7 +64,7 @@ Description The \c flowRate entry is a \c DataEntry type, meaning that it can be specified as constant, a polynomial fuction of time, and ... - \note +Note - the value is positive into the domain (as an inlet) - may not work correctly for transonic inlets - strange behaviour with potentialFoam since the U equation is not solved diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 059c3addfd..4519a5ed9d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -64,7 +64,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureInletOutletVelocity condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index ae082c5da3..fa5233308c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -42,7 +42,7 @@ Description } \endverbatim - \note +Note This condition is designed to operate with a freestream velocity condition SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index d97e6eb817..21aea3aa91 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -53,7 +53,7 @@ Description The mode of operation is determined by the sign of the flux across the patch faces. - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): apply the user-specified fixed value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index bb413a141c..6dd9f3efb5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -53,7 +53,7 @@ Description } \endverbatim - \note +Note Since this condition can be applied on a per-field and per-patch basis, it is possible to duplicate the mapping information. If possible, employ the \c mapped condition in preference to avoid this situation, and only diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index dbf6595879..a4b48fce8f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -51,7 +51,7 @@ Description } \endverbatim - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 04ec0c4ef7..2f9ecedd66 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -52,7 +52,7 @@ Description } \endverbatim - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 672889d325..dd52f2a2b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -65,7 +65,7 @@ Description boundary faces and both faces sample into the cell, both faces will get the same value. - \note +Note It is not possible to sample internal faces since volume fields are not defined on faces. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 8dac3f6f56..409154eaff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -51,7 +51,7 @@ Description The underlying sample mode should be set to \c nearestPatchFace or \c nearestFace - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index af8ac75a74..c4d9066696 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -68,7 +68,7 @@ Description } \endverbatim - \note +Note The amplitude and frequency entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 53d47a3592..d843815a5f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -53,7 +53,7 @@ Description The mode of operation is determined by the sign of the flux across the patch faces. - \note +Note Sign conventions: - positive flux (out of domain): apply the user-specified fixed value - negative flux (into of domain): apply zero-gradient condition diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index d12d390ea1..b6e24c73c7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux with specified diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index a7ea670a9b..c98ad304da 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -53,7 +53,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 7fbb307d04..f1f2f3a9d3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux with specified diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 36680dd7d8..1ed301b191 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux in the patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 2ea77ceeff..12b7d8bec5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -45,7 +45,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureInletOutletVelocityFvPatchVectorField condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 3df7b5ed9a..c138b18f69 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -52,7 +52,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux and patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 5a95fa75bf..cc114d7c6b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -56,7 +56,7 @@ Description The \c omega entry is a DataEntry type, able to describe time varying functions. - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux in the patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index ca013bb04c..402fc365f3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -58,7 +58,7 @@ Description } \endverbatim - \note +Note This boundary condition is ill-posed if the free-stream flow is normal to the boundary. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 2b6242a42d..e0068654fd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -47,7 +47,7 @@ Description } \endverbatim - \note +Note Sign conventions: - the value is positive for outward-pointing vectors diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 307d9486a6..a53dd0ca12 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -57,7 +57,7 @@ Description } \endverbatim - \note +Note - the \c flowRate and \c rpm entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index d788f543be..0663a1cb86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -56,7 +56,7 @@ Description The above example shows the use of a constant jump condition. - \note +Note The underlying \c patchType should be set to \c cyclic SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 86a8029cdf..61228fe07c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -61,7 +61,7 @@ Description } /endverbatim - \note +Note Switch on debug flag to have it dump the triangulation (in transformed space) and transform face centres. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index dd49014a32..05bd6b1800 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -101,9 +101,6 @@ Description p0 | static pressure reference | yes | \endtable - \note - The default boundary behaviour is for subsonic, incompressible flow. - Example of the boundary condition specification: \verbatim myPatch @@ -118,6 +115,9 @@ Description } \endverbatim +Note + The default boundary behaviour is for subsonic, incompressible flow. + SeeAlso Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 3b09b75a4c..072d02f1b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -46,7 +46,7 @@ Description } \endverbatim - \note +Note The uniformValue entry is a DataEntry type, able to describe time varying functions. The example above gives the usage for supplying a constant value. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 46f81be514..0dca30f8ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -44,9 +44,6 @@ Description pressure | total pressure as a function of time | yes | \endtable - \note - The default boundary behaviour is for subsonic, incompressible flow. - Example of the boundary condition specification: \verbatim myPatch @@ -62,10 +59,13 @@ Description } \endverbatim - The \c pressure entry is specified as a DataEntry type, able to describe time varying functions. +Note + The default boundary behaviour is for subsonic, incompressible flow. + + SeeAlso Foam::DataEntry Foam::uniformFixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index c4322d6a57..10e6a2c889 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -51,7 +51,7 @@ Description } \endverbatim - \note +Note - the value is positive into the domain - may not work correctly for transonic inlets - strange behaviour with potentialFoam since the momentum equation is diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 1b5abb7644..db35e35d5c 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -44,9 +44,6 @@ Description - base: average over 'time', or 'iteration' (\f$N\f$ in the above) - window: optional averaging window, specified in 'base' units - \note - To employ the \c prime2Mean option, the \c mean option must be selecetd. - Average field names are constructed by concatenating the base field with the averaging type, e.g. when averaging field 'U', the resultant fields are: @@ -99,6 +96,9 @@ Description } \endverbatim +Note + To employ the \c prime2Mean option, the \c mean option must be selecetd. + SourceFiles fieldAverage.C fieldAverageTemplates.C diff --git a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H index 786cd0caaf..f9199f451a 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H @@ -74,7 +74,7 @@ Description For example, to calculate the volumetric or mass flux across a patch, apply the 'sum' operator to the flux field (typically \c phi) - \note +Note - faces on empty patches get ignored - if the field is a volField the \c faceZone can only consist of boundary faces diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index a55997915c..2031e2a808 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -46,9 +46,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -68,6 +65,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 68f2a00884..9aaeb71db0 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -45,9 +45,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -67,6 +64,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 1230136b73..44e96635ba 100644 --- a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -55,8 +55,8 @@ Description } \endverbatim - \note - Only supply \h an \c Ta, or \c q in the dictionary (see above) +Note + Only supply \c h and \c Ta, or \c q in the dictionary (see above) SourceFiles externalWallHeatFluxTemperatureFvPatchScalarField.C diff --git a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index b45b7a330c..a52e8e5b34 100644 --- a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -73,7 +73,7 @@ Description } \endverbatim - \note +Note The underlying \c patchType should be set to \c cyclic SourceFiles diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 0b1e2002f8..b37c40a3da 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -64,12 +64,6 @@ Description layer", Journal of Wind Engineering and Industrial Aerodynamics 95(2007), pp 355-369. - \note - D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the - k-epsilon model should be changed from 1.3 to 1.11 for consistency. - The roughness height (Er) is given by Er = 20 z0 following the same - reference. - \heading Patch usage \table @@ -98,6 +92,12 @@ Description } \endverbatim +Note + D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the + k-epsilon model should be changed from 1.3 to 1.11 for consistency. + The roughness height (Er) is given by Er = 20 z0 following the same + reference. + SourceFiles atmBoundaryLayerInletVelocityFvPatchVectorField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 60d150deb0..59b8106d15 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -41,11 +41,6 @@ Description alphaEff | turbulent thermal diffusivity field name | yes | \endtable - \note - - it is assumed that the units of \c alphaEff are [kg/m/s] - - the specific heat capcaity is read from the transport dictionary entry - \c Cp0 - Example of the boundary condition specification: \verbatim myPatch @@ -58,6 +53,11 @@ Description } \endverbatim +Note + - it is assumed that the units of \c alphaEff are [kg/m/s] + - the specific heat capcaity is read from the transport dictionary entry + \c Cp0 + SourceFiles turbulentHeatFluxTemperatureFvPatchScalarField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 6f812db1e6..7a74a83849 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -46,9 +46,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -68,6 +65,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 602c382b9f..e39e13845f 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -45,9 +45,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -67,6 +64,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index aaa71c3f47..c26d9a41ec 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -32,9 +32,6 @@ Description This boundary condition provides a kinematic turbulent thermal conductivity for using wall functions, using the Jayatilleke 'P' function. - \note - The units of kinematic turbulent thermal conductivity are m2/s - \heading Patch usage \table @@ -53,6 +50,9 @@ Description } \endverbatim +Note + The units of kinematic turbulent thermal conductivity are [m2/s] + SeeAlso Foam::fixedValueFvPatchField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 591cf8da77..95bde3ba03 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -33,10 +33,6 @@ Description of U+ as a function of near-wall Reynolds number. The table should be located in the $FOAM_CASE/constant folder. - \note - the tables are not registered since the same table object may be used for - more than one patch. - \heading Patch usage \table @@ -53,6 +49,10 @@ Description } \endverbatim +Note + The tables are not registered since the same table object may be used for + more than one patch. + SeeAlso Foam::nutWallFunctionFvPatchScalarField From 3a59106af5c4c131b5d083fa2931a023ba34d8bf Mon Sep 17 00:00:00 2001 From: andy Date: Fri, 3 Aug 2012 12:41:00 +0100 Subject: [PATCH 065/109] STYLE: Minor code formatting --- .../fvPatchFields/basic/calculated/calculatedFvPatchField.C | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C index ebc4bbcfc9..9f25a143e2 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C @@ -187,6 +187,7 @@ Foam::calculatedFvPatchField::valueBoundaryCoeffs return *this; } + template Foam::tmp > Foam::calculatedFvPatchField::gradientInternalCoeffs() const @@ -208,6 +209,7 @@ Foam::calculatedFvPatchField::gradientInternalCoeffs() const return *this; } + template Foam::tmp > Foam::calculatedFvPatchField::gradientBoundaryCoeffs() const From 93e7d6e3929f6800c5a3779d6e547126a812dd61 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 14:29:16 +0100 Subject: [PATCH 066/109] ENH: fieldAverage - renamed cleanRestart to resetOnRestart --- .../fieldAverage/fieldAverage/fieldAverage.C | 8 ++--- .../fieldAverage/fieldAverage/fieldAverage.H | 34 ++++++++++++------- 2 files changed, 25 insertions(+), 17 deletions(-) diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.C b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.C index be8b03a5b5..5d63cced6c 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.C +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -245,7 +245,7 @@ void Foam::fieldAverage::writeAveragingProperties() const void Foam::fieldAverage::readAveragingProperties() { - if (cleanRestart_) + if (resetOnRestart_) { Info<< "fieldAverage: starting averaging at time " << obr_.time().timeName() << nl << endl; @@ -306,7 +306,7 @@ Foam::fieldAverage::fieldAverage obr_(obr), active_(true), prevTimeIndex_(-1), - cleanRestart_(false), + resetOnRestart_(false), resetOnOutput_(false), faItems_(), meanScalarFields_(), @@ -354,7 +354,7 @@ void Foam::fieldAverage::read(const dictionary& dict) { if (active_) { - dict.readIfPresent("cleanRestart", cleanRestart_); + dict.readIfPresent("resetOnRestart", resetOnRestart_); dict.readIfPresent("resetOnOutput", resetOnOutput_); dict.lookup("fields") >> faItems_; diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index db35e35d5c..632c45493a 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -55,29 +55,23 @@ Description \c fieldAveragingProperties dictionary, located in \/uniform When restarting form a previous calculation, the averaging is continuous. - However, the averaging process can be restarted using the \c cleanRestart + However, the averaging process can be restarted using the \c resetOnRestart option. - To restart the averaging process after each calculation output time, - the \c resetOnOutput option can be applied. + To restart the averaging process after each calculation output time, use + the \c resetOnOutput option. Example of function object specification: \verbatim fieldAverage1 { - // Type of functionObject type fieldAverage; - - // Where to load it from (if not already in solver) functionObjectLibs ("libfieldFunctionObjects.so"); - // Perform a clean restart? - cleanRestart true; + resetOnRestart true; - // Reset the averaged fields after they have been written? resetOnOutput false; - // Fields to be averaged fields ( U @@ -96,9 +90,23 @@ Description } \endverbatim + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: fieldAverage | yes | + resetOnRestart | flag to reset the averaging on restart | yes | + resetOnOutput| flag to reset the averaging on output | yes | + fields | list of fields and averaging options | yes | + \endtable + + Note To employ the \c prime2Mean option, the \c mean option must be selecetd. +SeeAlso + functionObject.H + OutputFilterFunctionObject.H + SourceFiles fieldAverage.C fieldAverageTemplates.C @@ -158,10 +166,10 @@ protected: //- Time at last call, prevents repeated averaging label prevTimeIndex_; - //- Clean restart flag - Switch cleanRestart_; + //- Reset the averaging process on restart flag + Switch resetOnRestart_; - //- resetOnOutput flag + //- Reset the averaging process on output flag Switch resetOnOutput_; //- List of field average items, describing what averages to be From 536c4aa210f60e4623b84da84eb414550cc1fbf5 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 14:29:42 +0100 Subject: [PATCH 067/109] ENH: Updated function object documentation --- .../cloud/cloudInfo/cloudInfo.H | 23 ++++++--- .../functionObjects/doc/functionObjects.dox | 50 +++++++++++++------ 2 files changed, 53 insertions(+), 20 deletions(-) diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 4dd82e6b54..a2a9b79941 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -28,7 +28,7 @@ Group grpCloudFunctionObjects Description - This function object outputs lagrangian cloud information to a file. The + This function object outputs Lagrangian cloud information to a file. The current outputs include: - total current number of parcels - total current mass of parcels @@ -37,13 +37,9 @@ Description \verbatim cloudInfo1 { - // Type of functionObject - type cloudInfo; - - // Where to load it from (if not already in solver) + type cloudInfo; functionObjectLibs ("libcloudFunctionObjects.so"); - // Clouds to process clouds ( kinematicCloud1 @@ -52,6 +48,21 @@ Description } \endverbatim + + \heading Function object usage + + \table + Property | Description | Required | Default value + type | type name: cloudInfo | yes | + clouds | list of clouds names to process |yes | + \endtable + + The output data of each cloud is written to a file named \.dat + +SeeAlso + functionObject.H + OutputFilterFunctionObject.H + SourceFiles cloudInfo.C IOcloudInfo.H diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox index d6ae894685..b3ea86de52 100644 --- a/src/postProcessing/functionObjects/doc/functionObjects.dox +++ b/src/postProcessing/functionObjects/doc/functionObjects.dox @@ -27,9 +27,15 @@ License \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: +OpenFOAM includes a collection of \ref grpFunctionObjects that offer users the +opportunity to closely manage their computational analyses. These objects can +be applied to manipulate the workflow process, and provide a mechanism to +extract predicted field and derived quantities at run-time. Alternatively, +the actions can be executed afterwards using the \c execFlowFunctionObjects +utility. + +
    +The current range of features comprises of: - \ref grpCloudFunctionObjects - \ref grpFieldFunctionObjects - \ref grpForcesFunctionObjects @@ -40,31 +46,47 @@ range of uses include:
    \subsection secFieldFunctionObjectUsage Using function objects -To employ function objects, additional entries are required in the +Function objects are defined by additional entries in the $FOAM_CASE/system/controlDict input dictionary. Each object is listed in a -\c functions sub-dictionary entry, e.g. +\c functions sub-dictionary entry, e.g. for `output' type objects: \verbatim functions { - myFunctionObject + myFunctionObject // user-defined name of function object entry { type functionObjectType; libs ("libMyFunctionObjectlib.so"); - active yes; // active by default - outputControl outputTime; // output or timeStep - outputInterval 1; // only necessary for outputControl=timeStep + region defaultRegion; + enabled yes; + timeStart 0; + timeEnd 10; + outputControl outputTime; + outputInterval 1; ... } } \endverbatim +Where: +\table + Property | Description | Required | Default value + type | type of function object | yes | + libs | libraries containing object implementation | yes | + region | name of region for multi-region cases | no | + enabled | on/off switch | no | yes + timeStart| start time | no | + timeEnd | end time | no | + outputControl | when to output: either 'outputTime' or 'timeStep'| no | timeStep + outputInterval| steps between output when outputControl=timeStep | no | 1 +\endtable + 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. +typically used as the name of the output folder for any derived 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. \*---------------------------------------------------------------------------*/ From c74987549bd098ec00141066d5504e31f518c1f8 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 15:44:56 +0100 Subject: [PATCH 068/109] ENH: Added plaintable doxy table --- bin/tools/doxyFilter-table.awk | 35 ++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/bin/tools/doxyFilter-table.awk b/bin/tools/doxyFilter-table.awk index df08cab6e1..bfbd80785b 100644 --- a/bin/tools/doxyFilter-table.awk +++ b/bin/tools/doxyFilter-table.awk @@ -48,6 +48,26 @@ BEGIN { } +/\\plaintable/ { + flag = 3; + firstRow = 1; + next; +} + + +/\\endplaintable/ { + if (data != "") + { + printf "
    \n"; + printf data; + printf "
    \n"; + } + + data = ""; + flag = 0; + next; +} + { if (flag > 0) { @@ -88,6 +108,21 @@ BEGIN { } } } + else if (flag == 3) + { + for (i = 0; i <= NF; i++) + { + if (i == 1) + { + data = (data " "$i"\n"); + data = (data " :\n"); + } + else if (i > 1) + { + data = (data " "$i"\n"); + } + } + } data = (data "\n"); firstRow = 0; } From f3d8e5316c6a0a81190538c041ba2fd3c8007b49 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 17:36:58 +0100 Subject: [PATCH 069/109] Updated function object documentation --- .../cloud/cloudInfo/cloudInfo.H | 6 +- .../fieldAverage/fieldAverage/fieldAverage.H | 8 +- .../fieldCoordinateSystemTransform.H | 20 ++-- .../field/fieldMinMax/fieldMinMax.H | 39 ++++++- .../field/fieldValues/cellSource/cellSource.H | 76 +++++++++---- .../field/fieldValues/faceSource/faceSource.H | 102 +++++++++++------- .../field/nearWallFields/nearWallFields.H | 45 +++++--- .../field/processorField/processorField.H | 26 ++++- .../field/readFields/readFields.H | 30 +++++- .../regionSizeDistribution.H | 86 +++++++-------- .../field/streamLine/streamLine.H | 71 +++++++++++- .../surfaceInterpolateFields.H | 45 +++++--- .../field/turbulenceFields/turbulenceFields.H | 44 +++++++- .../wallBoundedStreamLine.H | 69 +++++++++++- 14 files changed, 503 insertions(+), 164 deletions(-) diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index a2a9b79941..bf75dcacc4 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -39,7 +39,7 @@ Description { type cloudInfo; functionObjectLibs ("libcloudFunctionObjects.so"); - + ... clouds ( kinematicCloud1 @@ -60,8 +60,8 @@ Description The output data of each cloud is written to a file named \.dat SeeAlso - functionObject.H - OutputFilterFunctionObject.H + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles cloudInfo.C diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 632c45493a..f1883b1b7d 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -67,11 +67,9 @@ Description { type fieldAverage; functionObjectLibs ("libfieldFunctionObjects.so"); - + ... resetOnRestart true; - resetOnOutput false; - fields ( U @@ -104,8 +102,8 @@ Note To employ the \c prime2Mean option, the \c mean option must be selecetd. SeeAlso - functionObject.H - OutputFilterFunctionObject.H + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles fieldAverage.C diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index ace8c48bfb..e583e6b168 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -36,21 +36,15 @@ Description \verbatim fieldCoordinateSystemTransform1 { - // Type of functionObject - type fieldCoordinateSystemTransform; - - // Where to load it from (if not already in solver) + type fieldCoordinateSystemTransform; functionObjectLibs ("libfieldFunctionObjects.so"); - - // Fields to be transformed + ... fields ( U UMean UPrime2Mean ); - - // Co-ordinate system coordinateSystem { origin (0.001 0 0); @@ -60,7 +54,17 @@ Description } \endverbatim + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: fieldCoordinateSystemTransform | yes | + fields | list of fields to be transformed |yes | + coordinateSystem | local co-ordinate system | yes | + \endtable + SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject Foam::coordinateSystem SourceFiles diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 96e87b5ff3..a2fbb10f71 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -28,13 +28,44 @@ Group grpFieldFunctionObjects Description - Calculates scalar minimim and maximum field values. + This function object calculates the value and position of scalar minimim + and maximum for a list of user-specified fields. For variables with a rank + greater than zero, either the min/max of a component value or the magnitude + is reported. When operating in parallel, the processor owning the value + is also given. - For variables with rank > 0, computes the magnitude of the min/max - values. + Example of function object specification: + \verbatim + fieldMinMax1 + { + type fieldMinMax; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + write yes; + log yes; + mode magnitude; + fields + ( + U + p + ); + } + \endverbatim - Data written to the file \/fieldMinMax.dat + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: fieldMinMax | yes | + write | write min/max data to file | no | yes + log | write min/max data to standard output | no | no + mode | calculation mode: magnitude or component | no | magnitude + \endtable + Output data is written to the file \/fieldMinMax.dat + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles fieldMinMax.C diff --git a/src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H b/src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H index 5e857e02f2..7548f0e2a8 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H @@ -24,39 +24,75 @@ License Class Foam::fieldValues::cellSource -Description - Cell source variant of field value function object. Values of user- - specified fields reported for collections of cells. +Group + grpFieldFunctionObjects - cellObj1 // Name also used to identify output folder +Description + This function object provides a 'cell source' variant of the fieldValues + function object. Given a list of user-specified fields and a selection + of mesh cells, a number of operations can be performed, such as sums, + averages and integrations. + + + Example of function object specification: + \verbatim + cellSource1 { type cellSource; functionObjectLibs ("libfieldFunctionObjects.so"); - enabled true; - outputControl outputTime; - log true; // log to screen? - valueOutput true; // Write values at run-time output times? - source cellZone; // Type of cell source + ... + log true; + valueOutput true; + source cellZone; sourceName c0; operation volAverage; - weightField alpha1; // optional weight field + weightField alpha1; fields ( p U ); } + \endverbatim - where operation is one of: - - none - - sum - - average - - weightedAverage - - volAverage - - volIntegrate - - CoV (Coefficient of variation: standard deviation/mean) - - min - - max + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: cellSource | yes | + log | write data to standard output | no | no + valueOutput | write the raw output values | yes | + source | cell source: see below | yes | + sourceName | name of cell source if required | no | + operation | operation to perform | yes | + weightField | name of field to apply weighting | no | + fields | list of fields to operate on | yes | + \endtable + + \linebreak + Where \c source is defined by + \plaintable + cellZone | requires a 'sourceName' entry to specify the cellZone + all | all cells + \endplaintable + + \linebreak + The \c operation is one of: + \plaintable + none | no operation + sum | sum + average | ensemble average + weightedAverage | weighted average + volAverage | volume weighted average + volIntegrate | volume integral + min | minimum + max | maximum + CoV | coefficient of variation: standard deviation/mean + \endplaintable + +SeeAlso + Foam::fieldValues + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles cellSource.C diff --git a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H index f9199f451a..43eb0d35ad 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H @@ -24,24 +24,32 @@ License Class Foam::fieldValues::faceSource -Description - Face source variant of field value function object. Values of user- - specified fields reported for collections of faces. +Group + grpFieldFunctionObjects +Description + This function object provides a 'face source' variant of the fieldValues + function object. Given a list of user-specified fields and a selection + of mesh (or general surface) faces, a number of operations can be + performed, such as sums, averages and integrations. + + \linebreak + For example, to calculate the volumetric or mass flux across a patch, + apply the 'sum' operator to the flux field (typically \c phi) + + Example of function object specification: \verbatim - faceObj1 // Name also used to identify output folder + faceSource1 { type faceSource; functionObjectLibs ("libfieldFunctionObjects.so"); - enabled true; - outputControl outputTime; - log true; // log to screen? - valueOutput true; // Write values at run-time output times? - source faceZone; // Type of face source: - // faceZone,patch,sampledSurface - sourceName f0; // faceZone name, see below + ... + log yes; + valueOutput yes; + source faceZone; + sourceName f0; operation sum; - weightField alpha1; // optional weight field + weightField alpha1; fields ( p @@ -51,44 +59,66 @@ Description } \endverbatim - source: - - faceZone : requires a 'sourceName' entry to specify the faceZone - - patch : "" patch - - sampledSurface : requires a 'sampledSurfaceDict' subdictionary. See e.g. - sampleDict. + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: faceSource | yes | + log | write data to standard output | no | no + valueOutput | write the raw output values | yes | + source | face source: see below | yes | + sourceName | name of face source if required | no | + operation | operation to perform | yes | + weightField | name of field to apply weighting | no | + fields | list of fields to operate on | yes | + \endtable - operation is one of: - - none - - sum - - average (ensemble) - - weightedAverage - - areaAverage - - areaIntegrate - - min - - max - - CoV (Coefficient of variation: standard deviation/mean) - - areaNormalAverage (vector with first component (average of) inproduct - of value and face area vector) - - areaNormalIntegrate ( ,, ,, (sum of) ,, + \linebreak + Where \c source is defined by + \plaintable + faceZone | requires a 'sourceName' entry to specify the faceZone + patch | requires a 'sourceName' entry to specify the patch + sampledSurface | requires a 'sampledSurfaceDict' sub-dictionary + \endplaintable - For example, to calculate the volumetric or mass flux across a patch, - apply the 'sum' operator to the flux field (typically \c phi) + \linebreak + The \c operation is one of: + \plaintable + none | no operation + sum | sum + average | ensemble average + weightedAverage | weighted average + areaAverage | area weighted average + areaIntegrate | area integral + min | minimum + max | maximum + CoV | coefficient of variation: standard deviation/mean + areaNormalAverage| area weighted average in face normal direction + areaNormalIntegrate | area weighted integral in face normal directon + \endplaintable Note + - The values reported by the areaNormalAverage and areaNormalIntegrate + operations are written as the first component of a field with the same + rank as the input field. - faces on empty patches get ignored - if the field is a volField the \c faceZone can only consist of boundary faces - - all fields get oriented according to the \c faceZone (so you might + - all fields are oriented according to the \c faceZone (so you might e.g. see negative pressure) - using \c sampledSurfaces: - - they do not do surface fields + - not available for surface fields - if interpolate=true they use \c interpolationCellPoint otherwise they use cell values - each triangle in \c sampledSurface is logically only in one cell so interpolation will be wrong when triangles are larger than - cells. This can only happen for sampling on \c triSurfaceMesh + cells. This can only happen for sampling on a \c triSurfaceMesh - take care when using isoSurfaces - these might have duplicate - triangles so integration might be wrong + triangles and so integration might be wrong + +SeeAlso + Foam::fieldValues + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles faceSource.C diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 21c5bc7b09..e6be5d7948 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -28,30 +28,41 @@ Group grpFieldFunctionObjects Description - Samples near-patch volFields + This function object samples near-patch volume fields - Holds fields - - every timestep the field get updated with new values - - at write it writes the fields - so this functionObject can either be used to calculate a new field - as a postprocessing step or (since the fields are registered) - use these in another functionObject (e.g. faceSource). + Fields are stored + - every time step the field is updated with new values + - at output it writes the fields - surfaceValues + This functionObject can either be used + - to calculate a new field as a post-processing step or + - since the fields are registered, used in another functionObject + + Example of function object specification: + \verbatim + nearWallFields1 { type nearWallFields; - .. - enabled true; - outputControl outputTime; - .. - // Name of volField and corresponding surfaceField + functionObjectLibs ("libfieldFunctionObjects.so"); + ... fields ((p pNear)(U UNear)); - // Name of patch to sample patches (movingWall); - // Distance away from the wall - distance 0.13; // distance away from wall + distance 0.13; } + \endverbatim + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: nearWallFields | yes | + fields | list of fields with correspoding output field names | yes | + patches | list of patches to sample | yes | + distance | distance from patch to sample | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles nearWallFields.C @@ -77,7 +88,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class nearWallFields Declaration + Class nearWallFields Declaration \*---------------------------------------------------------------------------*/ class nearWallFields diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index 3be2dbe298..b1ecdb65f5 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -28,8 +28,28 @@ Group grpFieldFunctionObjects Description - Writes a scalar field whose value is the local processor ID. Output - field name is processorID. + This function object writes a scalar field whose value is the local + processor ID. The output field name is 'processorID'. + + Example of function object specification: + \verbatim + processorField1 + { + type processorField; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: processorField | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles processorField.C @@ -57,7 +77,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class processorField Declaration + Class processorField Declaration \*---------------------------------------------------------------------------*/ class processorField diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 8cf5b7be29..8a26b89f56 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -28,8 +28,34 @@ Group grpFieldFunctionObjects Description - Reads fields from the time folders and adds them to the mesh database - for further post-processing. + This function object reads fields from the time folders and adds them to + the mesh database for further post-processing. + + Example of function object specification: + \verbatim + readFields1 + { + type readFields; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + fields + ( + U + p + ); + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: readFields | yes | + fields | list of fields to read | no | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles readFields.C diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 077d13f93d..ce4174162e 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -28,67 +28,67 @@ Group grpFieldFunctionObjects Description - Droplet size distribution calculation. + This function object creates a size distribution via interrogating a + continuous phase fraction field. - Looks up a void-fraction (alpha) field and splits the mesh into regions - based on where the field is below the threshold value. These + Looks up a phase-fraction (alpha) field and splits the mesh into regions + based on where the field is below the threshold value. These regions ("droplets") can now be analysed. Regions: - - (debug) write regions as a volScalarField - - (debug) print for all regions the sum of volume and alpha*volume - print the regions connected to a user-defined set of patches. (in spray calculation these form the liquid core) - - print the regions with too large volume. These are the 'background' + - print the regions with too large volume. These are the 'background' regions. + - (debug) write regions as a volScalarField + - (debug) print for all regions the sum of volume and alpha*volume - Fields: - - write volScalarField alpha_liquidCore : alpha with outside liquid core - set to 0. - alpha_background : alpha with outside background - set to 0. + Output (volume scalar) fields include: + - alpha_liquidCore : alpha with outside liquid core set to 0 + - alpha_background : alpha with outside background set to 0. Histogram: - determine histogram of diameter (given minDiameter, maxDiameter, nBins) - write graph of number of droplets per bin - write graph of sum, average and deviation of droplet volume per bin - - write graph of sum, average and deviation of user-defined fields. For + - write graph of sum, average and deviation of user-defined fields. For volVectorFields these are those of the 3 components and the magnitude. - Sample input: - - functions + Example of function object specification: + \verbatim + regionSizeDistribution1 { - regionSizeDistribution - { - type regionSizeDistribution; - - outputControl timeStep; - outputInterval 1; - - // Field to determine regions from - field alpha; - // Patches that provide the liquid core - patches (inlet); - // Delimit alpha regions - threshold 0.4; - - // Fields to sample (no need to include alpha) - fields (p U); - - // Number of bins for histogram - nBins 100; - // Max droplet diameter - maxDiameter 0.5e-4; - //// Min droplet diameter (default is 0) - //minDiameter 0; - - // Writing format - setFormat gnuplot; - } + type regionSizeDistribution; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + field alpha; + patches (inlet); + threshold 0.4; + fields (p U); + nBins 100; + maxDiameter 0.5e-4; + minDiameter 0; + setFormat gnuplot; } + \endverbatim + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: regionSizeDistribution |yes| + field | phase field to interrogate | yes | + patches | patches from which the liquid core is identified | yes| + threshold | phase fraction applied to delimit regions | yes | + fields | fields to sample | yes | + nBins | number of bins for histogram | yes | + maxDiameter | maximum region equivalent diameter | yes | + minDiameter | minimum region equivalent diameter | no | 0 + setFormat | writing format | yes | + \endtable +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles regionSizeDistribution.C @@ -117,7 +117,7 @@ class regionSplit; class polyMesh; /*---------------------------------------------------------------------------*\ - Class regionSizeDistribution Declaration + Class regionSizeDistribution Declaration \*---------------------------------------------------------------------------*/ class regionSizeDistribution diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index e17f8cedf0..08f01e4519 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -28,7 +28,72 @@ Group grpFieldFunctionObjects Description - Generation of streamlines. Samples along track of passive particle. + This function object generates streamline data by sampling a set of + user-specified fields along a particle track, transported by a + user-specified velocity field. + + Example of function object specification: + \verbatim + streamLine1 + { + type streamLine; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + setFormat vtk; + UName U; + trackForward yes; + fields + ( + U + p + ); + lifeTime 10000; + trackLength 1e-3; + nSubCycle 5; + cloudName particleTracks; + seedSampleSet uniform; + uniformCoeffs + { + type uniform; + axis x; //distance; + start (-0.0205 0.0001 0.00001); + end (-0.0205 0.0005 0.00001); + nPoints 100; + } + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: streamLine | yes | + setFormat | output data type | yes | + UName | tracking velocity field name | yes | + fields | fields to sample | yes | + lifetime | maximum number of particle tracking steps | yes | + trackLength | tracking segment length | no | + nSubCycle | number of tracking steps per cell | no| + cloudName | cloud name to use | yes | + seedSampleSet| seeding method (see below)| yes | + \endtable + + \linebreak + Where \c seedSampleSet is typically one of + \plaintable + uniform | uniform particle seeding + cloud | cloud of points + triSurfaceMeshPointSet | points according to a tri-surface mesh + \endplaintable + +Note + When specifying the track resolution, the \c trackLength OR \c nSubCycle + option should be used + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + Foam::sampledSet + Foam::wallBoundedStreamLine SourceFiles streamLine.C @@ -83,7 +148,6 @@ class streamLine //- On/off switch bool active_; - //- List of fields to sample wordList fields_; @@ -130,9 +194,10 @@ class streamLine //- Axis of the sampled points to output word sampledSetAxis_; - //- File output writer + //- File writer for scalar data autoPtr > scalarFormatterPtr_; + //- File writer for vector data autoPtr > vectorFormatterPtr_; diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 44c0d54608..61d8724d69 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,26 +27,39 @@ Class Group grpFieldFunctionObjects Description - Linear interpolates volFields to surfaceFields + This function object linearly interpolates volume fields to generate + surface fields - - at write it writes the fields - - it executes every time step + Fields are stored + - every time step the field is updated with new values + - at output it writes the fields - so it can either be used to calculate and write the interpolate or - (since the interpolates are registered) use some other functionObject - to work on them. + This functionObject can either be used + - to calculate a new field as a post-processing step or + - since the fields are registered, used in another functionObject - sampleSomeFields + Example of function object specification: + \verbatim + surfaceInterpolateFields1 { - type surfaceInterpolateFields; - .. - enabled true; - outputControl outputTime; - .. - // Name of volField and corresponding surfaceField - fields ((p pInterpolate)(U UInterpolate)); + type surfaceInterpolateFields; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + fields ((p pNear)(U UNear)); } + \endverbatim + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: nearWallFields | yes | + fields | list of fields with correspoding output field names | yes | + \endtable + + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles surfaceInterpolateFields.C @@ -72,7 +85,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class surfaceInterpolateFields Declaration + Class surfaceInterpolateFields Declaration \*---------------------------------------------------------------------------*/ class surfaceInterpolateFields diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 3148b5448b..527f332c46 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -28,13 +28,53 @@ Group grpFieldFunctionObjects Description - Stores turbulence fields on the mesh database for further manipulation. + This function object stores turbulence fields on the mesh database for + further manipulation. Fields are stored as copies of the original, with the prefix "tubulenceModel::", e.g. turbulenceModel::R + Example of function object specification: + \verbatim + turbulenceFields1 + { + type turbulenceFields; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + fields + ( + R + devRhoReff + ); + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: processorField | yes | + fields | fields to store (see below) | yes | + \endtable + + Where \c fields can include: + \plaintable + R | Stress tensor + devRhoReff | + mut | turbulence viscosity (compressible) + muEff | effective turbulence viscosity (compressible) + alphat | turbulence thermal diffusivity (compressible) + alphaEff | effective turbulence thermal diffusivity (compressible) + devReff | + nut | turbulence viscosity (incompressible) + nuEff | effective turbulence viscosity (incompressible) + \endplaintable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + SourceFiles turbulenceFields.C @@ -60,7 +100,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class turbulenceFields Declaration + Class turbulenceFields Declaration \*---------------------------------------------------------------------------*/ class turbulenceFields diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 14ab62724e..e7dceed8bb 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -28,7 +28,72 @@ Group grpFieldFunctionObjects Description - Generation of streamlines. Samples along track of passive particle. + This function object generates streamline data by sampling a set of + user-specified fields along a particle track, transported by a + user-specified velocity field, constrained to a patch. + + Example of function object specification: + \verbatim + wallBoundedStreamLine1 + { + type wallBoundedStreamLine; + functionObjectLibs ("libfieldFunctionObjects.so"); + ... + setFormat vtk; + UName UNear; + trackForward yes; + fields + ( + UNear + p + ); + lifeTime 10000; + trackLength 1e-3; + nSubCycle 5; + cloudName particleTracks; + seedSampleSet patchSeed; + patchSeedCoeffs + { + type patchSeed; + patches (wall); + axis x; + maxPoints 20000; + } + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: wallBoundedStreamLine| yes | + setFormat | output data type | yes | + UName | tracking velocity field name | yes | + fields | fields to sample | yes | + lifetime | maximum number of particle tracking steps | yes | + trackLength | tracking segment length | no | + nSubCycle | number of tracking steps per cell | no| + cloudName | cloud name to use | yes | + seedSampleSet| seeding method (see below)| yes | + \endtable + + \linebreak + Where \c seedSampleSet is typically one of + \plaintable + uniform | uniform particle seeding + cloud | cloud of points + patchSeed | seeding via patch faces + triSurfaceMeshPointSet | points according to a tri-surface mesh + \endplaintable + +Note + When specifying the track resolution, the \c trackLength OR \c nSubCycle + option should be used + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + Foam::sampledSet + Foam::streamLine SourceFiles wallBoundedStreamLine.C @@ -63,7 +128,7 @@ class meshSearch; class sampledSet; /*---------------------------------------------------------------------------*\ - Class wallBoundedStreamLine Declaration + Class wallBoundedStreamLine Declaration \*---------------------------------------------------------------------------*/ class wallBoundedStreamLine From 1b314bdce7b382b386b7ee3b2e331954360eea17 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 17:38:05 +0100 Subject: [PATCH 070/109] ENH: added linebreak option for doxygen --- bin/tools/doxyFilter.sed | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 9fd65302d1..a0e6e4ff40 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -165,6 +165,9 @@ s/.*\*\//\*\// # convert /heading in source files to bold font and add some space s#\\heading \(.*\)#
    \1#g +# add a linebreak +s#\\linebreak#
    #g + } # ----------------------------------------------------------------------------- From a9e8caa9790a36860448bc199e018536c3963375 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 13 Aug 2012 18:18:19 +0100 Subject: [PATCH 071/109] ENH: Updated function object documentation --- .../forces/forceCoeffs/forceCoeffs.H | 43 +++++++++++++++-- .../functionObjects/forces/forces/forces.H | 48 +++++++++++++++++-- 2 files changed, 83 insertions(+), 8 deletions(-) diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index 2d6055ba86..9b10291842 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -28,8 +28,45 @@ Group grpForcesFunctionObjects Description - Derived from the forces function object, creates a specialisation to - calculate lift and drag forces. + This function object extends the Foam::forces function object by providing + lift, drag and moment coefficients. + + Example of function object specification: + \verbatim + forceCoeffs1 + { + type forceCoeffs; + functionObjectLibs ("libforces.so"); + ... + log yes; + patches (walls); + liftDir (0 1 0); + dragDir (-1 0 0); + pitchAxis (0 0 1); + magUInf 100; + lRef 3.5; + ARef 2.2; + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: forces | yes | + log | write force data to standard output | no | no + patches | patches included in the forces calculation | yes | + liftDir | lift direction | yes | + dragDir | drag direction | yes | + pitchAxis | picth axis | yes | + magUInf | free stream velocity magnitude | yes | + lRef | reference length scale for moment calculations | yes | + ARef | reference area | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + Foam::forces SourceFiles forceCoeffs.C @@ -48,7 +85,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class forceCoeffs Declaration + Class forceCoeffs Declaration \*---------------------------------------------------------------------------*/ class forceCoeffs diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index 1d1e525b58..4875da5c4f 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -28,16 +28,49 @@ Group grpForcesFunctionObjects Description - Calculates the forces and moments by integrating the pressure and - skin-friction forces over a given list of patches. + This function object calculates the forces and moments by integrating the + pressure and skin-friction forces over a given list of patches. Member function forces::write() calculates the forces/moments and writes the forces/moments into the file \/forces.dat + Example of function object specification: + \verbatim + forces1 + { + type forces; + functionObjectLibs ("libforces.so"); + ... + log yes; + patches (walls); + + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: forces | yes | + log | write force data to standard output | no | no + patches | patches included in the forces calculation | yes | + pName | pressure field name | no | p + UName | velocity field name | no | U + rhoName | density field name (see below) | no | rho + CofR | centre of rotation (see below) | no | + directForceDensity | force density supplied directly (see below)|no|no + fDName | name of force density field (see below) | no | fD + \endtable + Note - The centre of rotation for moment calculations can either be specified - by an \c CofR entry, or be taken from origin of the local coordinateSystem. - For example, + - For incompressible cases, set \c rhoName to \c rhoInf. You will then be + required to provide a \c rhoInf value corresponding to the free-stream + constant density. + - If the force density is supplied directly, set the \c directForceDensity + flag to 'yes', and supply the force density field using the \c + fDName entry + - The centre of rotation (CofR) for moment calculations can either be + specified by an \c CofR entry, or be taken from origin of the local + coordinate system. For example, \verbatim CofR (0 0 0); \endverbatim @@ -51,6 +84,11 @@ Note } \endverbatim +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + Foam::forceCoeffs + SourceFiles forces.C IOforces.H From 7627c08ea8a461e1d639006e823451e076009a99 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:36:53 +0100 Subject: [PATCH 072/109] ENH: Added base structure for foamHelp utility --- .../doxygenXmlParser/doxygenXmlParser.C | 242 ++++++++++++++++++ .../doxygenXmlParser/doxygenXmlParser.H | 97 +++++++ .../doxygenXmlParserTemplates.C | 67 +++++ .../foamHelp/helpTypes/helpType/helpType.C | 148 +++++++++++ .../foamHelp/helpTypes/helpType/helpType.H | 115 +++++++++ .../foamHelp/helpTypes/helpType/helpTypeNew.C | 65 +++++ 6 files changed, 734 insertions(+) create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C new file mode 100644 index 0000000000..5bf5e736e8 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C @@ -0,0 +1,242 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "doxygenXmlParser.H" +#include "wordRe.H" + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::doxygenXmlParser::doxygenXmlParser +( + const fileName& fName, + const string& startTag, + const string& searchStr, + const bool exactMatch +) +: + dictionary(dictionary::null) +{ + IFstream is(fName); + + char c; + + // skip forward to entry name + skipForward(is, startTag); + + while (is.get(c)) + { + if (c == '<') + { + // if in block, read block name + string blockName = ""; + string params = ""; + bool readingParam = false; + while (is.get(c) && c != '>') + { + if (c == ' ') + { + readingParam = true; + } + else + { + if (readingParam) + { + params = params + c; + } + else + { + blockName = blockName + c; + } + } + } + + if (blockName == '/' + startTag) + { + break; + } + + if ((blockName == "compound") && (params == "kind=\"file\"")) + { + // keep entry + word name = ""; + fileName path = ""; + word fName = ""; + bool foundName = false; + bool foundPath = false; + bool foundFName = false; + bool earlyExit = false; + while (!foundName || !foundPath || !foundFName) + { + word entryName; + getEntry(is, entryName); + if (entryName == "name") + { + getValue(is, name); + if (wordRe(".*.H", wordRe::DETECT).match(name)) + { + foundName = true; + } + else + { + // not interested in this compound + break; + } + } + else if (entryName == "path") + { + getValue(is, path); + + // filter path on regExp + if (wordRe(searchStr, wordRe::DETECT).match(path)) + { + foundPath = true; + } + else + { + // not interested in this compound + break; + } + } + else if (entryName == "filename") + { + getValue(is, fName); + foundFName = true; + } + else + { + skipBlock(is, entryName); + } + } + + if (foundPath && !earlyExit) + { + word tName(path.components().last()); + + // only insert if type is not already known + // NOTE: not ideal for cases where there are multiple types + // but contained within different namespaces + // preferentially take exact match if it exists + if (exactMatch && (tName + ".H") == name) + { + dictionary dict(dictionary::null); + dict.add("name", name); + dict.add("filename", fName + ".html"); + dict.add("path", path); + this->add(tName, dict); + } + else if + ( + !exactMatch + && !found(tName) + && wordRe(".*" + tName + ".*", wordRe::DETECT).match(name) + ) + { + dictionary dict(dictionary::null); + dict.add("name", name); + dict.add("filename", fName + ".html"); + dict.add("path", path); + this->add(tName, dict); + } + } + + // skip remanining entries + skipBlock(is, blockName); + } + else + { + skipBlock(is, blockName); + } + } + } +} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::doxygenXmlParser::skipBlock(IFstream& is, const word blockName) const +{ + // recurse to move forward in 'is' until come across + + string closeName = ""; + + // fast-forward until we reach a '<' + char c; + while (is.get(c) && c != '<') + {} + + // check to see if this is a closing block + if (is.get(c) && c == '/') + { + while (is.get(c) && c != '>') + { + closeName += c; + } + + if (closeName == blockName) + { + // finished reading block + return; + } + else + { + skipBlock(is, blockName); + } + } + else + { + skipBlock(is, blockName); + } +} + + +void Foam::doxygenXmlParser::skipForward(IFstream& is, const word blockName) const +{ + // recurse to move forward in 'is' until come across + + // fast-forward until we reach a '<' + char c; + while (is.get(c) && c != '<') + {} + + string entryName = ""; + while (is.get(c) && c != '>') + { + entryName = entryName + c; + } + + if (entryName == blockName) + { + return; + } + else + { + skipForward(is, blockName); + } +} + + +// ************************************************************************* // + diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H new file mode 100644 index 0000000000..1f7c14df96 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H @@ -0,0 +1,97 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +Class + Foam::doxygenXmlParser + +Description + +SourceFiles + +\*---------------------------------------------------------------------------*/ + +#ifndef doxygenXmlParser_H +#define doxygenXmlParser_H + +#include "dictionary.H" +#include "IFstream.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class doxygenXmlParser Declaration +\*---------------------------------------------------------------------------*/ + +class doxygenXmlParser +: + public dictionary +{ + +public: + + //- Construct from components + doxygenXmlParser + ( + const fileName& fName, + const string& startTag, + const string& searchStr, + const bool exactMatch + ); + + + // Member functions + + //- Skip past a block + void skipBlock(IFstream& is, const word blockName) const; + + //- Skip forward to block + void skipForward(IFstream& is, const word blockName) const; + + //- Return the entry + template + void getEntry(IFstream& is, Type& entry) const; + + //- Return the entry value + template + void getValue(IFstream& is, Type& entry) const; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "doxygenXmlParserTemplates.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C new file mode 100644 index 0000000000..73b540ff95 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C @@ -0,0 +1,67 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "doxygenXmlParser.H" + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +template +void Foam::doxygenXmlParser::getEntry(IFstream& is, Type& entry) const +{ + char c; + while (is.get(c) && c != '<') + {} + + entry = ""; + if (is.get(c) && c == '/') + { + return; + } + else + { + entry = entry + c; + } + + while (is.get(c) && c != '>') + { + entry = entry + c; + } +} + + +template +void Foam::doxygenXmlParser::getValue(IFstream& is, Type& entry) const +{ + char c; + + entry = ""; + while (is.get(c) && c != '<') + { + entry = entry + c; + } +} + + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C new file mode 100644 index 0000000000..bff7d2d99c --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -0,0 +1,148 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "helpType.H" +#include "doxygenXmlParser.H" +#include "SortableList.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + defineTypeNameAndDebug(helpType, 0); + defineRunTimeSelectionTable(helpType, dictionary); +} + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +void Foam::helpType::displayDoc +( + const word& className, + const string& searchStr, + const bool exactMatch +) const +{ + const dictionary& docDict = debug::controlDict().subDict("Documentation"); + List docDirs(docDict.lookup("doxyDocDirs")); + + label i = -1; + forAll(docDirs, dirI) + { + if (isDir(docDirs[dirI].expand())) + { + i = dirI; + break; + } + } + + if (i != -1) + { + Info<< "Found doxygen help in " << docDirs[i].c_str() << nl << endl; + + string docBrowser = getEnv("FOAM_DOC_BROWSER"); + if (docBrowser.empty()) + { + docDict.lookup("docBrowser") >> docBrowser; + } + + doxygenXmlParser parser + ( + docDirs[i]/"../DTAGS", + "tagfile", + searchStr, + exactMatch + ); + + if (debug) + { + Info<< parser; + } + + if (parser.found(className)) + { + fileName docFile + ( + docDirs[i]/parser.subDict(className).lookup("filename") + ); + + // can use FOAM_DOC_BROWSER='application file://%f' if required + docBrowser.replaceAll("%f", docFile); + + fileName classFolder(parser.subDict(className).lookup("path")); + word classFile(parser.subDict(className).lookup("name")); + + Info<< "Showing documentation for type " << className << nl << endl; + + Info<< "Source file: " << classFolder.c_str() << classFile << nl + << endl; + + system(docBrowser); + } + else + { + FatalErrorIn + ( + "void Foam::helpType::displayDoc(const word, const string)" + ) + << "No help for type " << className << " found." + << " Valid options include:" + << SortableList(parser.toc()) + << exit(FatalError); + } + } + else + { + Info<< "No Doxygen sources found under search paths: " + << docDirs << endl; + } +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::helpType::helpType() +{} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::helpType::~helpType() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::helpType::init() +{ + argList::addOption + ( + "browse", + "word", + "display documentation for boundary condition in browser" + ); +} + + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H new file mode 100644 index 0000000000..8c4e03c6e8 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H @@ -0,0 +1,115 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +Class + Foam::helpType + +Description + Base class for foam help classes + +SourceFiles + helpType.C + helpTypeNew.C + +\*---------------------------------------------------------------------------*/ + +#ifndef helpType_H +#define helpType_H + +#include "runTimeSelectionTables.H" +#include "autoPtr.H" +#include "argList.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +// forward declaration of classes + +class fvMesh; + +/*---------------------------------------------------------------------------*\ + Class helpType Declaration +\*---------------------------------------------------------------------------*/ + +class helpType +{ + +protected: + + //- Display the help documentation in a browser + void displayDoc + ( + const word& className, + const string& searchStr, + const bool exactMatch + ) const; + + +public: + + //- Runtime type information + TypeName("helpType"); + + // Declare runtime constructor selection table + declareRunTimeSelectionTable + ( + autoPtr, + helpType, + dictionary, + (), + () + ); + + + //- Constructor + helpType(); + + //- Selector + static autoPtr New(const word& helpTypeName); + + //- Destructor + virtual ~helpType(); + + + // Member Functions + + //- Initialise - typically setting static variables, + // e.g. command line arguments + virtual void init(); + + //- Execute the help + virtual void execute(const argList& args, const fvMesh& mesh) = 0; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C new file mode 100644 index 0000000000..72cd01437a --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C @@ -0,0 +1,65 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "helpType.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +Foam::autoPtr Foam::helpType::New +( + const word& helpTypeName +) +{ + Info<< "Selecting helpType " << helpTypeName << endl; + + dictionaryConstructorTable::iterator cstrIter = + dictionaryConstructorTablePtr_->find(helpTypeName); + + if (cstrIter == dictionaryConstructorTablePtr_->end()) + { + // special treatment for -help + // exit without stack trace + if (helpTypeName == "-help") + { + FatalErrorIn("helpType::New()") + << "Valid helpType selections are:" << nl + << dictionaryConstructorTablePtr_->sortedToc() << nl + << exit(FatalError); + } + else + { + FatalErrorIn("helpType::New()") + << "Unknown helpType type " << helpTypeName << nl + << "Valid helpType selections are:" << nl + << dictionaryConstructorTablePtr_->sortedToc() << nl + << abort(FatalError); + } + } + + return autoPtr(cstrIter()()); +} + + +// ************************************************************************* // From 867575c855566f2cedafdd4a5bc3fb909b46c37e Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:37:28 +0100 Subject: [PATCH 073/109] ENH: Added new foamHelp utility --- .../miscellaneous/foamHelp/foamHelp.C | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 applications/utilities/miscellaneous/foamHelp/foamHelp.C diff --git a/applications/utilities/miscellaneous/foamHelp/foamHelp.C b/applications/utilities/miscellaneous/foamHelp/foamHelp.C new file mode 100644 index 0000000000..e10578647b --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/foamHelp.C @@ -0,0 +1,68 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +Application + foamHelp + +Description + Top level wrapper utility around foam help utilities + +\*---------------------------------------------------------------------------*/ + +#include "fvCFD.H" +#include "helpType.H" + +using namespace Foam; + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +int main(int argc, char *argv[]) +{ + #include "addRegionOption.H" + if (argc < 2) + { + FatalError + << "No help utility has been supplied" << nl + << exit(FatalError); + } + + const word utilityName = argv[1]; + + Foam::autoPtr utility + ( + helpType::New(utilityName) + ); + + utility().init(); + + #include "setRootCase.H" + #include "createTime.H" + #include "createNamedMesh.H" + + utility().execute(args, mesh); + + Info<< "End\n" << endl; +} + + +// ************************************************************************* // From 5f6f5e4364fc0dcaae71d4891a917dc5dc4476c0 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:38:05 +0100 Subject: [PATCH 074/109] ENH: Added help utility for buondary conditions --- .../helpTypes/helpBoundary/helpBoundary.C | 185 ++++++++++++++++++ .../helpTypes/helpBoundary/helpBoundary.H | 109 +++++++++++ .../helpBoundary/helpBoundaryTemplates.C | 160 +++++++++++++++ 3 files changed, 454 insertions(+) create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C new file mode 100644 index 0000000000..3d1c995018 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C @@ -0,0 +1,185 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "helpBoundary.H" +#include "addToRunTimeSelectionTable.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + namespace helpTypes + { + defineTypeNameAndDebug(helpBoundary, 0); + addNamedToRunTimeSelectionTable + ( + helpType, + helpBoundary, + dictionary, + boundary + ); + } +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::helpTypes::helpBoundary::helpBoundary() +{} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::helpTypes::helpBoundary::~helpBoundary() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::helpTypes::helpBoundary::init() +{ + helpType::init(); + + argList::validArgs.append("boundary"); + + argList::addOption + ( + "field", + "word", + "list available conditions for field" + ); + argList::addBoolOption + ( + "constraint", + "list constraint patches" + ); + argList::addBoolOption + ( + "fixedValue", + "list fixed value patches (use with -field option)" + ); +} + + +void Foam::helpTypes::helpBoundary::execute +( + const argList& args, + const fvMesh& mesh +) +{ + bool abortVar(env("FOAM_ABORT")); + if (abortVar) + { + FatalErrorIn + ( + "void Foam::helpTypes::helpBoundary::execute" + "(" + "const argList&, " + "const fvMesh&" + ")" + ) + << "Please unset FOAM_ABORT to use this utlity" + << exit(FatalError); + } + + word condition(word::null); + word fieldName(word::null); + + if (args.optionReadIfPresent("browse", condition)) + { + // TODO: strip scoping info if present? + // e.g. conditions with leading "compressible::" will not be found + // ".*[fF]vPatchField.*" + className + ".*" + displayDoc(condition, ".*[fF]vPatchField.*", false); + } + else if (args.optionFound("constraint")) + { + HashSet constraintTypes(fvPatch::constraintTypes()); + Info<< "Constraint types:" << nl; + forAllConstIter(HashSet, constraintTypes, iter) + { + Info<< " " << iter.key() << nl; + } + Info<< endl; + } + else if (args.optionReadIfPresent("field", fieldName)) + { + IOobject fieldHeader + ( + fieldName, + mesh.time().timeName(), + mesh, + IOobject::MUST_READ + ); + + if (fieldHeader.headerOk()) + { + if (args.optionFound("fixedValue")) + { + fixedValueFieldConditions(fieldHeader); + fixedValueFieldConditions(fieldHeader); + fixedValueFieldConditions(fieldHeader); + fixedValueFieldConditions(fieldHeader); + fixedValueFieldConditions(fieldHeader); + } + else + { + (void)fieldConditions(fieldHeader, true); + (void)fieldConditions(fieldHeader, true); + (void)fieldConditions(fieldHeader, true); + (void)fieldConditions(fieldHeader, true); + (void)fieldConditions(fieldHeader, true); + } + } + else + { + FatalErrorIn + ( + "void Foam::helpTypes::helpBoundary::execute" + "(" + "const argList&, " + "const fvMesh&" + ")" + ) + << "Unable to read field " << fieldName << exit(FatalError); + } + } + else if (args.optionReadIfPresent("fixedValue", fieldName)) + { + FatalErrorIn + ( + "void Foam::helpTypes::helpBoundary::execute" + "(" + "const argList&, " + "const fvMesh&" + ")" + ) + << "-field option must be specified when using the -fixedValue " + << "option" << exit(FatalError); + } +} + + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H new file mode 100644 index 0000000000..515425b7bc --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H @@ -0,0 +1,109 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +Class + Foam::helpBoundary + +Description + + +SourceFiles + helpBoundary.C + helpBoundaryTemplates.C + +\*---------------------------------------------------------------------------*/ + +#ifndef helpBoundary_H +#define helpBoundary_H + +#include "helpType.H" +#include "IOobject.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace helpTypes +{ + +/*---------------------------------------------------------------------------*\ + Class helpBoundary Declaration +\*---------------------------------------------------------------------------*/ + +class helpBoundary +: + public helpType +{ + +protected: + + // Protected Member Functions + + //- Return/output the available boundary conditions for fields of Type + template + wordList fieldConditions(const IOobject& io, const bool write) const; + + //- Output the available fixed boundary conditions for fields of Type + template + void fixedValueFieldConditions(const IOobject& io) const; + + +public: + + //- Runtime type information + TypeName("helpBoundary"); + + //- Constructor + helpBoundary(); + + //- Destructor + virtual ~helpBoundary(); + + + // Member Functions + + //- Initialise - typically setting static variables, + // e.g. command line arguments + virtual void init(); + + //- Execute the help + virtual void execute(const argList& args, const fvMesh& mesh); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace helpTypes +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "helpBoundaryTemplates.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C new file mode 100644 index 0000000000..d9ee2c92f1 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C @@ -0,0 +1,160 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + + +\*---------------------------------------------------------------------------*/ + +#include "GeometricField.H" +#include "fvPatchField.H" +#include "volMesh.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +template +Foam::wordList Foam::helpTypes::helpBoundary::fieldConditions +( + const IOobject& io, + const bool write +) const +{ + typedef GeometricField fieldType; + + if (io.headerClassName() == fieldType::typeName) + { + wordList types + ( + fvPatchField::dictionaryConstructorTablePtr_->sortedToc() + ); + + if (write) + { + Info<< "Available boundary conditions for " + << pTraits::typeName << " field: " << io.name() << nl; + + forAll(types, i) + { + Info<< " " << types[i] << nl; + } + + Info<< endl; + } + + return types; + } + + return wordList(); +} + + +template +void Foam::helpTypes::helpBoundary::fixedValueFieldConditions +( + const IOobject& io +) const +{ + wordList types(fieldConditions(io, false)); + + if (!types.size()) + { + return; + } + + typedef GeometricField fieldType; + + const fvMesh& mesh = dynamic_cast(io.db()); + + fieldType fld + ( + IOobject + ( + "dummy", + mesh.time().timeName(), + mesh, + IOobject::NO_READ, + IOobject::NO_WRITE, + false + ), + mesh, + dimensioned("zero", dimless, pTraits::zero) + ); + + + Info<< "Fixed value boundary conditions for " + << pTraits::typeName << " field: " << io.name() << nl; + + // throw exceptions to avoid fatal errors when casting from generic patch + // type to incompatible patch type + FatalIOError.throwExceptions(); + FatalError.throwExceptions(); + + bool foundFixed = false; + forAll(types, i) + { + const word& patchType = types[i]; + + try + { + polyPatch pp + ( + "defaultFaces", + 0, + mesh.nInternalFaces(), + 0, + mesh.boundaryMesh() + ); + + fvPatch fvp(pp, mesh.boundary()); + + tmp > pf + ( + fvPatchField::New + ( + patchType, + fvp, + fld + ) + ); + + if (pf().fixesValue()) + { + Info<< " " << patchType << nl; + foundFixed = true; + } + } + catch (...) + { + // do nothing + } + } + + if (!foundFixed) + { + // no conditions??? + Info<< " none" << nl; + } + + Info<< endl; +} + + +// ************************************************************************* // From c69d3448648465baec727ffe96eb5da326521fc8 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:38:19 +0100 Subject: [PATCH 075/109] ENH: Added help utility for function objects --- .../helpFunctionObject/helpFunctionObject.C | 84 ++++++++++++++++++ .../helpFunctionObject/helpFunctionObject.H | 88 +++++++++++++++++++ 2 files changed, 172 insertions(+) create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C new file mode 100644 index 0000000000..626a1a2e7b --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C @@ -0,0 +1,84 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +\*---------------------------------------------------------------------------*/ + +#include "helpFunctionObject.H" +#include "addToRunTimeSelectionTable.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + namespace helpTypes + { + defineTypeNameAndDebug(helpFunctionObject, 0); + addNamedToRunTimeSelectionTable + ( + helpType, + helpFunctionObject, + dictionary, + functionObject + ); + } +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::helpTypes::helpFunctionObject::helpFunctionObject() +{} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::helpTypes::helpFunctionObject::~helpFunctionObject() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::helpTypes::helpFunctionObject::init() +{ + helpType::init(); + + argList::validArgs.append("functionObject"); +} + + +void Foam::helpTypes::helpFunctionObject::execute +( + const argList& args, + const fvMesh& mesh +) +{ + word function(word::null); + + if (args.optionReadIfPresent("browse", function)) + { + displayDoc(function, ".*[fF]unctionObject.*", true); + } +} + + +// ************************************************************************* // diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H new file mode 100644 index 0000000000..f122a8f312 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H @@ -0,0 +1,88 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\/ 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 . + +Class + Foam::helpFunctionObject + +Description + + +SourceFiles + helpFunctionObject.C + +\*---------------------------------------------------------------------------*/ + +#ifndef helpFunctionObject_H +#define helpFunctionObject_H + +#include "helpType.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace helpTypes +{ + +/*---------------------------------------------------------------------------*\ + Class helpFunctionObject Declaration +\*---------------------------------------------------------------------------*/ + +class helpFunctionObject +: + public helpType +{ + +public: + + //- Runtime type information + TypeName("helpFunctionObject"); + + //- Constructor + helpFunctionObject(); + + //- Destructor + virtual ~helpFunctionObject(); + + + // Member Functions + + //- Initialise - typically setting static variables, + // e.g. command line arguments + virtual void init(); + + //- Execute the help + virtual void execute(const argList& args, const fvMesh& mesh); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace helpTypes +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // From df91d1349fa628e577e25657fe15d149ca8ec179 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:39:07 +0100 Subject: [PATCH 076/109] ENH: Added missing Make files/options --- .../utilities/miscellaneous/foamHelp/Allwmake | 8 ++++++++ .../utilities/miscellaneous/foamHelp/Make/files | 3 +++ .../utilities/miscellaneous/foamHelp/Make/options | 15 +++++++++++++++ .../miscellaneous/foamHelp/helpTypes/Make/files | 8 ++++++++ .../miscellaneous/foamHelp/helpTypes/Make/options | 13 +++++++++++++ 5 files changed, 47 insertions(+) create mode 100755 applications/utilities/miscellaneous/foamHelp/Allwmake create mode 100644 applications/utilities/miscellaneous/foamHelp/Make/files create mode 100644 applications/utilities/miscellaneous/foamHelp/Make/options create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/Make/files create mode 100644 applications/utilities/miscellaneous/foamHelp/helpTypes/Make/options diff --git a/applications/utilities/miscellaneous/foamHelp/Allwmake b/applications/utilities/miscellaneous/foamHelp/Allwmake new file mode 100755 index 0000000000..4724935b92 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/Allwmake @@ -0,0 +1,8 @@ +#!/bin/sh +cd ${0%/*} || exit 1 # run from this directory + +wmake libso helpTypes +wmake + + +# ----------------------------------------------------------------- end-of-file diff --git a/applications/utilities/miscellaneous/foamHelp/Make/files b/applications/utilities/miscellaneous/foamHelp/Make/files new file mode 100644 index 0000000000..263901fe72 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/Make/files @@ -0,0 +1,3 @@ +foamHelp.C + +EXE = $(FOAM_APPBIN)/foamHelp diff --git a/applications/utilities/miscellaneous/foamHelp/Make/options b/applications/utilities/miscellaneous/foamHelp/Make/options new file mode 100644 index 0000000000..031de3d566 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/Make/options @@ -0,0 +1,15 @@ +EXE_INC = \ + -IhelpTypes/lnInclude \ + -I$(LIB_SRC)/finiteVolume/lnInclude + +EXE_LIBS = \ + -lhelpTypes \ + -lfiniteVolume \ + -lincompressibleTurbulenceModel \ + -lcompressibleTurbulenceModel \ + -lincompressibleRASModels \ + -lcompressibleRASModels \ + -lincompressibleLESModels \ + -lcompressibleLESModels \ + -lradiationModels \ + -lbasicThermophysicalModels diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/files b/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/files new file mode 100644 index 0000000000..1f7de8d62e --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/files @@ -0,0 +1,8 @@ +helpType/helpType.C +helpType/helpTypeNew.C +helpBoundary/helpBoundary.C +helpFunctionObject/helpFunctionObject.C + +doxygenXmlParser/doxygenXmlParser.C + +LIB = $(FOAM_LIBBIN)/libhelpTypes diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/options b/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/options new file mode 100644 index 0000000000..1c130c5eb1 --- /dev/null +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/Make/options @@ -0,0 +1,13 @@ +EXE_INC = \ + -I$(LIB_SRC)/finiteVolume/lnInclude + +EXE_LIBS = \ + -lfiniteVolume \ + -lincompressibleTurbulenceModel \ + -lcompressibleTurbulenceModel \ + -lincompressibleRASModels \ + -lcompressibleRASModels \ + -lincompressibleLESModels \ + -lcompressibleLESModels \ + -lradiationModels \ + -lbasicThermophysicalModels From 0c081688ee5e27256fc93b1e8333607ceeb89351 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 14:50:13 +0100 Subject: [PATCH 077/109] ENH: Added displayDocOptions for default behaviour when no arg specified --- .../helpTypes/helpBoundary/helpBoundary.C | 7 +++ .../helpFunctionObject/helpFunctionObject.C | 4 ++ .../foamHelp/helpTypes/helpType/helpType.C | 47 +++++++++++++++++++ .../foamHelp/helpTypes/helpType/helpType.H | 7 +++ 4 files changed, 65 insertions(+) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C index 3d1c995018..a6867ebc22 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C @@ -179,6 +179,13 @@ void Foam::helpTypes::helpBoundary::execute << "-field option must be specified when using the -fixedValue " << "option" << exit(FatalError); } + else + { + // TODO: strip scoping info if present? + // e.g. conditions with leading "compressible::" will not be found + // ".*[fF]vPatchField.*" + className + ".*" + displayDocOptions(".*[fF]vPatchField.*", false); + } } diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C index 626a1a2e7b..0d6c1b1c1e 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C @@ -78,6 +78,10 @@ void Foam::helpTypes::helpFunctionObject::execute { displayDoc(function, ".*[fF]unctionObject.*", true); } + else + { + displayDocOptions(".*[fF]unctionObject.*", true); + } } diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C index bff7d2d99c..1443089aa7 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -37,6 +37,53 @@ namespace Foam // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // +void Foam::helpType::displayDocOptions +( + const string& searchStr, + const bool exactMatch +) const +{ + const dictionary& docDict = debug::controlDict().subDict("Documentation"); + List docDirs(docDict.lookup("doxyDocDirs")); + + label i = -1; + forAll(docDirs, dirI) + { + if (isDir(docDirs[dirI].expand())) + { + i = dirI; + break; + } + } + + if (i != -1) + { + Info<< "Found doxygen help in " << docDirs[i].c_str() << nl << endl; + + string docBrowser = getEnv("FOAM_DOC_BROWSER"); + if (docBrowser.empty()) + { + docDict.lookup("docBrowser") >> docBrowser; + } + + doxygenXmlParser parser + ( + docDirs[i]/"../DTAGS", + "tagfile", + searchStr, + exactMatch + ); + + Info<< "Valid types include:" << nl << SortableList(parser.toc()); + } + else + { + Info<< "No Doxygen sources found under search paths: " + << docDirs << endl; + } +} + + void Foam::helpType::displayDoc ( const word& className, diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H index 8c4e03c6e8..d1ccf14c62 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H @@ -58,6 +58,13 @@ class helpType protected: + //- Display the list of documentation options + void displayDocOptions + ( + const string& searchStr, + const bool exactMatch + ) const; + //- Display the help documentation in a browser void displayDoc ( From 20d9399d7f495bb4bec1c854cdc8f03f241e0ac2 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 15:00:36 +0100 Subject: [PATCH 078/109] ENH: encapsulated retrival of path to doxygen documentation --- .../foamHelp/helpTypes/helpType/helpType.C | 84 ++++++++----------- .../foamHelp/helpTypes/helpType/helpType.H | 3 + 2 files changed, 40 insertions(+), 47 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C index 1443089aa7..ed356b93cb 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -37,38 +37,47 @@ namespace Foam // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // +Foam::fileName Foam::helpType::doxygenPath() const +{ + const dictionary& docDict = debug::controlDict().subDict("Documentation"); + List docDirs(docDict.lookup("doxyDocDirs")); + + label dirI = -1; + forAll(docDirs, i) + { + if (isDir(docDirs[i].expand())) + { + dirI = i; + break; + } + } + + if (dirI == -1) + { + Info<< "No Doxygen sources found under search paths: " + << docDirs << endl; + return fileName(); + } + + return docDirs[dirI]; +} + + void Foam::helpType::displayDocOptions ( const string& searchStr, const bool exactMatch ) const { - const dictionary& docDict = debug::controlDict().subDict("Documentation"); - List docDirs(docDict.lookup("doxyDocDirs")); + fileName doxyPath(doxygenPath()); - label i = -1; - forAll(docDirs, dirI) + if (!doxyPath.empty()) { - if (isDir(docDirs[dirI].expand())) - { - i = dirI; - break; - } - } - - if (i != -1) - { - Info<< "Found doxygen help in " << docDirs[i].c_str() << nl << endl; - - string docBrowser = getEnv("FOAM_DOC_BROWSER"); - if (docBrowser.empty()) - { - docDict.lookup("docBrowser") >> docBrowser; - } + Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; doxygenXmlParser parser ( - docDirs[i]/"../DTAGS", + doxyPath/"../DTAGS", "tagfile", searchStr, exactMatch @@ -76,11 +85,6 @@ void Foam::helpType::displayDocOptions Info<< "Valid types include:" << nl << SortableList(parser.toc()); } - else - { - Info<< "No Doxygen sources found under search paths: " - << docDirs << endl; - } } @@ -91,32 +95,23 @@ void Foam::helpType::displayDoc const bool exactMatch ) const { - const dictionary& docDict = debug::controlDict().subDict("Documentation"); - List docDirs(docDict.lookup("doxyDocDirs")); + fileName doxyPath(doxygenPath()); - label i = -1; - forAll(docDirs, dirI) + if (!doxyPath.empty()) { - if (isDir(docDirs[dirI].expand())) - { - i = dirI; - break; - } - } - - if (i != -1) - { - Info<< "Found doxygen help in " << docDirs[i].c_str() << nl << endl; + Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; string docBrowser = getEnv("FOAM_DOC_BROWSER"); if (docBrowser.empty()) { + const dictionary& docDict = + debug::controlDict().subDict("Documentation"); docDict.lookup("docBrowser") >> docBrowser; } doxygenXmlParser parser ( - docDirs[i]/"../DTAGS", + doxyPath/"../DTAGS", "tagfile", searchStr, exactMatch @@ -131,7 +126,7 @@ void Foam::helpType::displayDoc { fileName docFile ( - docDirs[i]/parser.subDict(className).lookup("filename") + doxyPath/parser.subDict(className).lookup("filename") ); // can use FOAM_DOC_BROWSER='application file://%f' if required @@ -159,11 +154,6 @@ void Foam::helpType::displayDoc << exit(FatalError); } } - else - { - Info<< "No Doxygen sources found under search paths: " - << docDirs << endl; - } } diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H index d1ccf14c62..3ce63ad713 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H @@ -58,6 +58,9 @@ class helpType protected: + //- Return file path to the Doxygen sources (if available) + fileName doxygenPath() const; + //- Display the list of documentation options void displayDocOptions ( From 48cf4e6715a3ae64ca17d36dde7bb367a435fc4c Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 15:46:49 +0100 Subject: [PATCH 079/109] STYLE: foamHelp helpType clean-up --- .../foamHelp/helpTypes/helpType/helpType.C | 128 +++++++++--------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C index ed356b93cb..9391e753e6 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -71,20 +71,22 @@ void Foam::helpType::displayDocOptions { fileName doxyPath(doxygenPath()); - if (!doxyPath.empty()) + if (doxyPath.empty()) { - Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; - - doxygenXmlParser parser - ( - doxyPath/"../DTAGS", - "tagfile", - searchStr, - exactMatch - ); - - Info<< "Valid types include:" << nl << SortableList(parser.toc()); + return; } + + Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; + + doxygenXmlParser parser + ( + doxyPath/"../DTAGS", + "tagfile", + searchStr, + exactMatch + ); + + Info<< "Valid types include:" << nl << SortableList(parser.toc()); } @@ -97,62 +99,60 @@ void Foam::helpType::displayDoc { fileName doxyPath(doxygenPath()); - if (!doxyPath.empty()) + if (doxyPath.empty()) { - Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; + return; + } - string docBrowser = getEnv("FOAM_DOC_BROWSER"); - if (docBrowser.empty()) - { - const dictionary& docDict = - debug::controlDict().subDict("Documentation"); - docDict.lookup("docBrowser") >> docBrowser; - } + Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl; - doxygenXmlParser parser + string docBrowser = getEnv("FOAM_DOC_BROWSER"); + if (docBrowser.empty()) + { + const dictionary& docDict = + debug::controlDict().subDict("Documentation"); + docDict.lookup("docBrowser") >> docBrowser; + } + + doxygenXmlParser parser + ( + doxyPath/"../DTAGS", + "tagfile", + searchStr, + exactMatch + ); + + if (debug) + { + Info<< parser; + } + + if (parser.found(className)) + { + fileName docFile(doxyPath/parser.subDict(className).lookup("filename")); + + // can use FOAM_DOC_BROWSER='application file://%f' if required + docBrowser.replaceAll("%f", docFile); + + fileName classFolder(parser.subDict(className).lookup("path")); + word classFile(parser.subDict(className).lookup("name")); + + Info<< "Showing documentation for type " << className << nl << endl; + + Info<< "Source file: " << classFolder.c_str() << classFile << nl + << endl; + + system(docBrowser); + } + else + { + FatalErrorIn ( - doxyPath/"../DTAGS", - "tagfile", - searchStr, - exactMatch - ); - - if (debug) - { - Info<< parser; - } - - if (parser.found(className)) - { - fileName docFile - ( - doxyPath/parser.subDict(className).lookup("filename") - ); - - // can use FOAM_DOC_BROWSER='application file://%f' if required - docBrowser.replaceAll("%f", docFile); - - fileName classFolder(parser.subDict(className).lookup("path")); - word classFile(parser.subDict(className).lookup("name")); - - Info<< "Showing documentation for type " << className << nl << endl; - - Info<< "Source file: " << classFolder.c_str() << classFile << nl - << endl; - - system(docBrowser); - } - else - { - FatalErrorIn - ( - "void Foam::helpType::displayDoc(const word, const string)" - ) - << "No help for type " << className << " found." - << " Valid options include:" - << SortableList(parser.toc()) - << exit(FatalError); - } + "void Foam::helpType::displayDoc(const word, const string)" + ) + << "No help for type " << className << " found." + << " Valid options include:" << SortableList(parser.toc()) + << exit(FatalError); } } From 8026866012de9453168deba9f3674e97c5b23339 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 15:58:41 +0100 Subject: [PATCH 080/109] ENH: Added documentation for boundary and function object helper utilities --- .../helpTypes/helpBoundary/helpBoundary.H | 19 ++++++++++++++++++- .../helpFunctionObject/helpFunctionObject.H | 12 +++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H index 515425b7bc..17d77223c5 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H @@ -25,7 +25,24 @@ Class Foam::helpBoundary Description - + This class provides help for boundary conditions (patch fields). When no + additional arguments are given, the utility outputs all known boundary + conditions. + + Usage: + \plaintable + \c -browse \ | open documentation for patch in browser + \c -field \ | boundary conditions for a given field + \c -constraint | list constraint boundary conditions + \c -fixedValue | list \c fixedValue type boundary conditions + \endplaintable + +Note + To use the \c -fixedValue option, the \c -field option should also be used + +SeeAlso + Foam::helkpType + Foam::fvPatchField SourceFiles helpBoundary.C diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H index f122a8f312..257335467f 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H @@ -25,7 +25,17 @@ Class Foam::helpFunctionObject Description - + This class provides help for functionObjects. When no additional arguments + are given, the utility outputs all known function objects. + + Usage: + \plaintable + \c -browse \ | open documentation for object in browser + \endplaintable + +SeeAlso + Foam::helpType + Foam::functionObject SourceFiles helpFunctionObject.C From 35936a4f899428803b9e88057f702c6ae8165fe9 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 16 Aug 2012 17:26:16 +0100 Subject: [PATCH 081/109] STYLE: corrected spelling mistake --- .../foamHelp/helpTypes/helpBoundary/helpBoundary.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H index 17d77223c5..4add931c18 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H @@ -41,7 +41,7 @@ Note To use the \c -fixedValue option, the \c -field option should also be used SeeAlso - Foam::helkpType + Foam::helpType Foam::fvPatchField SourceFiles From aec98e58c292bed69eeb401a1c61d0a6ecae67f8 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 20 Aug 2012 12:23:38 +0100 Subject: [PATCH 082/109] STYLE: updated error message --- .../functionObjects/systemCall/systemCall.C | 34 +++++++------------ 1 file changed, 13 insertions(+), 21 deletions(-) diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.C b/src/postProcessing/functionObjects/systemCall/systemCall.C index 90a5c20257..299c792aab 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.C +++ b/src/postProcessing/functionObjects/systemCall/systemCall.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -73,26 +73,18 @@ void Foam::systemCall::read(const dictionary& dict) } else if (!dynamicCode::allowSystemOperations) { - FatalErrorIn - ( - "systemCall::read(const dictionary&)" - ) << "Executing user-supplied system calls is not" - << " enabled by default" << endl - << "because of security issues. If you trust the case you can" - << " enable this" << endl - << "facility be adding to the InfoSwitches setting in the system" - << " controlDict:" << endl - << endl - << " allowSystemOperations 1" << endl - << endl - << "The system controlDict is either" << endl - << endl - << " ~/.OpenFOAM/$WM_PROJECT_VERSION/controlDict" << endl - << endl - << "or" << endl - << endl - << " $WM_PROJECT_DIR/etc/controlDict" << endl - << endl + FatalErrorIn("systemCall::read(const dictionary&)") + << "Executing user-supplied system calls is not enabled by " + << "default because of " << nl + << "security issues. If you trust the case you can enable this " + << "facility by " << nl + << "adding to the InfoSwitches setting in the system controlDict:" + << nl << nl + << " allowSystemOperations 1" << nl << nl + << "The system controlDict is either" << nl << nl + << " ~/.OpenFOAM/$WM_PROJECT_VERSION/controlDict" << nl << nl + << "or" << nl << nl + << " $WM_PROJECT_DIR/etc/controlDict" << nl << nl << exit(FatalError); } } From 7a6880ad14af5b7d838bd07fb801dc687d58482a Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 20 Aug 2012 12:24:08 +0100 Subject: [PATCH 083/109] STYLE: Removed unused comment delimiters --- .../utilities/codedFunctionObject/codedFunctionObject.C | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C index 81cb1d9b23..0248190cde 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C @@ -47,9 +47,6 @@ namespace Foam ); } -// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * // - - // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // void Foam::codedFunctionObject::prepare From 77189860de5b25eed93c3756bd0051a6a69e070f Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 20 Aug 2012 12:24:40 +0100 Subject: [PATCH 084/109] ENH: Updated function object documentation --- .../IO/partialWrite/partialWrite.H | 31 +++++++++-- .../removeRegisteredObject.H | 24 ++++++++- .../writeRegisteredObject.H | 25 ++++++++- .../functionObjects/doc/functionObjects.dox | 7 +-- .../functionObjects/forces/forces/forces.H | 1 - .../functionObjects/systemCall/systemCall.H | 52 ++++++++++++++++++- .../codedFunctionObject/codedFunctionObject.H | 10 +++- 7 files changed, 136 insertions(+), 14 deletions(-) diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index 1d8d005f6c..a5165aaf51 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -28,10 +28,33 @@ Group grpIOFunctionObjects Description - Allows some fields/registered objects to be written more often than others. + This function object allows user-selected fields/registered objects to be + written at a custom write interval. It operates by deleting all entries + except those selected after writing. - Works in the opposite way: deletes at intermediate times all - but selected fields. + Example of function object specification: + \verbatim + partialWrite1 + { + type partialWrite; + functionObjectLibs ("libIOFunctionObjects.so"); + ... + objectNames (p U T); + writeInterval 100; + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: partialWrite | yes | + objectNames | objects to write | yes | + writeInterval | write interval | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles partialWrite.C @@ -58,7 +81,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class partialWrite Declaration + Class partialWrite Declaration \*---------------------------------------------------------------------------*/ class partialWrite diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index edd4e16bca..b25925c3c1 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -28,7 +28,29 @@ Group grpIOFunctionObjects Description - Removes registered IO objects if present in the database + This function object removes registered objects if present in the database + + Example of function object specification: + \verbatim + removeRegisteredObject1 + { + type removeRegisteredObject; + functionObjectLibs ("libIOFunctionObjects.so"); + ... + objectNames (obj1 obj2); + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: removeRegisteredObject | yes | + objectNames | objects to remove | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles removeRegisteredObject.C diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index 01d2c29037..7dbdb4bd25 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -28,7 +28,30 @@ Group grpIOFunctionObjects Description - Takes over the writing of registered IO objects + This function object takes-over the writing of objects registered to the + database. + + Example of function object specification: + \verbatim + writeRegisteredObject1 + { + type writeRegisteredObject; + functionObjectLibs ("libIOFunctionObjects.so"); + ... + objectNames (obj1 obj2); + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: writeRegisteredObject | yes | + objectNames | objects to write | yes | + \endtable + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles writeRegisteredObject.C diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox index b3ea86de52..098b7ae12d 100644 --- a/src/postProcessing/functionObjects/doc/functionObjects.dox +++ b/src/postProcessing/functionObjects/doc/functionObjects.dox @@ -34,7 +34,7 @@ extract predicted field and derived quantities at run-time. Alternatively, the actions can be executed afterwards using the \c execFlowFunctionObjects utility. -
    +\linebreak The current range of features comprises of: - \ref grpCloudFunctionObjects - \ref grpFieldFunctionObjects @@ -43,12 +43,13 @@ The current range of features comprises of: - \ref grpJobControlFunctionObjects - \ref grpUtilitiesFunctionObjects -
    +\linebreak \subsection secFieldFunctionObjectUsage Using function objects Function objects are defined by additional entries in the $FOAM_CASE/system/controlDict input dictionary. Each object is listed in a -\c functions sub-dictionary entry, e.g. for `output' type objects: +\c functions sub-dictionary entry, e.g. the following shows the input options +applicable to `output' -type objects: \verbatim functions diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index 4875da5c4f..3b04128494 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -43,7 +43,6 @@ Description ... log yes; patches (walls); - } \endverbatim diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index bb26a7e1b9..ad82219bce 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -28,7 +28,55 @@ Group grpFunctionObjects Description - Executes system calls, entered in the form of a string list + This function object executes system calls, entered in the form of a + string lists. Calls can be made at the following points in the + calculation: + - every time step + - every output time + - end of the calculation + + Example of function object specification: + \verbatim + systemCall1 + { + type systemCall; + functionObjectLibs ("libsystemCall.so"); + ... + executeCalls + ( + "echo execute" + ); + writeCalls + ( + "echo \*\*\* writing data \*\*\*" + ); + endCalls + ( + "echo \*\*\* writing .bashrc \*\*\*" + "cat ~/.bashrc" + "echo \*\*\* done \*\*\*" + ); + } + \endverbatim + + \heading Function object usage + \table + Property | Description | Required | Default value + type | type name: systemCall | yes | + executeCalls | list of calls on execute | yes | + writeCalls | list of calls on write | yes | + endCalls | list of calls on end | yes | + \endtable + +Note + Since this function object executes system calls, there is a potential + security risk. In order to use the \c systemCall function object, the + \c allowSystemOperations must be set to '1'; otherwise, system calls will + not be allowed. + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject SourceFiles systemCall.C @@ -53,7 +101,7 @@ class dictionary; class mapPolyMesh; /*---------------------------------------------------------------------------*\ - Class systemCall Declaration + Class systemCall Declaration \*---------------------------------------------------------------------------*/ class systemCall diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 4a99468d09..a9c6818f77 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -28,7 +28,13 @@ Group grpUtilitiesFunctionObjects Description - functionObject using dynamic code compilation. + This function object provides a general interface to enable dynamic code + compilation. + +SeeAlso + Foam::functionObject + Foam::OutputFilterFunctionObject + Foam::codedBase SourceFiles codedFunctionObject.C @@ -47,7 +53,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class codedFunctionObject Declaration + Class codedFunctionObject Declaration \*---------------------------------------------------------------------------*/ class codedFunctionObject From 5dc4387ab0e5f821ebcfc0583c79f446c4cc1812 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 17 Sep 2012 12:04:11 +0100 Subject: [PATCH 085/109] ENH: removed unused p0 entry --- .../uniformTotalPressureFvPatchScalarField.H | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 25fdabfc1d..b5888fdf86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -40,7 +40,6 @@ Description rho | density field name | no | none psi | compressibility field name | no | none gamma | ratio of specific heats (Cp/Cv) | yes | - p0 | static pressure reference | yes | pressure | total pressure as a function of time | yes | \endtable @@ -54,8 +53,7 @@ Description rho rho; psi psi; gamma 1.4; - p0 uniform 1e5; - pressure uniform 0.0; + pressure uniform 1e5; } \endverbatim From cedc50857509c9209ef4377ac0fc42a2ff3f0cfb Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 19 Sep 2012 16:35:36 +0100 Subject: [PATCH 086/109] ENH: Updated copyright to OpenFOAM Foundation --- applications/utilities/miscellaneous/foamHelp/foamHelp.C | 2 +- .../foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C | 2 +- .../foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H | 2 +- .../helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C | 2 +- .../foamHelp/helpTypes/helpBoundary/helpBoundary.C | 2 +- .../foamHelp/helpTypes/helpBoundary/helpBoundary.H | 2 +- .../foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C | 2 +- .../foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C | 2 +- .../foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H | 2 +- .../miscellaneous/foamHelp/helpTypes/helpType/helpType.C | 2 +- .../miscellaneous/foamHelp/helpTypes/helpType/helpType.H | 2 +- .../miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/foamHelp.C b/applications/utilities/miscellaneous/foamHelp/foamHelp.C index e10578647b..39e0cb9130 100644 --- a/applications/utilities/miscellaneous/foamHelp/foamHelp.C +++ b/applications/utilities/miscellaneous/foamHelp/foamHelp.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C index 5bf5e736e8..a37811e63f 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H index 1f7c14df96..f2abdaee8d 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C index 73b540ff95..0ab6632da8 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParserTemplates.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C index a6867ebc22..9fd46f35c1 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H index 4add931c18..6166e8e1f3 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C index d9ee2c92f1..a615f3c24a 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C index 0d6c1b1c1e..631a1210ff 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H index 257335467f..4e8276bcdb 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C index 9391e753e6..0b982e76a7 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H index 3ce63ad713..f5e65709c6 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C index 72cd01437a..607ca9b435 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpTypeNew.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenCFD Ltd. + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License From 2412f20f51971edb823f7da21b43e52d2555432c Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 12:14:30 +0100 Subject: [PATCH 087/109] ENH: derived solutionControl from IOobject so that it can be retrieved from the database --- .../solutionControl/solutionControl/solutionControl.C | 6 ++++++ .../solutionControl/solutionControl/solutionControl.H | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C index 3de1587e7e..601b564c6d 100644 --- a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C +++ b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C @@ -165,6 +165,12 @@ void Foam::solutionControl::storePrevIterFields() const Foam::solutionControl::solutionControl(fvMesh& mesh, const word& algorithmName) : + IOobject + ( + "solutionControl", + mesh_.time().timeName(), + mesh_ + ), mesh_(mesh), residualControl_(), algorithmName_(algorithmName), diff --git a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.H b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.H index 45970fc325..e701813d47 100644 --- a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.H +++ b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -44,6 +44,8 @@ namespace Foam \*---------------------------------------------------------------------------*/ class solutionControl +: + public IOobject { public: From d6aae98328476b38c0b1f83841dbb832297cdbc4 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 12:18:42 +0100 Subject: [PATCH 088/109] ENH: wallShearStress function object - added error handling for when turb model is not present --- .../utilities/wallShearStress/wallShearStress.C | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/postProcessing/functionObjects/utilities/wallShearStress/wallShearStress.C b/src/postProcessing/functionObjects/utilities/wallShearStress/wallShearStress.C index 72244ea4b1..91e5eb7f04 100644 --- a/src/postProcessing/functionObjects/utilities/wallShearStress/wallShearStress.C +++ b/src/postProcessing/functionObjects/utilities/wallShearStress/wallShearStress.C @@ -222,6 +222,13 @@ void Foam::wallShearStress::write() tmp Reff; if (phi.dimensions() == dimMass/dimTime) { + if (!mesh.foundObject("turbulenceModel")) + { + FatalErrorIn("void Foam::wallShearStress::write()") + << "Unable to find compressible turbulence model in the " + << "database" << exit(FatalError); + } + const cmpModel& model = mesh.lookupObject("turbulenceModel"); @@ -229,6 +236,13 @@ void Foam::wallShearStress::write() } else { + if (!mesh.foundObject("turbulenceModel")) + { + FatalErrorIn("void Foam::wallShearStress::write()") + << "Unable to find incompressible turbulence model in the " + << "database" << exit(FatalError); + } + const icoModel& model = mesh.lookupObject("turbulenceModel"); From 65f13499b383cef45fa43cbf5abe917150fa2046 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 12:27:39 +0100 Subject: [PATCH 089/109] ENH: writeDictionary function object - use HashSet instead of List --- .../functionObjects/IO/writeDictionary/writeDictionary.C | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.C b/src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.C index f10a84eece..c98ae3696b 100644 --- a/src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.C +++ b/src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.C @@ -26,6 +26,7 @@ License #include "writeDictionary.H" #include "dictionary.H" #include "Time.H" +#include "HashSet.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -108,7 +109,9 @@ Foam::writeDictionary::~writeDictionary() void Foam::writeDictionary::read(const dictionary& dict) { - dict.lookup("dictNames") >> dictNames_; + wordList dictNames(dict.lookup("dictNames")); + HashSet uniqueNames(dictNames); + dictNames_ = uniqueNames.toc(); digests_.setSize(dictNames_.size(), SHA1Digest()); From 77d51a6caf8075689b893c0139e138382034ea3d Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 12:34:29 +0100 Subject: [PATCH 090/109] STYLE: limit to 80 chars --- .../foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C | 6 +++++- .../fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H | 4 ++-- .../multiphaseFixedFluxPressureFvPatchScalarField.H | 4 ++-- .../oscillatingFixedValueFvPatchField.H | 2 +- .../nutkRoughWallFunctionFvPatchScalarField.H | 3 ++- 5 files changed, 12 insertions(+), 7 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C index a37811e63f..acf9a72d24 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/doxygenXmlParser/doxygenXmlParser.C @@ -212,7 +212,11 @@ void Foam::doxygenXmlParser::skipBlock(IFstream& is, const word blockName) const } -void Foam::doxygenXmlParser::skipForward(IFstream& is, const word blockName) const +void Foam::doxygenXmlParser::skipForward +( + IFstream& is, + const word blockName +) const { // recurse to move forward in 'is' until come across diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index de9f6fb701..8476e63dff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -32,8 +32,8 @@ Description on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as - is the pressure diffusivity used to calculate the gradient using: + as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, + as is the pressure diffusivity used to calculate the gradient using: \f[ \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| D_p} diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index c7f13d7506..18b9698c0e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -32,8 +32,8 @@ Description on the boundary is that specified by the velocity boundary condition. The predicted flux to be compensated by the pressure gradient is evaluated - as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, as - is the pressure diffusivity Dp used to calculate the gradient using: + as \f$(\phi - \phi_{H/A})\f$, both of which are looked-up from the database, + as is the pressure diffusivity Dp used to calculate the gradient using: \f[ \nabla(p) = \frac{\phi_{H/A} - \phi}{|Sf| Dp} diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index c4d9066696..da45cdcb85 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -51,7 +51,7 @@ Description \table Property | Description | Required | Default value refValue | reference value | yes | - offset | offset value | no | 0.0; // optional + offset | offset value | no | 0.0 amplitude | oscillation amplitude | yes | frequency | oscillation frequency | yes | \endtable diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 980f55f3b1..50d24a3ebd 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -30,7 +30,8 @@ Group Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on turbulence kinetic - energy. The condition manipulates the E parameter to account for roughness effects. + energy. The condition manipulates the E parameter to account for roughness + effects. Parameter ranges - roughness height = sand-grain roughness (0 for smooth walls) From ee624a98a0af16641007f95db546efd21698933b Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 14:10:55 +0100 Subject: [PATCH 091/109] ENH: Updates to foamHelp utility --- applications/utilities/miscellaneous/foamHelp/Make/options | 2 +- .../foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/applications/utilities/miscellaneous/foamHelp/Make/options b/applications/utilities/miscellaneous/foamHelp/Make/options index 031de3d566..41ca9e9b57 100644 --- a/applications/utilities/miscellaneous/foamHelp/Make/options +++ b/applications/utilities/miscellaneous/foamHelp/Make/options @@ -12,4 +12,4 @@ EXE_LIBS = \ -lincompressibleLESModels \ -lcompressibleLESModels \ -lradiationModels \ - -lbasicThermophysicalModels + -lfluidThermophysicalModels diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C index a615f3c24a..f2ce4a0f00 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundaryTemplates.C @@ -120,7 +120,8 @@ void Foam::helpTypes::helpBoundary::fixedValueFieldConditions 0, mesh.nInternalFaces(), 0, - mesh.boundaryMesh() + mesh.boundaryMesh(), + patchType ); fvPatch fvp(pp, mesh.boundary()); From 7d2a890bfd9323819bdd7793d848e09f0b08260b Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 14:52:27 +0100 Subject: [PATCH 092/109] BUG: Corrected solution control construction from IOobject --- .../general/solutionControl/solutionControl/solutionControl.C | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C index 601b564c6d..8448153a69 100644 --- a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C +++ b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C @@ -168,8 +168,8 @@ Foam::solutionControl::solutionControl(fvMesh& mesh, const word& algorithmName) IOobject ( "solutionControl", - mesh_.time().timeName(), - mesh_ + mesh.time().timeName(), + mesh ), mesh_(mesh), residualControl_(), From 1d009cfb07197257c83d5066ab679535e5cb91a0 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 16:36:16 +0100 Subject: [PATCH 093/109] ENH: Added DES turbulence model abstract layer derived from LES --- .../compressible/LES/DESModel/DESModel.C | 57 +++++++++ .../compressible/LES/DESModel/DESModel.H | 114 ++++++++++++++++++ .../compressible/LES/DESModel/DESModelDoc.H | 32 +++++ .../incompressible/LES/DESModel/DESModel.C | 56 +++++++++ .../incompressible/LES/DESModel/DESModel.H | 113 +++++++++++++++++ .../incompressible/LES/DESModel/DESModelDoc.H | 32 +++++ 6 files changed, 404 insertions(+) create mode 100644 src/turbulenceModels/compressible/LES/DESModel/DESModel.C create mode 100644 src/turbulenceModels/compressible/LES/DESModel/DESModel.H create mode 100644 src/turbulenceModels/compressible/LES/DESModel/DESModelDoc.H create mode 100644 src/turbulenceModels/incompressible/LES/DESModel/DESModel.C create mode 100644 src/turbulenceModels/incompressible/LES/DESModel/DESModel.H create mode 100644 src/turbulenceModels/incompressible/LES/DESModel/DESModelDoc.H diff --git a/src/turbulenceModels/compressible/LES/DESModel/DESModel.C b/src/turbulenceModels/compressible/LES/DESModel/DESModel.C new file mode 100644 index 0000000000..74873f49e5 --- /dev/null +++ b/src/turbulenceModels/compressible/LES/DESModel/DESModel.C @@ -0,0 +1,57 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "DESModel.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace compressible +{ + +// * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * * // + +DESModel::DESModel +( + const word& type, + const volScalarField& rho, + const volVectorField& U, + const surfaceScalarField& phi, + const fluidThermo& thermoPhysicalModel, + const word& turbulenceModelName +) +: + LESModel(type, rho, U, phi, thermoPhysicalModel, turbulenceModelName) + +{} + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace compressible +} // End namespace Foam + +// ************************************************************************* // diff --git a/src/turbulenceModels/compressible/LES/DESModel/DESModel.H b/src/turbulenceModels/compressible/LES/DESModel/DESModel.H new file mode 100644 index 0000000000..9832c4de38 --- /dev/null +++ b/src/turbulenceModels/compressible/LES/DESModel/DESModel.H @@ -0,0 +1,114 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Group + grpCmpDESTurbulence + +Class + Foam::compressible::DESModel + +Description + Extension of LES models to provide an interface for Detached Eddy + Simulation turbulence models + +SeeAlso + Foam::LESModel + +SourceFiles + DESModel.C + +\*---------------------------------------------------------------------------*/ + +#ifndef compressibleDESModel_H +#define compressibleDESModel_H + +// note: use full(er) path so that derived utilities can bring in +// incompressible and compressible variants + +#include "compressible/LES/LESModel/LESModel.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace compressible +{ + +/*---------------------------------------------------------------------------*\ + Class DESModel Declaration +\*---------------------------------------------------------------------------*/ + +class DESModel +: + public LESModel +{ + +private: + + // Private Member Functions + + //- Disallow default bitwise copy construct + DESModel(const DESModel&); + + //- Disallow default bitwise assignment + DESModel& operator=(const DESModel&); + + +public: + + // Constructors + + //- Construct from components + DESModel + ( + const word& type, + const volScalarField& rho, + const volVectorField& U, + const surfaceScalarField& phi, + const fluidThermo& thermoPhysicalModel, + const word& turbulenceModelName + ); + + + //- Destructor + virtual ~DESModel() + {} + + + // Public Member Functions + + //- Return the LES field indicator + virtual tmp LESRegion() const = 0; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace compressible +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/turbulenceModels/compressible/LES/DESModel/DESModelDoc.H b/src/turbulenceModels/compressible/LES/DESModel/DESModelDoc.H new file mode 100644 index 0000000000..e9deb3208e --- /dev/null +++ b/src/turbulenceModels/compressible/LES/DESModel/DESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpDESTurbulence Compressible DES turbulence +@{ + \ingroup grpCmpTurbulence + This group contains compressible DES models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/LES/DESModel/DESModel.C b/src/turbulenceModels/incompressible/LES/DESModel/DESModel.C new file mode 100644 index 0000000000..3722f9cce6 --- /dev/null +++ b/src/turbulenceModels/incompressible/LES/DESModel/DESModel.C @@ -0,0 +1,56 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "DESModel.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace incompressible +{ + +// * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * * // + +DESModel::DESModel +( + const word& type, + const volVectorField& U, + const surfaceScalarField& phi, + transportModel& transport, + const word& turbulenceModelName +) +: + LESModel(type, U, phi, transport, turbulenceModelName) + +{} + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace incompressible +} // End namespace Foam + +// ************************************************************************* // diff --git a/src/turbulenceModels/incompressible/LES/DESModel/DESModel.H b/src/turbulenceModels/incompressible/LES/DESModel/DESModel.H new file mode 100644 index 0000000000..5f73e0d156 --- /dev/null +++ b/src/turbulenceModels/incompressible/LES/DESModel/DESModel.H @@ -0,0 +1,113 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Group + grpIcoDESTurbulence + +Class + Foam::incompressible::DESModel + +Description + Extension of LES models to provide an interface for Detached Eddy + Simulation turbulence models + +SeeAlso + Foam::LESModel + +SourceFiles + DESModel.C + +\*---------------------------------------------------------------------------*/ + +#ifndef incompressibleDESModel_H +#define incompressibleDESModel_H + +// note: use full(er) path so that derived utilities can bring in +// incompressible and compressible variants + +#include "incompressible/LES/LESModel/LESModel.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace incompressible +{ + +/*---------------------------------------------------------------------------*\ + Class DESModel Declaration +\*---------------------------------------------------------------------------*/ + +class DESModel +: + public LESModel +{ + +private: + + // Private Member Functions + + //- Disallow default bitwise copy construct + DESModel(const DESModel&); + + //- Disallow default bitwise assignment + DESModel& operator=(const DESModel&); + + +public: + + // Constructors + + //- Construct from components + DESModel + ( + const word& type, + const volVectorField& U, + const surfaceScalarField& phi, + transportModel& transport, + const word& turbulenceModelName + ); + + + //- Destructor + virtual ~DESModel() + {} + + + // Public Member Functions + + //- Return the LES field indicator + virtual tmp LESRegion() const = 0; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace incompressible +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/turbulenceModels/incompressible/LES/DESModel/DESModelDoc.H b/src/turbulenceModels/incompressible/LES/DESModel/DESModelDoc.H new file mode 100644 index 0000000000..5311d09d67 --- /dev/null +++ b/src/turbulenceModels/incompressible/LES/DESModel/DESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoDESTurbulence Incompressible DES turbulence +@{ + \ingroup grpIcoTurbulence + This group contains incompressible DES models. +@} + +\*---------------------------------------------------------------------------*/ From 9106a4f5004516da7ddbe80911e33f12a2c165c8 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 16:37:11 +0100 Subject: [PATCH 094/109] ENH: Updated SpalartAllmaras family of DES models --- .../LES/SpalartAllmaras/SpalartAllmaras.C | 28 ++++++++++++++++++- .../LES/SpalartAllmaras/SpalartAllmaras.H | 9 ++++-- .../LES/SpalartAllmaras/SpalartAllmaras.C | 26 ++++++++++++++++- .../LES/SpalartAllmaras/SpalartAllmaras.H | 9 ++++-- .../SpalartAllmarasDDES/SpalartAllmarasDDES.H | 4 +-- .../SpalartAllmarasIDDES.H | 2 +- 6 files changed, 67 insertions(+), 11 deletions(-) diff --git a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.C b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.C index bda2af653d..6994f926e3 100644 --- a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.C +++ b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.C @@ -118,7 +118,7 @@ SpalartAllmaras::SpalartAllmaras const word& modelName ) : - LESModel(modelName, rho, U, phi, thermoPhysicalModel, turbulenceModelName), + DESModel(modelName, rho, U, phi, thermoPhysicalModel, turbulenceModelName), sigmaNut_ ( @@ -364,6 +364,32 @@ bool SpalartAllmaras::read() } +tmp SpalartAllmaras::LESRegion() const +{ + volScalarField wd(wallDist(mesh_).y()); + + tmp tLESRegion + ( + new volScalarField + ( + IOobject + ( + "DES::LESRegion", + mesh_.time().timeName(), + mesh_, + IOobject::NO_READ, + IOobject::NO_WRITE + ), + neg(min(CDES_*delta(), wd) - wd) +// mesh_, +// dimensionedScalar("zero", dimless, 0.0) + ) + ); + + return tLESRegion; +} + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace LESModels diff --git a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H index 1ef5941cf8..1897578942 100644 --- a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -25,7 +25,7 @@ Class Foam::compressible::LESModels::SpalartAllmaras Group - grpCmpLESTurbulence + grpCmpDESTurbulence Description SpalartAllmaras for compressible flows @@ -38,7 +38,7 @@ SourceFiles #ifndef compressibleSpalartAllmaras_H #define compressibleSpalartAllmaras_H -#include "LESModel.H" +#include "DESModel.H" #include "volFields.H" // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // @@ -56,7 +56,7 @@ namespace LESModels class SpalartAllmaras : - public LESModel + public DESModel { // Private data @@ -169,6 +169,9 @@ public: //- Read LESProperties dictionary virtual bool read(); + + //- Return the LES field indicator + virtual tmp LESRegion() const; }; diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.C b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.C index da8ab55e07..bbbf51332b 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.C +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.C @@ -152,7 +152,7 @@ SpalartAllmaras::SpalartAllmaras const word& modelName ) : - LESModel(modelName, U, phi, transport, turbulenceModelName), + DESModel(modelName, U, phi, transport, turbulenceModelName), sigmaNut_ ( @@ -395,6 +395,30 @@ bool SpalartAllmaras::read() } +tmp SpalartAllmaras::LESRegion() const +{ + tmp tLESRegion + ( + new volScalarField + ( + IOobject + ( + "DES::LESRegion", + mesh_.time().timeName(), + mesh_, + IOobject::NO_READ, + IOobject::NO_WRITE + ), + neg(dTilda(S(fvc::grad(U_))) - y_) +// mesh_, +// dimensionedScalar("zero", dimless, 0.0) + ) + ); + + return tLESRegion; +} + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace LESModels diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H index 674a42134d..fe4fe280f3 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -25,7 +25,7 @@ Class Foam::incompressible::LESModels::SpalartAllmaras Group - grpIcoLESTurbulence + grpIcoDESTurbulence Description SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows @@ -38,7 +38,7 @@ SourceFiles #ifndef SpalartAllmaras_H #define SpalartAllmaras_H -#include "LESModel.H" +#include "DESModel.H" #include "volFields.H" #include "wallDist.H" @@ -57,7 +57,7 @@ namespace LESModels class SpalartAllmaras : - public LESModel + public DESModel { // Private Member Functions @@ -194,6 +194,9 @@ public: //- Read LESProperties dictionary virtual bool read(); + + //- Return the LES field indicator + virtual tmp LESRegion() const; }; diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H index eebe26cfa5..70b6f5cf9b 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H @@ -25,7 +25,7 @@ Class Foam::incompressible::LESModels::SpalartAllmarasDDES Group - grpIcoLESTurbulence + grpIcoDESTurbulence Description SpalartAllmaras DDES LES turbulence model for incompressible flows @@ -55,7 +55,7 @@ namespace LESModels { /*---------------------------------------------------------------------------*\ - Class SpalartAllmarasDDES Declaration + Class SpalartAllmarasDDES Declaration \*---------------------------------------------------------------------------*/ class SpalartAllmarasDDES diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H index 43f10eee33..fc31252782 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H @@ -25,7 +25,7 @@ Class Foam::incompressible::LESModels::SpalartAllmarasIDDES Group - grpIcoLESTurbulence + grpIcoDESTurbulence Description SpalartAllmarasIDDES LES turbulence model for incompressible flows From ac5163e1428c29fdd70f454aeb2be5c2700a7709 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 16:37:42 +0100 Subject: [PATCH 095/109] ENH: updated #ifdef label --- src/turbulenceModels/incompressible/LES/LESModel/LESModel.H | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H index b8a2a5f9ac..3a9af24df8 100644 --- a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H +++ b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H @@ -47,8 +47,8 @@ SourceFiles \*---------------------------------------------------------------------------*/ -#ifndef LESModel_H -#define LESModel_H +#ifndef incompressibleLESModel_H +#define incompressibleLESModel_H #include "incompressible/turbulenceModel/turbulenceModel.H" #include "LESdelta.H" From 33d8b17a36aa24658069d3aa4888c5e44f2481e3 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 16:38:19 +0100 Subject: [PATCH 096/109] ENH: Added DES models to Make/files --- src/turbulenceModels/compressible/LES/Make/files | 1 + src/turbulenceModels/incompressible/LES/Make/files | 2 ++ 2 files changed, 3 insertions(+) diff --git a/src/turbulenceModels/compressible/LES/Make/files b/src/turbulenceModels/compressible/LES/Make/files index cc52d88433..1ed6bd6b4b 100644 --- a/src/turbulenceModels/compressible/LES/Make/files +++ b/src/turbulenceModels/compressible/LES/Make/files @@ -1,4 +1,5 @@ LESModel/LESModel.C +DESModel/DESModel.C GenEddyVisc/GenEddyVisc.C GenSGSStress/GenSGSStress.C diff --git a/src/turbulenceModels/incompressible/LES/Make/files b/src/turbulenceModels/incompressible/LES/Make/files index aff6654ead..c41aefe994 100644 --- a/src/turbulenceModels/incompressible/LES/Make/files +++ b/src/turbulenceModels/incompressible/LES/Make/files @@ -2,6 +2,8 @@ vanDriestDelta/vanDriestDelta.C LESModel/LESModel.C +DESModel/DESModel.C + GenEddyVisc/GenEddyVisc.C GenSGSStress/GenSGSStress.C From 10bd19fb4288e22311d5208be91c4c77c8ab4747 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 26 Sep 2012 16:39:05 +0100 Subject: [PATCH 097/109] ENH: Added new DESModelRegions function object to identify DES calc RAS/LES regions --- .../DESModelRegions/DESModelRegions.C | 229 ++++++++++++++++++ .../DESModelRegions/DESModelRegions.H | 158 ++++++++++++ .../DESModelRegionsFunctionObject.C | 42 ++++ .../DESModelRegionsFunctionObject.H | 54 +++++ .../DESModelRegions/IODESModelRegions.H | 49 ++++ .../functionObjects/utilities/Make/files | 3 + 6 files changed, 535 insertions(+) create mode 100644 src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.C create mode 100644 src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.H create mode 100644 src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.C create mode 100644 src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.H create mode 100644 src/postProcessing/functionObjects/utilities/DESModelRegions/IODESModelRegions.H diff --git a/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.C b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.C new file mode 100644 index 0000000000..604cf2fd89 --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.C @@ -0,0 +1,229 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "DESModelRegions.H" +#include "volFields.H" +#include "compressible/turbulenceModel/turbulenceModel.H" +#include "compressible/LES/DESModel/DESModel.H" +#include "incompressible/turbulenceModel/turbulenceModel.H" +#include "incompressible/LES/DESModel/DESModel.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +defineTypeNameAndDebug(Foam::DESModelRegions, 0); + + +// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // + +void Foam::DESModelRegions::makeFile() +{ + // Create the output file if not already created + if (outputFilePtr_.empty()) + { + if (debug) + { + Info<< "Creating output file." << endl; + } + + // File update + if (Pstream::master()) + { + fileName outputDir; + word startTimeName = + obr_.time().timeName(obr_.time().startTime().value()); + + if (Pstream::parRun()) + { + // Put in undecomposed case (Note: gives problems for + // distributed data running) + outputDir = + obr_.time().path()/".."/name_/startTimeName; + } + else + { + outputDir = obr_.time().path()/name_/startTimeName; + } + + // Create directory if does not exist + mkDir(outputDir); + + // Open new file at start up + outputFilePtr_.reset(new OFstream(outputDir/(type() + ".dat"))); + + // Add headers to output data + outputFilePtr_() << "# DES model region coverage (% volume)" << nl + << "# time " << token::TAB << "LES" << token::TAB << "RAS" + << endl; + } + } +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::DESModelRegions::DESModelRegions +( + const word& name, + const objectRegistry& obr, + const dictionary& dict, + const bool loadFromFiles +) +: + name_(name), + obr_(obr), + active_(true), + log_(false), + outputFilePtr_(NULL) +{ + // Check if the available mesh is an fvMesh, otherwise deactivate + if (!isA(obr_)) + { + active_ = false; + WarningIn + ( + "DESModelRegions::DESModelRegions" + "(" + "const word&, " + "const objectRegistry&, " + "const dictionary&, " + "const bool" + ")" + ) << "No fvMesh available, deactivating." << nl + << endl; + } + + makeFile(); + + read(dict); +} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::DESModelRegions::~DESModelRegions() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::DESModelRegions::read(const dictionary& dict) +{ + if (active_) + { + log_ = dict.lookupOrDefault("log", false); + } +} + + +void Foam::DESModelRegions::execute() +{ + // Do nothing - only valid on write +} + + +void Foam::DESModelRegions::end() +{ + // Do nothing - only valid on write +} + + +void Foam::DESModelRegions::write() +{ + typedef incompressible::turbulenceModel icoModel; + typedef incompressible::DESModel icoDESModel; + + typedef compressible::turbulenceModel cmpModel; + typedef compressible::DESModel cmpDESModel; + + if (active_) + { + const fvMesh& mesh = refCast(obr_); + + if (log_) + { + Info<< type() << " output:" << nl; + } + + tmp result; + + label DESpresent = false; + if (mesh.foundObject("turbulenceModel")) + { + const icoModel& model = + mesh.lookupObject("turbulenceModel"); + + if (isA(model)) + { + const icoDESModel& des = + dynamic_cast(model); + result = des.LESRegion(); + DESpresent = true; + } + } + else if (mesh.foundObject("turbulenceModel")) + { + const cmpModel& model = + mesh.lookupObject("turbulenceModel"); + + if (isA(model)) + { + const cmpDESModel& des = + dynamic_cast(model); + result = des.LESRegion(); + DESpresent = true; + } + } + + if (DESpresent) + { + scalar prc = + gSum(result().internalField()*mesh.V())/gSum(mesh.V())*100.0; + + if (Pstream::master()) + { + outputFilePtr_() << obr_.time().timeName() << token::TAB + << prc << token::TAB << 100.0 - prc << endl; + } + + if (log_) + { + Info<< " LES = " << prc << " % (volume)" << nl + << " RES = " << 100.0 - prc << " % (volume)" << nl + << endl; + } + } + else + { + if (log_) + { + Info<< " No DES turbulence model found in database" << nl + << endl; + } + } + } +} + + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.H b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.H new file mode 100644 index 0000000000..38c8be7c13 --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegions.H @@ -0,0 +1,158 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Class + Foam::DESModelRegions + +Group + grpUtilitiesFunctionObjects + +Description + This function object writes out an indicator field for DES turbulence + calculations, that is: + + - 0 for RAS regions + - 1 for LES regions + +SourceFiles + DESModelRegions.C + IODESModelRegions.H + +\*---------------------------------------------------------------------------*/ + +#ifndef DESModelRegions_H +#define DESModelRegions_H + +#include "volFieldsFwd.H" +#include "pointFieldFwd.H" +#include "Switch.H" +#include "OFstream.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +// Forward declaration of classes +class objectRegistry; +class dictionary; +class mapPolyMesh; +class fvMesh; + +/*---------------------------------------------------------------------------*\ + Class DESModelRegions Declaration +\*---------------------------------------------------------------------------*/ + +class DESModelRegions +{ + // Private data + + //- Name of this set of DESModelRegions object + word name_; + + const objectRegistry& obr_; + + //- on/off switch + bool active_; + + //- Switch to send output to Info as well as to file + Switch log_; + + //- Output file pointer + autoPtr outputFilePtr_; + + + // Private Member Functions + + //- Make the output file + virtual void makeFile(); + + //- Disallow default bitwise copy construct + DESModelRegions(const DESModelRegions&); + + //- Disallow default bitwise assignment + void operator=(const DESModelRegions&); + + +public: + + //- Runtime type information + TypeName("DESModelRegions"); + + + // Constructors + + //- Construct for given objectRegistry and dictionary. + // Allow the possibility to load fields from files + DESModelRegions + ( + const word& name, + const objectRegistry&, + const dictionary&, + const bool loadFromFiles = false + ); + + + //- Destructor + virtual ~DESModelRegions(); + + + // Member Functions + + //- Return name of the set of DESModelRegions + virtual const word& name() const + { + return name_; + } + + //- Read the DESModelRegions data + virtual void read(const dictionary&); + + //- Execute, currently does nothing + virtual void execute(); + + //- Execute at the final time-loop, currently does nothing + virtual void end(); + + //- Calculate the DESModelRegions and write + virtual void write(); + + //- Update for changes of mesh + virtual void updateMesh(const mapPolyMesh&) + {} + + //- Update for changes of mesh + virtual void movePoints(const pointField&) + {} +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.C b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.C new file mode 100644 index 0000000000..2312e6f5fb --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.C @@ -0,0 +1,42 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "DESModelRegionsFunctionObject.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + defineNamedTemplateTypeNameAndDebug(DESModelRegionsFunctionObject, 0); + + addToRunTimeSelectionTable + ( + functionObject, + DESModelRegionsFunctionObject, + dictionary + ); +} + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.H b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.H new file mode 100644 index 0000000000..7e9a6ba45c --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/DESModelRegions/DESModelRegionsFunctionObject.H @@ -0,0 +1,54 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Typedef + Foam::DESModelRegionsFunctionObject + +Description + FunctionObject wrapper around DESModelRegions to allow it to be created + via the functions entry within controlDict. + +SourceFiles + DESModelRegionsFunctionObject.C + +\*---------------------------------------------------------------------------*/ + +#ifndef DESModelRegionsFunctionObject_H +#define DESModelRegionsFunctionObject_H + +#include "DESModelRegions.H" +#include "OutputFilterFunctionObject.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + typedef OutputFilterFunctionObject + DESModelRegionsFunctionObject; +} + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/utilities/DESModelRegions/IODESModelRegions.H b/src/postProcessing/functionObjects/utilities/DESModelRegions/IODESModelRegions.H new file mode 100644 index 0000000000..17cc16b74e --- /dev/null +++ b/src/postProcessing/functionObjects/utilities/DESModelRegions/IODESModelRegions.H @@ -0,0 +1,49 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Typedef + Foam::IODESModelRegions + +Description + Instance of the generic IOOutputFilter for DESModelRegions. + +\*---------------------------------------------------------------------------*/ + +#ifndef IODESModelRegions_H +#define IODESModelRegions_H + +#include "DESModelRegions.H" +#include "IOOutputFilter.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + typedef IOOutputFilter IODESModelRegions; +} + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/utilities/Make/files b/src/postProcessing/functionObjects/utilities/Make/files index d5a78589b2..362f24a0e7 100644 --- a/src/postProcessing/functionObjects/utilities/Make/files +++ b/src/postProcessing/functionObjects/utilities/Make/files @@ -3,6 +3,9 @@ codedFunctionObject/codedFunctionObject.C CourantNo/CourantNo.C CourantNo/CourantNoFunctionObject.C +DESModelRegions/DESModelRegions.C +DESModelRegions/DESModelRegionsFunctionObject.C + dsmcFields/dsmcFields.C dsmcFields/dsmcFieldsFunctionObject.C From 931b86335e46c6de4eb82ff45441f4fe178ab7af Mon Sep 17 00:00:00 2001 From: Henry Date: Wed, 26 Sep 2012 23:48:47 +0100 Subject: [PATCH 098/109] wordList: Added initial version of printTable which prints a List in tabular form --- .../primitives/strings/word/wordIOList.C | 38 +++++++++++++++++++ .../primitives/strings/word/wordIOList.H | 3 ++ 2 files changed, 41 insertions(+) diff --git a/src/OpenFOAM/primitives/strings/word/wordIOList.C b/src/OpenFOAM/primitives/strings/word/wordIOList.C index dc85ced879..ede987af53 100644 --- a/src/OpenFOAM/primitives/strings/word/wordIOList.C +++ b/src/OpenFOAM/primitives/strings/word/wordIOList.C @@ -37,4 +37,42 @@ namespace Foam defineTemplateTypeNameAndDebugWithName(wordListIOList, "wordListList", 0); } + +void Foam::printTable(const List& wll, Ostream& os) +{ + if (!wll.size()) return; + + // Find the maximum word length for each column + List columnWidth(wll[0].size(), string::size_type(0)); + forAll(columnWidth, j) + { + forAll(wll, i) + { + columnWidth[j] = max(columnWidth[j], wll[i][j].size()); + } + } + + // Print the rows adding spacing for the columns + forAll(wll, i) + { + forAll(wll[i], j) + { + os << wll[i][j]; + for + ( + string::size_type k=0; + k wordIOList; typedef IOList wordListIOList; + + // Print word list list as a table + void printTable(const List&, Ostream&); } // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // From 4413f10e9796011a674d5bfafd47f3b6b872f06c Mon Sep 17 00:00:00 2001 From: Henry Date: Wed, 26 Sep 2012 23:49:29 +0100 Subject: [PATCH 099/109] Thermodynamics: rationalised the "make" macros for chemistrySolvers --- .../chemistrySolver/chemistrySolver.H | 21 ------------------- .../makeSolidChemistrySolverType.H | 5 +++++ .../makeSolidChemistrySolvers.C | 14 ------------- 3 files changed, 5 insertions(+), 35 deletions(-) diff --git a/src/thermophysicalModels/chemistryModel/chemistrySolver/chemistrySolver/chemistrySolver.H b/src/thermophysicalModels/chemistryModel/chemistrySolver/chemistrySolver/chemistrySolver.H index 5e8dcff289..f8348150b0 100644 --- a/src/thermophysicalModels/chemistryModel/chemistrySolver/chemistrySolver/chemistrySolver.H +++ b/src/thermophysicalModels/chemistryModel/chemistrySolver/chemistrySolver/chemistrySolver.H @@ -112,7 +112,6 @@ public: ); - #define makeChemistrySolverType(SS, ODEChem, Comp, Thermo) \ \ typedef SS > SS##ODEChem##Comp##Thermo; \ @@ -132,26 +131,6 @@ public: ); -#define makeSolidChemistrySolverType(SS, ODEChem, Comp, SThermo, GThermo) \ - \ - typedef SS > \ - SS##ODEChem##Comp##SThermo##GThermo; \ - \ - defineTemplateTypeNameAndDebugWithName \ - ( \ - SS##ODEChem##Comp##SThermo##GThermo, \ - #SS"<"#ODEChem"<"#Comp","#SThermo","#GThermo">>", \ - 0 \ - ); \ - \ - addToRunTimeSelectionTable \ - ( \ - Comp, \ - SS##ODEChem##Comp##SThermo##GThermo, \ - fvMesh \ - ); - - // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // #ifdef NoRepository diff --git a/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolverType.H b/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolverType.H index f528bc50a5..39e49524e4 100644 --- a/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolverType.H +++ b/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolverType.H @@ -41,6 +41,11 @@ namespace Foam #define makeSolidChemistrySolverType(SS, ODEChem, Comp, SThermo, GThermo) \ \ + typedef ODESolidChemistryModel \ + ODESolidChemistryModel##Comp##SThermo##GThermo; \ + \ + makeChemistrySolver(ODESolidChemistryModel##Comp##SThermo##GThermo) \ + \ typedef SS > \ SS##ODEChem##Comp##SThermo##GThermo; \ \ diff --git a/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolvers.C b/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolvers.C index cfdb9c2d53..64cc731266 100644 --- a/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolvers.C +++ b/src/thermophysicalModels/solidChemistryModel/solidChemistrySolver/makeSolidChemistrySolvers.C @@ -27,8 +27,6 @@ License #include "solidThermoPhysicsTypes.H" #include "thermoPhysicsTypes.H" -#include "chemistrySolver.H" - #include "ODESolidChemistryModel.H" #include "solidChemistryModel.H" @@ -38,12 +36,6 @@ License namespace Foam { - typedef ODESolidChemistryModel - - solidODEChemistryConstThermo; - - makeChemistrySolver(solidODEChemistryConstThermo) - makeSolidChemistrySolverType ( ode, @@ -53,12 +45,6 @@ namespace Foam gasThermoPhysics ) - typedef ODESolidChemistryModel - - solidODEChemistryExpThermo; - - makeChemistrySolver(solidODEChemistryExpThermo) - makeSolidChemistrySolverType ( ode, From fb0d3ade1fdfe372d70b0aa6f552bc0fe66ad39c Mon Sep 17 00:00:00 2001 From: Henry Date: Wed, 26 Sep 2012 23:50:11 +0100 Subject: [PATCH 100/109] Thermodynamics: templated New function to reuse in all basic thermo types --- src/thermophysicalModels/basic/Make/files | 8 - .../basic/basicThermo/basicThermo.C | 44 +++ .../basic/basicThermo/basicThermo.H | 128 +++++++++ .../basic/basicThermo/basicThermoNew.C | 71 ----- .../basic/fluidThermo/fluidThermo.C | 9 + .../basic/fluidThermo/fluidThermoNew.C | 71 ----- .../mixtures/basicMixture/basicMixture.C | 17 -- .../mixtures/basicMixture/basicMixture.H | 13 +- .../mixtures/basicMixture/basicMixtures.C | 253 ------------------ .../mixtures/basicMixture/makeBasicMixture.H | 54 ---- .../basic/mixtures/pureMixture/pureMixture.C | 7 - .../basic/mixtures/pureMixture/pureMixture.H | 8 - .../basic/psiThermo/psiThermo/psiThermo.C | 9 + .../basic/psiThermo/psiThermo/psiThermoNew.C | 94 ------- .../basic/rhoThermo/rhoThermo/rhoThermo.C | 9 + .../basic/rhoThermo/rhoThermo/rhoThermoNew.C | 72 ----- 16 files changed, 201 insertions(+), 666 deletions(-) delete mode 100644 src/thermophysicalModels/basic/basicThermo/basicThermoNew.C delete mode 100644 src/thermophysicalModels/basic/fluidThermo/fluidThermoNew.C delete mode 100644 src/thermophysicalModels/basic/mixtures/basicMixture/basicMixtures.C delete mode 100644 src/thermophysicalModels/basic/mixtures/basicMixture/makeBasicMixture.H delete mode 100644 src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermoNew.C delete mode 100644 src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermoNew.C diff --git a/src/thermophysicalModels/basic/Make/files b/src/thermophysicalModels/basic/Make/files index f49b474762..ca80ac7279 100644 --- a/src/thermophysicalModels/basic/Make/files +++ b/src/thermophysicalModels/basic/Make/files @@ -1,18 +1,10 @@ -mixtures/basicMixture/basicMixture.C -mixtures/basicMixture/basicMixtures.C - basicThermo/basicThermo.C -basicThermo/basicThermoNew.C - fluidThermo/fluidThermo.C -fluidThermo/fluidThermoNew.C psiThermo/psiThermo/psiThermo.C -psiThermo/psiThermo/psiThermoNew.C psiThermo/hePsiThermo/hePsiThermos.C rhoThermo/rhoThermo/rhoThermo.C -rhoThermo/rhoThermo/rhoThermoNew.C rhoThermo/heRhoThermo/heRhoThermos.C derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.C diff --git a/src/thermophysicalModels/basic/basicThermo/basicThermo.C b/src/thermophysicalModels/basic/basicThermo/basicThermo.C index 13d6f0462c..d20f1cbe4d 100644 --- a/src/thermophysicalModels/basic/basicThermo/basicThermo.C +++ b/src/thermophysicalModels/basic/basicThermo/basicThermo.C @@ -156,6 +156,15 @@ Foam::basicThermo::basicThermo {} +Foam::autoPtr Foam::basicThermo::New +( + const fvMesh& mesh +) +{ + return NewThermo(mesh); +} + + // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // Foam::basicThermo::~basicThermo() @@ -247,6 +256,41 @@ void Foam::basicThermo::validate } +Foam::wordList Foam::basicThermo::splitThermoName +( + const word& thermoName, + const int nCmpt +) +{ + wordList cmpts(nCmpt); + + string::size_type beg=0, end=0; + int i = 0; + + while + ( + (end = thermoName.find('<', beg)) != string::npos + || (end = thermoName.find(',', beg)) != string::npos + ) + { + if (beg < end) + { + cmpts[i] = thermoName.substr(beg, end-beg); + cmpts[i++].replaceAll(">",""); + } + beg = end + 1; + } + + if (beg < thermoName.size()) + { + cmpts[i] = thermoName.substr(beg, string::npos); + cmpts[i++].replaceAll(">",""); + } + + return cmpts; +} + + Foam::volScalarField& Foam::basicThermo::p() { return p_; diff --git a/src/thermophysicalModels/basic/basicThermo/basicThermo.H b/src/thermophysicalModels/basic/basicThermo/basicThermo.H index 079ffd7d34..85ffe04467 100644 --- a/src/thermophysicalModels/basic/basicThermo/basicThermo.H +++ b/src/thermophysicalModels/basic/basicThermo/basicThermo.H @@ -40,6 +40,7 @@ SourceFiles #include "typeInfo.H" #include "IOdictionary.H" #include "autoPtr.H" +#include "wordIOList.H" // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // @@ -93,6 +94,7 @@ public: (mesh) ); + // Constructors //- Construct from mesh @@ -150,6 +152,12 @@ public: const word& ) const; + //- Split name of thermo package into a list of the components names + static wordList splitThermoName + ( + const word& thermoName, + const int nCmpt + ); //- Update properties virtual void correct() = 0; @@ -336,6 +344,126 @@ public: }; +template +autoPtr NewThermo +( + const fvMesh& mesh +) +{ + IOdictionary thermoDict + ( + IOobject + ( + "thermophysicalProperties", + mesh.time().constant(), + mesh, + IOobject::MUST_READ_IF_MODIFIED, + IOobject::NO_WRITE, + false + ) + ); + + word thermoTypeName; + + if (thermoDict.isDict("thermoType")) + { + const dictionary& thermoTypeDict(thermoDict.subDict("thermoType")); + + Info<< "Selecting thermodynamics package " << thermoTypeDict << endl; + + const int nCmpt = 7; + const char* cmptNames[nCmpt] = + { + "type", + "mixture", + "transport", + "thermo", + "equationOfState", + "specie", + "energy" + }; + + // Construct the name of the thermo package from the components + thermoTypeName = + word(thermoTypeDict.lookup("type")) + '<' + + word(thermoTypeDict.lookup("mixture")) + '<' + + word(thermoTypeDict.lookup("transport")) + '<' + + word(thermoTypeDict.lookup("thermo")) + '<' + + word(thermoTypeDict.lookup("equationOfState")) + '<' + + word(thermoTypeDict.lookup("specie")) + ">>," + + word(thermoTypeDict.lookup("energy")) + ">>>"; + + // Lookup the thermo package + typename Thermo::fvMeshConstructorTable::iterator cstrIter = + Thermo::fvMeshConstructorTablePtr_->find(thermoTypeName); + + // Print error message if package not found in the table + if (cstrIter == Thermo::fvMeshConstructorTablePtr_->end()) + { + FatalErrorIn(Thermo::typeName + "::New(const fvMesh&)") + << "Unknown " << Thermo::typeName << " type " << nl + << "thermoType" << thermoTypeDict << nl << nl + << "Valid " << Thermo::typeName << " types are:" << nl << nl; + + // Get the list of all the suitable thermo packages available + wordList validThermoTypeNames + ( + Thermo::fvMeshConstructorTablePtr_->sortedToc() + ); + + // Build a table of the thermo packages constituent parts + // Note: row-0 contains the names of constituent parts + List validThermoTypeNameCmpts + ( + validThermoTypeNames.size() + 1 + ); + + validThermoTypeNameCmpts[0].setSize(nCmpt); + forAll(validThermoTypeNameCmpts[0], j) + { + validThermoTypeNameCmpts[0][j] = cmptNames[j]; + } + + // Split the thermo package names into their constituent parts + forAll(validThermoTypeNames, i) + { + validThermoTypeNameCmpts[i+1] = + Thermo::splitThermoName(validThermoTypeNames[i], nCmpt); + } + + // Print the table of available packages + // in terms of their constituent parts + printTable(validThermoTypeNameCmpts, FatalError); + + FatalError<< exit(FatalError); + } + + return autoPtr(cstrIter()(mesh)); + } + else + { + thermoTypeName = word(thermoDict.lookup("thermoType")); + + Info<< "Selecting thermodynamics package " << thermoTypeName << endl; + + typename Thermo::fvMeshConstructorTable::iterator cstrIter = + Thermo::fvMeshConstructorTablePtr_->find(thermoTypeName); + + if (cstrIter == Thermo::fvMeshConstructorTablePtr_->end()) + { + FatalErrorIn(Thermo::typeName + "::New(const fvMesh&)") + << "Unknown " << Thermo::typeName << " type " + << thermoTypeName << nl << nl + << "Valid " << Thermo::typeName << " types are:" << nl + << Thermo::fvMeshConstructorTablePtr_->sortedToc() << nl + << exit(FatalError); + } + + return autoPtr(cstrIter()(mesh)); + } +} + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace Foam diff --git a/src/thermophysicalModels/basic/basicThermo/basicThermoNew.C b/src/thermophysicalModels/basic/basicThermo/basicThermoNew.C deleted file mode 100644 index e7dda0d9d5..0000000000 --- a/src/thermophysicalModels/basic/basicThermo/basicThermoNew.C +++ /dev/null @@ -1,71 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / 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 . - -\*---------------------------------------------------------------------------*/ - -#include "basicThermo.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -Foam::autoPtr Foam::basicThermo::New -( - const fvMesh& mesh -) -{ - // get model name, but do not register the dictionary - // otherwise it is registered in the database twice - const word modelType - ( - IOdictionary - ( - IOobject - ( - "thermophysicalProperties", - mesh.time().constant(), - mesh, - IOobject::MUST_READ_IF_MODIFIED, - IOobject::NO_WRITE, - false - ) - ).lookup("thermoType") - ); - - Info<< "Selecting thermodynamics package " << modelType << endl; - - fvMeshConstructorTable::iterator cstrIter = - fvMeshConstructorTablePtr_->find(modelType); - - if (cstrIter == fvMeshConstructorTablePtr_->end()) - { - FatalErrorIn("basicThermo::New(const fvMesh&)") - << "Unknown basicThermo type " << modelType << nl << nl - << "Valid basicThermo types are:" << nl - << fvMeshConstructorTablePtr_->sortedToc() << nl - << exit(FatalError); - } - - return autoPtr(cstrIter()(mesh)); -} - - -// ************************************************************************* // diff --git a/src/thermophysicalModels/basic/fluidThermo/fluidThermo.C b/src/thermophysicalModels/basic/fluidThermo/fluidThermo.C index e62ae73c65..b0438e6431 100644 --- a/src/thermophysicalModels/basic/fluidThermo/fluidThermo.C +++ b/src/thermophysicalModels/basic/fluidThermo/fluidThermo.C @@ -49,6 +49,15 @@ Foam::fluidThermo::fluidThermo(const fvMesh& mesh, const dictionary& dict) {} +Foam::autoPtr Foam::fluidThermo::New +( + const fvMesh& mesh +) +{ + return NewThermo(mesh); +} + + // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // Foam::fluidThermo::~fluidThermo() diff --git a/src/thermophysicalModels/basic/fluidThermo/fluidThermoNew.C b/src/thermophysicalModels/basic/fluidThermo/fluidThermoNew.C deleted file mode 100644 index d6977a542a..0000000000 --- a/src/thermophysicalModels/basic/fluidThermo/fluidThermoNew.C +++ /dev/null @@ -1,71 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / 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 . - -\*---------------------------------------------------------------------------*/ - -#include "fluidThermo.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -Foam::autoPtr Foam::fluidThermo::New -( - const fvMesh& mesh -) -{ - // get model name, but do not register the dictionary - // otherwise it is registered in the database twice - const word modelType - ( - IOdictionary - ( - IOobject - ( - "thermophysicalProperties", - mesh.time().constant(), - mesh, - IOobject::MUST_READ_IF_MODIFIED, - IOobject::NO_WRITE, - false - ) - ).lookup("thermoType") - ); - - Info<< "Selecting thermodynamics package " << modelType << endl; - - fvMeshConstructorTable::iterator cstrIter = - fvMeshConstructorTablePtr_->find(modelType); - - if (cstrIter == fvMeshConstructorTablePtr_->end()) - { - FatalErrorIn("fluidThermo::New(const fvMesh&)") - << "Unknown fluidThermo type " << modelType << nl << nl - << "Valid fluidThermo types are:" << nl - << fvMeshConstructorTablePtr_->sortedToc() << nl - << exit(FatalError); - } - - return autoPtr(cstrIter()(mesh)); -} - - -// ************************************************************************* // diff --git a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.C b/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.C index 8fa95c5bbf..02d65d7a27 100644 --- a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.C +++ b/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.C @@ -24,29 +24,12 @@ License \*---------------------------------------------------------------------------*/ #include "basicMixture.H" -#include "fvMesh.H" // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // namespace Foam { -// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // - -defineTypeNameAndDebug(basicMixture, 0); - -// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // - -basicMixture::basicMixture(const dictionary&, const fvMesh&) -{} - - -// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // - -basicMixture::~basicMixture() -{} - - // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace Foam diff --git a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.H b/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.H index f918d99d7b..8d8ed84cb0 100644 --- a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.H +++ b/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixture.H @@ -35,8 +35,6 @@ SourceFiles #ifndef basicMixture_H #define basicMixture_H -#include "typeInfo.H" - // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // namespace Foam @@ -58,18 +56,11 @@ public: typedef basicMixture basicMixtureType; - // Runtime type information - TypeName("basicMixture"); - - // Constructors //- Construct from dictionary and mesh - basicMixture(const dictionary&, const fvMesh&); - - - //- Destructor - virtual ~basicMixture(); + basicMixture(const dictionary&, const fvMesh&) + {} }; diff --git a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixtures.C b/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixtures.C deleted file mode 100644 index ac7d3c65bd..0000000000 --- a/src/thermophysicalModels/basic/mixtures/basicMixture/basicMixtures.C +++ /dev/null @@ -1,253 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / F ield | OpenFOAM: The Open Source CFD Toolbox - \\ / O peration | - \\ / A nd | Copyright (C) 2011-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 . - -Description - Mixture instantiation - -\*---------------------------------------------------------------------------*/ - -#include "error.H" - -#include "basicMixture.H" -#include "makeBasicMixture.H" - -#include "specie.H" -#include "perfectGas.H" -#include "rhoConst.H" -#include "incompressiblePerfectGas.H" - -#include "eConstThermo.H" - -#include "hConstThermo.H" -#include "janafThermo.H" -#include "sensibleInternalEnergy.H" -#include "sensibleEnthalpy.H" -#include "thermo.H" - -#include "constTransport.H" -#include "sutherlandTransport.H" - -#include "icoPolynomial.H" -#include "hPolynomialThermo.H" -#include "polynomialTransport.H" - -#include "pureMixture.H" - -#include "addToRunTimeSelectionTable.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -namespace Foam -{ - -/* * * * * * * * * * * * * * * private static data * * * * * * * * * * * * * */ - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleEnthalpy, - hConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleEnthalpy, - hConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleEnthalpy, - janafThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleEnthalpy, - hConstThermo, - rhoConst, - specie -); - -makeBasicMixture -( - pureMixture, - polynomialTransport, - sensibleEnthalpy, - hPolynomialThermo, - icoPolynomial, - specie -); - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleEnthalpy, - hConstThermo, - incompressiblePerfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleEnthalpy, - hConstThermo, - incompressiblePerfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleEnthalpy, - janafThermo, - incompressiblePerfectGas, - specie -); - - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleInternalEnergy, - eConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleInternalEnergy, - eConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleInternalEnergy, - hConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleInternalEnergy, - hConstThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleInternalEnergy, - janafThermo, - perfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleInternalEnergy, - hConstThermo, - rhoConst, - specie -); - -makeBasicMixture -( - pureMixture, - polynomialTransport, - sensibleInternalEnergy, - hPolynomialThermo, - icoPolynomial, - specie -); - -makeBasicMixture -( - pureMixture, - constTransport, - sensibleInternalEnergy, - hConstThermo, - incompressiblePerfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleInternalEnergy, - hConstThermo, - incompressiblePerfectGas, - specie -); - -makeBasicMixture -( - pureMixture, - sutherlandTransport, - sensibleInternalEnergy, - janafThermo, - incompressiblePerfectGas, - specie -); - - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -} // End namespace Foam - -// ************************************************************************* // diff --git a/src/thermophysicalModels/basic/mixtures/basicMixture/makeBasicMixture.H b/src/thermophysicalModels/basic/mixtures/basicMixture/makeBasicMixture.H deleted file mode 100644 index 29e93165a2..0000000000 --- a/src/thermophysicalModels/basic/mixtures/basicMixture/makeBasicMixture.H +++ /dev/null @@ -1,54 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / F ield | OpenFOAM: The Open Source CFD Toolbox - \\ / O peration | - \\ / A nd | Copyright (C) 2011-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 . - -InClass - Foam::basicMixture - -Description - Macros for creating 'basic' mixtures for basic fluid thermo packages - -\*---------------------------------------------------------------------------*/ - -#ifndef makeBasicMixture_H -#define makeBasicMixture_H - -#include "basicMixture.H" -#include "addToRunTimeSelectionTable.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -#define makeBasicMixture(Mixture,Transport,Type,Thermo,EqnOfState,Specie) \ - \ -typedef \ - Mixture >, Type> > > \ - Mixture##Transport##Type##Thermo##EqnOfState##Specie; \ - \ -defineTemplateTypeNameAndDebugWithName \ - (Mixture##Transport##Type##Thermo##EqnOfState##Specie, \ - #Mixture"<"#Transport"<"#Thermo"<"#EqnOfState"<"#Specie">>,"#Type">>", 0) - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -#endif - -// ************************************************************************* // diff --git a/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.C b/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.C index 02d5ddafc5..bfd8ed2a8f 100644 --- a/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.C +++ b/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.C @@ -45,13 +45,6 @@ pureMixture::pureMixture {} -// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // - -template -pureMixture::~pureMixture() -{} - - // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // template diff --git a/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.H b/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.H index 5ed25b97f4..b2401e1123 100644 --- a/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.H +++ b/src/thermophysicalModels/basic/mixtures/pureMixture/pureMixture.H @@ -65,20 +65,12 @@ public: typedef ThermoType thermoType; - //- Runtime type information - TypeName("pureMixture"); - - // Constructors //- Construct from dictionary and mesh pureMixture(const dictionary&, const fvMesh&); - //- Destructor - virtual ~pureMixture(); - - // Member functions const ThermoType& cellMixture(const label) const diff --git a/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermo.C b/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermo.C index 134103106e..e9a6a2219e 100644 --- a/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermo.C +++ b/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermo.C @@ -70,6 +70,15 @@ Foam::psiThermo::psiThermo(const fvMesh& mesh) {} +Foam::autoPtr Foam::psiThermo::New +( + const fvMesh& mesh +) +{ + return NewThermo(mesh); +} + + // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // Foam::psiThermo::~psiThermo() diff --git a/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermoNew.C b/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermoNew.C deleted file mode 100644 index d0601fe15c..0000000000 --- a/src/thermophysicalModels/basic/psiThermo/psiThermo/psiThermoNew.C +++ /dev/null @@ -1,94 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / F ield | OpenFOAM: The Open Source CFD Toolbox - \\ / O peration | - \\ / A nd | Copyright (C) 2011-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 . - -\*---------------------------------------------------------------------------*/ - -#include "psiThermo.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -Foam::autoPtr Foam::psiThermo::New -( - const fvMesh& mesh -) -{ - IOdictionary thermoDict - ( - IOobject - ( - "thermophysicalProperties", - mesh.time().constant(), - mesh, - IOobject::MUST_READ_IF_MODIFIED, - IOobject::NO_WRITE, - false - ) - ); - - word thermoTypeName; - - if (thermoDict.isDict("thermoType")) - { - const dictionary& thermoTypeDict(thermoDict.subDict("thermoType")); - - word type(thermoTypeDict.lookup("type")); - word mixture(thermoTypeDict.lookup("mixture")); - word transport(thermoTypeDict.lookup("transport")); - word thermo(thermoTypeDict.lookup("thermo")); - word energy(thermoTypeDict.lookup("energy")); - word equationOfState(thermoTypeDict.lookup("equationOfState")); - word specie(thermoTypeDict.lookup("specie")); - - thermoTypeName = - type + '<' - + mixture + '<' - + transport + '<' - + thermo + '<' - + equationOfState + '<' - + specie + ">>," - + energy + ">>>"; - } - else - { - thermoTypeName = word(thermoDict.lookup("thermoType")); - } - - Info<< "Selecting thermodynamics package " << thermoTypeName << endl; - - fvMeshConstructorTable::iterator cstrIter = - fvMeshConstructorTablePtr_->find(thermoTypeName); - - if (cstrIter == fvMeshConstructorTablePtr_->end()) - { - FatalErrorIn("psiThermo::New(const fvMesh&)") - << "Unknown psiThermo type " << thermoTypeName << nl << nl - << "Valid psiThermo types are:" << nl - << fvMeshConstructorTablePtr_->sortedToc() << nl - << exit(FatalError); - } - - return autoPtr(cstrIter()(mesh)); -} - - -// ************************************************************************* // diff --git a/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermo.C b/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermo.C index a43347cb91..ababc128c2 100644 --- a/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermo.C +++ b/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermo.C @@ -130,6 +130,15 @@ Foam::rhoThermo::rhoThermo(const fvMesh& mesh, const dictionary& dict) {} +Foam::autoPtr Foam::rhoThermo::New +( + const fvMesh& mesh +) +{ + return NewThermo(mesh); +} + + // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // Foam::rhoThermo::~rhoThermo() diff --git a/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermoNew.C b/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermoNew.C deleted file mode 100644 index cf46160a58..0000000000 --- a/src/thermophysicalModels/basic/rhoThermo/rhoThermo/rhoThermoNew.C +++ /dev/null @@ -1,72 +0,0 @@ -/*---------------------------------------------------------------------------*\ - ========= | - \\ / F ield | OpenFOAM: The Open Source CFD Toolbox - \\ / O peration | - \\ / A nd | Copyright (C) 2011-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 . - -\*---------------------------------------------------------------------------*/ - -#include "rhoThermo.H" - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - -Foam::autoPtr Foam::rhoThermo::New -( - const fvMesh& mesh -) -{ - // get model name, but do not register the dictionary - // otherwise it is registered in the database twice - const word modelType - ( - IOdictionary - ( - IOobject - ( - "thermophysicalProperties", - mesh.time().constant(), - mesh, - IOobject::MUST_READ_IF_MODIFIED, - IOobject::NO_WRITE, - false - ) - ).lookup("thermoType") - ); - - Info<< "Selecting thermodynamics package " << modelType << endl; - - fvMeshConstructorTable::iterator cstrIter = - fvMeshConstructorTablePtr_->find(modelType); - - if (cstrIter == fvMeshConstructorTablePtr_->end()) - { - FatalErrorIn("rhoThermo::New(const fvMesh&)") - << "Unknown rhoThermo type " - << modelType << nl << nl - << "Valid rhoThermo types are:" << nl - << fvMeshConstructorTablePtr_->sortedToc() << nl - << exit(FatalError); - } - - return autoPtr(cstrIter()(mesh)); -} - - -// ************************************************************************* // From 7b4724b32dcf6498f56ccadf527d0d5f5cadec54 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 12:28:31 +0100 Subject: [PATCH 101/109] ENH: Added calculation for Eotvos number --- .../Templates/KinematicParcel/KinematicParcel.H | 8 ++++++++ .../Templates/KinematicParcel/KinematicParcelI.H | 13 +++++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H index 4d7af077d4..ee860ad478 100644 --- a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H @@ -572,6 +572,14 @@ public: const scalar sigma // particle surface tension ) const; + //- Eotvos number + inline scalar Eo + ( + const vector& a, // acceleration + const scalar d, // particle diameter + const scalar sigma // particle surface tension + ) const; + // Main calculation loop diff --git a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H index 4e4e0bf7be..f1b58c79ca 100644 --- a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H +++ b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H @@ -567,4 +567,17 @@ inline Foam::scalar Foam::KinematicParcel::We } +template +inline Foam::scalar Foam::KinematicParcel::Eo +( + const vector& a, + const scalar d, + const scalar sigma +) const +{ + vector dir = U_/(mag(U_) + ROOTVSMALL); + return mag(a & dir)*(rho_ - rhoc_)*sqr(d)/(sigma + ROOTVSMALL); +} + + // ************************************************************************* // From 8904127ebad6bd7a8d8d069c615241965230181c Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 12:29:03 +0100 Subject: [PATCH 102/109] ENH: Added base class for particle lift forces --- .../ParticleForces/Lift/LiftForce/LiftForce.C | 150 +++++++++++++++++ .../ParticleForces/Lift/LiftForce/LiftForce.H | 155 ++++++++++++++++++ .../Lift/LiftForce/LiftForceI.H | 46 ++++++ 3 files changed, 351 insertions(+) create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.C create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForceI.H diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.C b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.C new file mode 100644 index 0000000000..290d2f3c3d --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.C @@ -0,0 +1,150 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "LiftForce.H" +#include "fvcCurl.H" + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +template +Foam::scalar Foam::LiftForce::LiftForce::Cl +( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc +) const +{ + // dummy + return 0.0; +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +template +Foam::LiftForce::LiftForce +( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType +) +: + ParticleForce(owner, mesh, dict, forceType, true), + UName_(this->coeffs().template lookupOrDefault("U", "U")), + curlUcInterpPtr_(NULL) +{} + + +template +Foam::LiftForce::LiftForce(const LiftForce& lf) +: + ParticleForce(lf), + UName_(lf.UName_), + curlUcInterpPtr_(NULL) +{} + + +// * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * // + +template +Foam::LiftForce::~LiftForce() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +template +void Foam::LiftForce::cacheFields(const bool store) +{ + static word fName("curlUcDt"); + + bool fieldExists = this->mesh().template foundObject(fName); + + if (store) + { + if (!fieldExists) + { + const volVectorField& Uc = this->mesh().template + lookupObject(UName_); + + volVectorField* curlUcPtr = + new volVectorField(fName, fvc::curl(Uc)); + + curlUcPtr->store(); + } + + const volVectorField& curlUc = this->mesh().template + lookupObject(fName); + + curlUcInterpPtr_.reset + ( + interpolation::New + ( + this->owner().solution().interpolationSchemes(), + curlUc + ).ptr() + ); + } + else + { + curlUcInterpPtr_.clear(); + + if (fieldExists) + { + const volVectorField& curlUc = this->mesh().template + lookupObject(fName); + + const_cast(curlUc).checkOut(); + } + } +} + + +template +Foam::forceSuSp Foam::LiftForce::calcCoupled +( + const typename CloudType::parcelType& p, + const scalar dt, + const scalar mass, + const scalar Re, + const scalar muc +) const +{ + forceSuSp value(vector::zero, 0.0); + + vector curlUc = + curlUcInterp().interpolate(p.position(), p.currentTetIndices()); + + scalar Cl = this->Cl(p, curlUc, Re, muc); + + value.Su() = mass/p.rho()*p.d()/2.0*p.rhoc()*Cl*((p.Uc() - p.U())^curlUc); + + return value; +} + + +// ************************************************************************* // diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H new file mode 100644 index 0000000000..1f3af598c5 --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H @@ -0,0 +1,155 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Class + Foam::LiftForce + +Description + Base class for particle lift force models + +SourceFiles + LiftForceI.H + LiftForce.C + +\*---------------------------------------------------------------------------*/ + +#ifndef LiftForce_H +#define LiftForce_H + +#include "ParticleForce.H" +#include "volFields.H" +#include "interpolation.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class LiftForce Declaration +\*---------------------------------------------------------------------------*/ + +template +class LiftForce +: + public ParticleForce +{ +protected: + + // Protected data + + //- Name of velocity field + const word UName_; + + //- Curk of carrier phase velocity interpolator + autoPtr > curlUcInterpPtr_; + + + // Potected Member Functions + + //- Calculate the lift coefficient + virtual scalar Cl + ( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc + ) const; + + +public: + + //- Runtime type information + TypeName("pressureGradient"); + + + // Constructors + + //- Construct from mesh + LiftForce + ( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType = typeName + ); + + //- Construct copy + LiftForce(const LiftForce& lf); + + //- Construct and return a clone + virtual autoPtr > clone() const + { + return autoPtr > + ( + new LiftForce(*this) + ); + } + + + //- Destructor + virtual ~LiftForce(); + + + // Member Functions + + // Access + + //- Return the curl of the carrier phase velocity interpolator + inline const interpolation& curlUcInterp() const; + + + // Evaluation + + //- Cache fields + virtual void cacheFields(const bool store); + + //- Calculate the non-coupled force + virtual forceSuSp calcCoupled + ( + const typename CloudType::parcelType& p, + const scalar dt, + const scalar mass, + const scalar Re, + const scalar muc + ) const; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#include "LiftForceI.H" + +#ifdef NoRepository + #include "LiftForce.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForceI.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForceI.H new file mode 100644 index 0000000000..00c3c7813a --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForceI.H @@ -0,0 +1,46 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +template +inline const Foam::interpolation& +Foam::LiftForce::curlUcInterp() const +{ + if (!curlUcInterpPtr_.valid()) + { + FatalErrorIn + ( + "inline const Foam::interpolation&" + "Foam::LiftForce::curlUcInterp() const" + ) << "Carrier phase curlUc interpolation object not set" + << abort(FatalError); + } + + return curlUcInterpPtr_(); +} + + +// ************************************************************************* // From 9900d16178af471d79268bf7848d70baf52006f0 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 12:29:35 +0100 Subject: [PATCH 103/109] ENH: Added particle Saffman-Mei lift force --- .../Lift/SaffmanMeiLift/SaffmanMeiLiftForce.C | 93 ++++++++++++++ .../Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H | 117 ++++++++++++++++++ 2 files changed, 210 insertions(+) create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.C create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.C b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.C new file mode 100644 index 0000000000..d6d8dda976 --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.C @@ -0,0 +1,93 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "SaffmanMeiLiftForce.H" +#include "mathematicalConstants.H" + +using namespace Foam::constant; + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +template +Foam::scalar Foam::SaffmanMeiLiftForce::SaffmanMeiLiftForce::Cl +( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc +) const +{ + scalar Rew = p.rhoc()*mag(curlUc)*sqr(p.d())/(muc + ROOTVSMALL); + scalar beta = 0.5*(Rew/(Re + ROOTVSMALL)); + scalar alpha = 0.3314*sqrt(beta); + scalar f = (1.0 - alpha)*exp(-0.1*Re) + alpha; + + scalar Cld = 0.0; + if (Re < 40) + { + Cld = 6.46*f; + } + else + { + Cld = 6.46*0.0524*sqrt(beta*Re); + } + + return 3.0/(mathematical::twoPi*sqrt(Rew))*Cld; +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +template +Foam::SaffmanMeiLiftForce::SaffmanMeiLiftForce +( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType +) +: + LiftForce(owner, mesh, dict, forceType) +{} + + +template +Foam::SaffmanMeiLiftForce::SaffmanMeiLiftForce +( + const SaffmanMeiLiftForce& lf +) +: + LiftForce(lf) +{} + + +// * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * // + +template +Foam::SaffmanMeiLiftForce::~SaffmanMeiLiftForce() +{} + + +// ************************************************************************* // diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H new file mode 100644 index 0000000000..66d29416b9 --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H @@ -0,0 +1,117 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Class + Foam::SaffmanMeiLiftForce + +Description + Saffman-Mei particle lift force model applicable to spherical particles. + +SourceFiles + SaffmanMeiLiftForce.C + +\*---------------------------------------------------------------------------*/ + +#ifndef SaffmanMeiLiftForce_H +#define SaffmanMeiLiftForce_H + +#include "LiftForce.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class SaffmanMeiLiftForce Declaration +\*---------------------------------------------------------------------------*/ + +template +class SaffmanMeiLiftForce +: + public LiftForce +{ +protected: + + // Protected Member Functions + + //- Calculate the lift coefficient + virtual scalar Cl + ( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc + ) const; + + +public: + + //- Runtime type information + TypeName("SaffmanMeiLiftForce"); + + + // Constructors + + //- Construct from mesh + SaffmanMeiLiftForce + ( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType = typeName + ); + + //- Construct copy + SaffmanMeiLiftForce(const SaffmanMeiLiftForce& lf); + + //- Construct and return a clone + virtual autoPtr > clone() const + { + return autoPtr > + ( + new SaffmanMeiLiftForce(*this) + ); + } + + + //- Destructor + virtual ~SaffmanMeiLiftForce(); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "SaffmanMeiLiftForce.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // From 2ad8b203746c962e3c8269b48d2c7b4fd39858a6 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 12:29:54 +0100 Subject: [PATCH 104/109] ENH: Added particle Tomiyama lift force --- .../Lift/TomiyamaLift/TomiyamaLiftForce.C | 95 ++++++++++++++ .../Lift/TomiyamaLift/TomiyamaLiftForce.H | 123 ++++++++++++++++++ 2 files changed, 218 insertions(+) create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.C create mode 100644 src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.C b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.C new file mode 100644 index 0000000000..87c482bec5 --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.C @@ -0,0 +1,95 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +\*---------------------------------------------------------------------------*/ + +#include "TomiyamaLiftForce.H" + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +template +Foam::scalar Foam::TomiyamaLiftForce::TomiyamaLiftForce::Cl +( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc +) const +{ + const vector& g = this->owner().g().value(); + + scalar Eo = p.Eo(g, p.d(), sigma_); + scalar dH = p.d()*cbrt(1.0 + 0.163*pow(Eo, 0.757)); + scalar Eod = p.Eo(g, dH, sigma_); + scalar f = 0.00105*pow3(Eod) - 0.0159*sqr(Eod) - 0.0204*Eod + 0.474; + + if (Eod <= 4) + { + return min(0.288*tanh(0.121*Re), f); + } + else if ((Eod > 4) && (Eod <= 10)) + { + return f; + } + else + { + return -0.27; + } +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +template +Foam::TomiyamaLiftForce::TomiyamaLiftForce +( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType +) +: + LiftForce(owner, mesh, dict, forceType), + sigma_(readScalar(this->coeffs().lookup("sigma"))) +{} + + +template +Foam::TomiyamaLiftForce::TomiyamaLiftForce +( + const TomiyamaLiftForce& lf +) +: + LiftForce(lf), + sigma_(lf.sigma_) +{} + + +// * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * // + +template +Foam::TomiyamaLiftForce::~TomiyamaLiftForce() +{} + + +// ************************************************************************* // diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H new file mode 100644 index 0000000000..3edf43b0a3 --- /dev/null +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H @@ -0,0 +1,123 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 . + +Class + Foam::TomiyamaLiftForce + +Description + Tomiyama particle lift force model applicable to deformable bubbles. + +SourceFiles + TomiyamaLiftForce.C + +\*---------------------------------------------------------------------------*/ + +#ifndef TomiyamaLiftForce_H +#define TomiyamaLiftForce_H + +#include "LiftForce.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class TomiyamaLiftForce Declaration +\*---------------------------------------------------------------------------*/ + +template +class TomiyamaLiftForce +: + public LiftForce +{ +protected: + + // Protected data + + //- Surface tension + scalar sigma_; + + + // Protected Member Functions + + //- Calculate the lift coefficient + virtual scalar Cl + ( + const typename CloudType::parcelType& p, + const vector& curlUc, + const scalar Re, + const scalar muc + ) const; + + +public: + + //- Runtime type information + TypeName("TomiyamaLift"); + + + // Constructors + + //- Construct from mesh + TomiyamaLiftForce + ( + CloudType& owner, + const fvMesh& mesh, + const dictionary& dict, + const word& forceType = typeName + ); + + //- Construct copy + TomiyamaLiftForce(const TomiyamaLiftForce& lf); + + //- Construct and return a clone + virtual autoPtr > clone() const + { + return autoPtr > + ( + new TomiyamaLiftForce(*this) + ); + } + + + //- Destructor + virtual ~TomiyamaLiftForce(); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "TomiyamaLiftForce.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // From e1d4e5d41ddb5e95792da4ad0c2e1c19704579bb Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 12:30:21 +0100 Subject: [PATCH 105/109] ENH: Added new particle lift force models to particle tables --- .../intermediate/parcels/include/makeParcelForces.H | 5 +++++ .../intermediate/parcels/include/makeThermoParcelForces.H | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/src/lagrangian/intermediate/parcels/include/makeParcelForces.H b/src/lagrangian/intermediate/parcels/include/makeParcelForces.H index 7658900598..9516b16a00 100644 --- a/src/lagrangian/intermediate/parcels/include/makeParcelForces.H +++ b/src/lagrangian/intermediate/parcels/include/makeParcelForces.H @@ -31,6 +31,9 @@ License #include "SphereDragForce.H" #include "NonSphereDragForce.H" +#include "SaffmanMeiLiftForce.H" +#include "TomiyamaLiftForce.H" + #include "GravityForce.H" #include "NonInertialFrameForce.H" #include "ParamagneticForce.H" @@ -45,6 +48,8 @@ License makeParticleForceModel(CloudType); \ makeParticleForceModelType(SphereDragForce, CloudType); \ makeParticleForceModelType(NonSphereDragForce, CloudType); \ + makeParticleForceModelType(SaffmanMeiLiftForce, CloudType); \ + makeParticleForceModelType(TomiyamaLiftForce, CloudType); \ makeParticleForceModelType(GravityForce, CloudType); \ makeParticleForceModelType(NonInertialFrameForce, CloudType); \ makeParticleForceModelType(ParamagneticForce, CloudType); \ diff --git a/src/lagrangian/intermediate/parcels/include/makeThermoParcelForces.H b/src/lagrangian/intermediate/parcels/include/makeThermoParcelForces.H index dff1f464a1..29b3d6acfe 100644 --- a/src/lagrangian/intermediate/parcels/include/makeThermoParcelForces.H +++ b/src/lagrangian/intermediate/parcels/include/makeThermoParcelForces.H @@ -31,6 +31,9 @@ License #include "SphereDragForce.H" #include "NonSphereDragForce.H" +#include "SaffmanMeiLiftForce.H" +#include "TomiyamaLiftForce.H" + #include "BrownianMotionForce.H" #include "GravityForce.H" #include "NonInertialFrameForce.H" @@ -46,6 +49,8 @@ License makeParticleForceModel(CloudType); \ makeParticleForceModelType(SphereDragForce, CloudType); \ makeParticleForceModelType(NonSphereDragForce, CloudType); \ + makeParticleForceModelType(SaffmanMeiLiftForce, CloudType); \ + makeParticleForceModelType(TomiyamaLiftForce, CloudType); \ makeParticleForceModelType(BrownianMotionForce, CloudType); \ makeParticleForceModelType(GravityForce, CloudType); \ makeParticleForceModelType(NonInertialFrameForce, CloudType); \ From e4ac87231e5cf41b86956fd4f06fa3ca1942f4bf Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 13:03:55 +0100 Subject: [PATCH 106/109] STYLE: Code comment corrections --- src/lagrangian/intermediate/submodels/SubModelBase.H | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/lagrangian/intermediate/submodels/SubModelBase.H b/src/lagrangian/intermediate/submodels/SubModelBase.H index bc073213c7..54b42b5a8a 100644 --- a/src/lagrangian/intermediate/submodels/SubModelBase.H +++ b/src/lagrangian/intermediate/submodels/SubModelBase.H @@ -163,23 +163,23 @@ public: //- Return non-const access to the owner cloud for manipulation CloudType& owner(); - //- Retrieve generic property from sub-model + //- Retrieve generic property from the sub-model template Type getModelProperty(const word& entryName) const; - //- Retrieve generic property from sub-model + //- Retrieve generic property from the sub-model template void getModelProperty(const word& entryName, Type& value) const; - //- Add generic property from sub-model + //- Add generic property to the sub-model template void setModelProperty(const word& entryName, const Type& value); - //- Retrieve generic property from base model + //- Retrieve generic property from the base model template Type getBaseProperty(const word& entryName) const; - //- Add generic property from base model + //- Add generic property to the base model template void setBaseProperty(const word& entryName, const Type& value); From b62940d4e5ac3dd13d555f8240f7f4450ed2df5e Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 13:58:23 +0100 Subject: [PATCH 107/109] ENH: Removed unnecessary type info --- .../Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H index 1f3af598c5..13cab0ac54 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H @@ -79,10 +79,6 @@ protected: public: - //- Runtime type information - TypeName("pressureGradient"); - - // Constructors //- Construct from mesh @@ -91,7 +87,7 @@ public: CloudType& owner, const fvMesh& mesh, const dictionary& dict, - const word& forceType = typeName + const word& forceType ); //- Construct copy From 1f568c2194452f05f6c945b5372915d388c1b8b1 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 13:58:50 +0100 Subject: [PATCH 108/109] ENH: Extended particle sub model base API --- .../intermediate/submodels/SubModelBase.C | 28 +++++++++-- .../intermediate/submodels/SubModelBase.H | 47 +++++++++++++------ 2 files changed, 56 insertions(+), 19 deletions(-) diff --git a/src/lagrangian/intermediate/submodels/SubModelBase.C b/src/lagrangian/intermediate/submodels/SubModelBase.C index 952abaf5bb..2df1f5207c 100644 --- a/src/lagrangian/intermediate/submodels/SubModelBase.C +++ b/src/lagrangian/intermediate/submodels/SubModelBase.C @@ -199,10 +199,11 @@ template template Type Foam::SubModelBase::getBaseProperty ( - const word& entryName + const word& entryName, + const Type& defaultValue ) const { - Type result = pTraits::zero; + Type result = defaultValue; const dictionary& properties = this->owner().outputProperties(); @@ -216,6 +217,24 @@ Type Foam::SubModelBase::getBaseProperty } +template +template +void Foam::SubModelBase::getBaseProperty +( + const word& entryName, + Type& value +) const +{ + const dictionary& properties = this->owner().outputProperties(); + + if (properties.found(baseName_)) + { + const dictionary& baseDict = properties.subDict(baseName_); + baseDict.readIfPresent(entryName, value); + } +} + + template template void Foam::SubModelBase::setBaseProperty @@ -243,10 +262,11 @@ template template Type Foam::SubModelBase::getModelProperty ( - const word& entryName + const word& entryName, + const Type& defaultValue ) const { - Type result = pTraits::zero; + Type result = defaultValue; const dictionary& properties = this->owner().outputProperties(); diff --git a/src/lagrangian/intermediate/submodels/SubModelBase.H b/src/lagrangian/intermediate/submodels/SubModelBase.H index 54b42b5a8a..0427c162f7 100644 --- a/src/lagrangian/intermediate/submodels/SubModelBase.H +++ b/src/lagrangian/intermediate/submodels/SubModelBase.H @@ -163,25 +163,42 @@ public: //- Return non-const access to the owner cloud for manipulation CloudType& owner(); - //- Retrieve generic property from the sub-model - template - Type getModelProperty(const word& entryName) const; + // Base properties - //- Retrieve generic property from the sub-model - template - void getModelProperty(const word& entryName, Type& value) const; + //- Retrieve generic property from the base model + template + Type getBaseProperty + ( + const word& entryName, + const Type& defaultValue = pTraits::zero + ) const; - //- Add generic property to the sub-model - template - void setModelProperty(const word& entryName, const Type& value); + //- Retrieve generic property from the base model + template + void getBaseProperty(const word& entryName, Type& value) const; - //- Retrieve generic property from the base model - template - Type getBaseProperty(const word& entryName) const; + //- Add generic property to the base model + template + void setBaseProperty(const word& entryName, const Type& value); - //- Add generic property to the base model - template - void setBaseProperty(const word& entryName, const Type& value); + + // Model properties + + //- Retrieve generic property from the sub-model + template + Type getModelProperty + ( + const word& entryName, + const Type& defaultValue = pTraits::zero + ) const; + + //- Retrieve generic property from the sub-model + template + void getModelProperty(const word& entryName, Type& value) const; + + //- Add generic property to the sub-model + template + void setModelProperty(const word& entryName, const Type& value); // I-O From cb29fc7c1ca94800449fbcb45e00cec3bc0947fe Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 27 Sep 2012 15:09:32 +0100 Subject: [PATCH 109/109] ENH: restructured pv reader interface --- .../PV3FoamReader/pqPV3FoamReaderPanel.cxx | 149 +++++++++++------- 1 file changed, 88 insertions(+), 61 deletions(-) diff --git a/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/PV3FoamReader/pqPV3FoamReaderPanel.cxx b/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/PV3FoamReader/pqPV3FoamReaderPanel.cxx index babdd460c9..f795ed8eec 100644 --- a/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/PV3FoamReader/pqPV3FoamReaderPanel.cxx +++ b/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/PV3FoamReader/pqPV3FoamReaderPanel.cxx @@ -62,6 +62,9 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel QGridLayout* form = new QGridLayout(); this->PanelLayout->addLayout(form, 0, 0, 1, -1); + // ROW 0 + // ~~~~~ + vtkSMProperty* prop = 0; // refresh button for updating times/fields @@ -107,10 +110,16 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); } + // ROW 1 + // ~~~~~ + QFrame* hline1 = new QFrame(this); hline1->setFrameStyle(QFrame::HLine | QFrame::Sunken); form->addWidget(hline1, 1, 0, 1, 3); + // ROW 2 + // ~~~~~ + // checkbox for caching mesh if ((prop = this->proxy()->GetProperty("UiCacheMesh")) != 0) { @@ -137,62 +146,10 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); } + // cell 2,1 empty - // checkbox for patch names - if ((prop = this->proxy()->GetProperty("UiShowPatchNames")) != 0) - { - // immediate update on the Server Manager side - prop->SetImmediateUpdate(true); - - ShowPatchNames_ = new QCheckBox("Patch Names"); - ShowPatchNames_->setChecked - ( - vtkSMIntVectorProperty::SafeDownCast(prop)->GetElement(0) - ); - ShowPatchNames_->setToolTip - ( - "Show patch names in render window." - ); - - // row/col 0,1 - form->addWidget(ShowPatchNames_, 2, 1, Qt::AlignLeft); - connect - ( - ShowPatchNames_, - SIGNAL(stateChanged(int)), - this, - SLOT(ShowPatchNamesToggled()) - ); - } - - - // checkbox for Groups Only - if ((prop = this->proxy()->GetProperty("UiShowGroupsOnly")) != 0) - { - // immediate update on the Server Manager side - prop->SetImmediateUpdate(true); - - ShowGroupsOnly_ = new QCheckBox("Groups Only"); - ShowGroupsOnly_->setChecked - ( - vtkSMIntVectorProperty::SafeDownCast(prop)->GetElement(0) - ); - ShowGroupsOnly_->setToolTip - ( - "Show patchGroups only." - ); - - // row/col 2, 2 - form->addWidget(ShowGroupsOnly_, 2, 2, Qt::AlignLeft); - connect - ( - ShowGroupsOnly_, - SIGNAL(stateChanged(int)), - this, - SLOT(ShowGroupsOnlyToggled()) - ); - } - + // ROW 3 + // ~~~~~ // checkbox for include sets if ((prop = this->proxy()->GetProperty("UiIncludeSets")) != 0) @@ -221,6 +178,36 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); } + // checkbox for Groups Only + if ((prop = this->proxy()->GetProperty("UiShowGroupsOnly")) != 0) + { + // immediate update on the Server Manager side + prop->SetImmediateUpdate(true); + + ShowGroupsOnly_ = new QCheckBox("Groups Only"); + ShowGroupsOnly_->setChecked + ( + vtkSMIntVectorProperty::SafeDownCast(prop)->GetElement(0) + ); + ShowGroupsOnly_->setToolTip + ( + "Show patchGroups only." + ); + + // row/col 2, 2 + form->addWidget(ShowGroupsOnly_, 3, 1, Qt::AlignLeft); + connect + ( + ShowGroupsOnly_, + SIGNAL(stateChanged(int)), + this, + SLOT(ShowGroupsOnlyToggled()) + ); + } + + + // ROW 4 + // ~~~~~ // checkbox for include zones if ((prop = this->proxy()->GetProperty("UiIncludeZones")) != 0) @@ -240,7 +227,7 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); // row/col 1,1 - form->addWidget(IncludeZones_, 3, 1, Qt::AlignLeft); + form->addWidget(IncludeZones_, 4, 0, Qt::AlignLeft); connect ( IncludeZones_, @@ -250,6 +237,43 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); } + // checkbox for patch names + if ((prop = this->proxy()->GetProperty("UiShowPatchNames")) != 0) + { + // immediate update on the Server Manager side + prop->SetImmediateUpdate(true); + + ShowPatchNames_ = new QCheckBox("Patch Names"); + ShowPatchNames_->setChecked + ( + vtkSMIntVectorProperty::SafeDownCast(prop)->GetElement(0) + ); + ShowPatchNames_->setToolTip + ( + "Show patch names in render window." + ); + + // row/col 0,1 + form->addWidget(ShowPatchNames_, 4, 1, Qt::AlignLeft); + connect + ( + ShowPatchNames_, + SIGNAL(stateChanged(int)), + this, + SLOT(ShowPatchNamesToggled()) + ); + } + + // ROW 5 + // ~~~~~ + + QFrame* hline2 = new QFrame(this); + hline2->setFrameStyle(QFrame::HLine | QFrame::Sunken); + form->addWidget(hline2, 5, 0, 1, 3); + + // ROW 6 + // ~~~~~ + // checkbox for vol field interpolation if ((prop = this->proxy()->GetProperty("UiInterpolateVolFields")) != 0) { @@ -267,7 +291,7 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); // row/col 1,1 - form->addWidget(InterpolateVolFields_, 4, 0, Qt::AlignLeft); + form->addWidget(InterpolateVolFields_, 6, 0, Qt::AlignLeft); connect ( InterpolateVolFields_, @@ -294,7 +318,7 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); // row/col 1,1 - form->addWidget(ExtrapolatePatches_, 4, 1, Qt::AlignLeft); + form->addWidget(ExtrapolatePatches_, 6, 1, Qt::AlignLeft); connect ( ExtrapolatePatches_, @@ -304,9 +328,12 @@ pqPV3FoamReaderPanel::pqPV3FoamReaderPanel ); } - QFrame* hline2 = new QFrame(this); - hline2->setFrameStyle(QFrame::HLine | QFrame::Sunken); - form->addWidget(hline2, 5, 0, 1, 3); + // ROW 7 + // ~~~~~ + + QFrame* hline3 = new QFrame(this); + hline3->setFrameStyle(QFrame::HLine | QFrame::Sunken); + form->addWidget(hline3, 7, 0, 1, 3); }