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