diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H index 0e93e3e3b354dc7a71c3aaa224ee3fd50dc98d7d..2e0930123294d0a3cde7550cc1bbe25dc23bda6e 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 <http://www.gnu.org/licenses/>. +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + \defgroup grpFunctionObjects Function objects @{ This group contains function objects diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H index 1a38387f5aef4fa9d2a0c27b840d4918f189471a..27389e27a0b33cc9b2e649b6f1941063fae5438d 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 <http://www.gnu.org/licenses/>. +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + \mainpage OpenFOAM®: open source CFD \section about About OpenFOAM @@ -34,4 +36,28 @@ License turbulence and heat transfer, to solid dynamics and electromagnetics. <a href="http://www.openfoam.org/features">More ...</a> +\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 a4076f6fcf1205c89f27833fa2211a35a8a9a6a4..2e19ff1d2c520832784d2760dab818b1c04d9c46 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 <http://www.gnu.org/licenses/>. -\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 15dc9e2d5fe05493b0565232990b6470aa0b7384..b7163e5bc017f0f7d1cc709cc43a5b7afb84db18 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 <http://www.gnu.org/licenses/>. -\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 4730fe1f1dd55ffba8c8ee851e640de7013faec2..1f2dcbfb61400aa80421f8e878ad5668887b27ac 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 <http://www.gnu.org/licenses/>. -\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 d480f24adc1a357f1a839e4789857cb843cbdf2e..54686db761485553f2d703334e88056426e77e73 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 <http://www.gnu.org/licenses/>. -\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 f22106bd3a0961b7ce06d06f97b1f917f1a33a06..6290d8f5a540ad8f61e5ee53294f96e08dd3fbf6 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 <http://www.gnu.org/licenses/>. -\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 8fe16727d99f6080bfe654c87885007b57903041..50b986a760e605bfb008cc219a11da797fbc0f38 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 <http://www.gnu.org/licenses/>. -\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 c4dbe2120475b6f3af1a472cf54485bbfc405ed0..193dd6cb4da11107c61b3bee0e5d51be3b29f830 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 <http://www.gnu.org/licenses/>. -\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 e245db2450fd04d868456202e8f04c55e703a2f1..06671ea1326fe3b52df4ae591720781e6b77362d 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 <http://www.gnu.org/licenses/>. -\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 b5d163efbbff4062aec944caf0eafdc558056201..0eab206104500c5517cee3c591fc1e17dd23f2fc 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 <http://www.gnu.org/licenses/>. -\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 ae03fced6c0c9ff404849d6e56481da7b33260d7..90f1dc25c67e7b5e200b01184829db16891c4a86 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 <http://www.gnu.org/licenses/>. -\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 783e0a6b60ba2c461fe14f2628f22d7d91b76776..073f5015a40e243a40202078fa23dc3df3eed9d4 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 <http://www.gnu.org/licenses/>. -\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 5c5a7d25d40833147b41549753b234d3f7fa470f..ac2e44292102cdcac84e66fd76646082b183fd4b 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 <http://www.gnu.org/licenses/>. -\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 38e633fc958ab309239e08f7d1476a281b575345..3f77c1f8fc4681111d82b400fbd6ce0e211d34a7 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 <http://www.gnu.org/licenses/>. -\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 a7ef6a816d37d344ef61370a6716ab8108dddad4..9f1e8caf0133b2106a7879e341bb730385031575 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 <http://www.gnu.org/licenses/>. -\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 98f4ea45fe9484e5ec732520a675ea340c4ecc02..a5fd2343bfbf2fdfe13cc55cfbe5e12f4686abe6 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 <http://www.gnu.org/licenses/>. -\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 7d42a6aac0d73f1ec71f9b79edf196438bf18dc3..576d4d08335b1f60cb6cea71961e97f335d18fe1 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 <http://www.gnu.org/licenses/>. -\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 649202cd201f2e014ece3fa18cf3375aca77f35c..6278a3567f35f59f1004a6ba99eb92d1728e1663 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 <http://www.gnu.org/licenses/>. -\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 0828c8ceb3a71fb81fee3cf6160ba84a30fd3f5a..12ad60fcbc85751ca658a6a57bf8eba43e9aa2fc 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 <http://www.gnu.org/licenses/>. -\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 8087f248af872fc01c34dbcc4731f7e64fc0ebaa..26fa081eb7ebaf1a849e45d1344e36829fb3e72e 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 <http://www.gnu.org/licenses/>. -\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 d539700e2c952636545ca00192a0a6e73d28a7ad..de4072625b0e1595b1f4a7628ca27277b49cb0e2 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 <http://www.gnu.org/licenses/>. -\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 e5fc8c3c15d6b4c6309871920801da3bccd06563..08423e848f4fc2b6d5682f5af08d999ebdb2a338 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 350f2113a11e793acee58a512c23c3885aa86279..09578524280d1d35cba833d82ddd04621aae612f 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 9a87eaf77d7631c27c314544fbecdcc21fcd1bbe..b5f143acac411b0467f62cc63baaad5b85008d3e 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 05e88b18cdfb76f3fb468151e52c86f21de54d0c..39e59bfcc60255c2286b1cb55f488d428150f20e 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 8bda7a79524a0e4804fed27f3e919c01428226e7..04c2562f4903a20181ee45bbea0e22f4c7080125 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 1d9ce49b8c9fb6ee7fb309760a6c517c6073058e..e35c4af2c3509b649f20f54a2756b28d45d9d39e 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 e9d2a3455b04e7f98c469a90295840ceae71dde6..6ffa995cdea22a43c9930ca46d572682c9f6d793 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 86d52ed1f0689644ab25ecc45cfe3a5f8f76fc4a..bb0f3574c748eb70314da2ba43c02ce8af2acba3 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 ad25e082ff57447673825b5d0ffaf6dcf87e7081..a8124bb38b5bfe30e34b41d311ada6d31b0d06eb 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<fanFlowDirection, 2> 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 52768875e6588294be57f74eb4fd96fff994cca0..5bc8a2281c8a6af8e92d0df6bc4477c2bfdfad62 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 14103353587faa25bb6179688358088829bcaea2..868a3335657417f406c4468c3e831738f52eeba1 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 caaa8663067a22a787a6c029a85a15bd5d809750..983edbfa92eb512401158ff262be22a6122d93c1 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<type> diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index 7fd5c515a9f6bfb86a2a6017439d291fa976a568..bce30465cd8b164f06a2f502fa2ed68fbfbdaf22 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 1c387e48a513ea835005cb879dd381246e9c269a..21e4ae88ea4d51517160460c4a8c22afefb8806e 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 af16f8e2706cb8eab55f8a4d8b6d914cafd260ec..5f0cf8c403c88865591cd219e7637f3fb3f4f16c 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 9875120c182bad5777e4407adcbe33e558717480..dac06b8ba81306b56e2e80c6b3e7d5bdc0f344d7 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 37a508e5ef7981cdd51911b051b29ec3d842ba68..9e9e6b638ed8bf52a8897cc6617cffd8e0383060 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 90fae4911b2a493d10c32a4e33ad8fc71761ee63..57373b69cb3bd199896952cb260ad0f7beedc52f 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 d1f8214bc3220b8a8d821384a08304088b214d85..28eedd175283412b167ed901d0e9989c6b0ce431 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 1ba72744df6a5bc1b9a2d95821cc83f541dc0f94..b5b7fcf492f677170458ab3641a2893d9bbf16f4 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 ef2f279e2403657c61957e9d668dc7c9e8520fc2..d6487efc93c2e54d4344f717ee4c76cd0f9f38a2 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 8c9c39b9d5daf335d886211bd7b3a1e4867b814f..554f4ef868ce6d50af4e53007c94b0f22398e1d0 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 f5f2a5b167257bfeb8e2c6079c229f609b93792c..30dd2f27b975ad747d65159d8a5137c277bfc9c2 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 12aa98c6b81591b208f94d28193021322ea0cb66..45ee30032d586a9e8fedf8535c4fe5ec15b6911a 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 0a7e597e9a8bfeebb8902461edcdd68c9e926a02..4fc5f332ddfa6ec60323eacf8347b733b40d6fe3 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 253294c0cd787de00becaa83e2bd10dc167ec12f..76b5726e6eaa35a48db287db4c2055f7c5f8dee2 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 0dea9e1ed1509fff90b3dc29e3050ce05464c587..175d2cd386772d3be619175cc1470af53560fca2 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 daf1a77df4f991dc0fe60e34d96c3b570aa6f082..e4706c3d3728cf9bfedeb143fb8da9dd150d279a 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 a03bf05439535e7fbcdd5cb3b0a423dfdb4d8bb6..cf2b0c95b488fa334ab9dbd32c8491825e021734 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 4cb745fad53a9a333f73031d48c61a2b3cbe3264..d42c23f5ddf4c218b3146617805ae04583880393 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 13973910b10060f21632c767a212047e11c73fa3..a26db47e41c8c3802b57668717619a4be1450e15 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 4e5c3ff062d066c8d41e8556ea12427cd2866bba..8098a68b7e9fe4215202d9401aea5df4768be0a0 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 eb883458f702ee8c129d840b09c4fed5949866fd..8d081efa06bfa2c330cddc1e4e2ad98e18a51ff9 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 673e51c072f2803ad32c37bc61a373d1a4573151..0cdc4650f5d6813304066becacd9d93dacd3ce07 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 bfe5aab9f5a2e93c1104c4c92e946a2733a6bafd..c6e2a8c0c58098aa6d3c7cc7c976714fa008593a 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 c4c0a57092bae0147f475898fdf3bd89ee759760..47cfd0e22af32202c9c8d298116d821914c8b516 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 dab033544bcd513b45c6323e5f15685b4d18c9c6..128dc1ec26a5f216302e9cb76427c0d45f5458dc 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 71b4ce42381b38598ecf713cb638258bc6dd150a..a162c6d2547fdb97dc5bd07affc4e3365e02a681 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 ed9cf681886a0bf5cf2429c6af30d76a50e87709..56750ed0912b5682bc094db945643dbae320e0f7 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 3acb22984be878a960d6b157295c557c8a748a04..13bc501b21bd95b0408a5a37efa01a1e18d278e7 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 7cfb0c639af0f6eea827b14dcd4631f636e6d4a1..86ef8bc4e4bd18597ca16d068e9dd3ef63a3b554 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 2a5254195d0f248e99342e2cf6c529b481cb10fe..a48f2c37827730d4d46000b3f7d1f2093ed451af 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 29c9eb822cd1d28577d731729f0c1bde2d8d6aa1..c3000b4f15d10cee36d1b81152f27366fcf9a13a 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 bfdce14ba719e68b3dfa309c75368d2245faef34..5d7ae1dd7dcfdeefd72cb79045bae17218bfefd0 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 f216b358edd54b19018ed39032b48cafd354c136..1d936aa811ea85918aafd67bccaf3ce03c34bc47 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 fca7044c7801f7f8677ea6af5655da4746685445..e614212296463641c464eaa73cfa7d13c48bf8f1 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 5f223d6dbc6a80100951dc9a06314355774b9e6e..71200d9512153fd933aee4520cfa8556dd256f04 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 1be1e1ca923efc9e7404a7b0f736d3f58a08591f..d827e8cd46d31f501e5d63393db595e57ef6109c 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 8e40b42d9a27f08fab847af7561222c90cef8429..8fe219d412127cae9c526bb9941dffb751dbda4d 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 8433ddfa2142c2143bf53c157561ec70b363aac2..28719fd9642393672104e9740946ad1f1cb8bf80 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 9566c298b45e62b08b3a196c3d83525168286182..e6dc3fdc2b68acd039112f38475fcfed188a6c4f 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/<patchname> where: + constant/boundaryData/\<patchname\> 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 715c993cf4efbfe7bbc70554034a921c935a3cef..a98adc99107e1ef19d78d728f11705ea13eb61f4 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 c095b2fbd0f86d8875ee81fb1f8706473bffb029..465b02d370009d0b218facd61375b133e7a552e9 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 bff3ffeccb791dabe754a0ab27ddd7982f25c46b..821a6e36b5b5ae92c6a78140ef3f99ea28cd416b 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 2d61ae94d34caf5b27bdea8bfc6b9946294c1aad..8f30d3a6cc00d5aa4225b1ce14124b0bb1f6baf7 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 1774e06f02a8c7e60439bcdc5703ddd532c65215..b7acbae470b02475f9050eedb83e53aceddd932e 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 a8002088a22a7f20aa722af5ae4b80d3f6b7f86c..4c162ec16acbc374ef7b1bc4e3c88a243ecd2482 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 4953b2ef2c2ee0988ba0139b68435a014e9d798f..38a13d398d13b0f7111bf5b8ac80c0bd83fa92b2 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 4aab5f54fe665dad4116c3b66d320303242f2295..a23db5daa2ed46a5cb85ffc785f51aa80cf8f048 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 e9b764fe5364497d8b62ffe586615ba6d2e82fe0..67faf746de820c48f0116486758a28edd6a7a060 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 cef322e614526729930d201fa15214cad1c6ae1b..f14dc5c1b5ddfe419ebf411e7c88f4bf8feeccb9 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 feab7a21c0d5c1207098ba187b4bf53c81487adf..1687542e4978fe4b2372d5ce19ec74bb6e79b2ae 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 9e30f3701b3aec893f4d19a57e7ed5a08ae244dc..9940415bceac55676ead3bd627c3fbf5f20a713c 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 0000000000000000000000000000000000000000..89aef25aa3ea343ca5ade64f1b87dddf17aaa200 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 4918858612110fa4797734509babb5c96ba0c78e..e4461605f6a108da7e66a6854d78c97fd2c7800c 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 d2a878618b03da99e0acbf084bc6ccdfa679d630..bf0afd49a61cf46d2f3261b72ecf3dfb5b832fe4 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 <http://www.gnu.org/licenses/>. -\addtogroup grpIOFunctionObjects -@{ - Class Foam::partialWrite +\ingroup grpIOFunctionObjects + Description Allows some fields/registered objects to be written more often than others. @@ -36,7 +35,6 @@ Description SourceFiles partialWrite.C IOpartialWrite.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index 644f2f3853a92b5d6f92615956cb477c4e526a46..c621047a0be86c371e4e83d228a159a9ea624ef1 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 <http://www.gnu.org/licenses/>. -\addtogroup grpIOFunctionObjects -@{ - Class Foam::removeRegisteredObject +\ingroup grpIOFunctionObjects + Description Removes registered IO objects if present in the database SourceFiles removeRegisteredObject.C IOremoveRegisteredObject.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index aaaf68044ed3a4f6c387dc012c3907e4be7f9821..d894fb392d0987dafbce2ab6ef7577a042c822a1 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 <http://www.gnu.org/licenses/>. -\addtogroup grpIOFunctionObjects -@{ - Class Foam::writeRegisteredObject +\ingroup grpIOFunctionObjects + Description Takes over the writing of registered IO objects SourceFiles writeRegisteredObject.C IOwriteRegisteredObject.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 1c1494864e7ac358ac468f566f8fb71d56a8bd8f..f45591d92491aa31c45b2fcf3ba30f1a0e58ef57 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 <http://www.gnu.org/licenses/>. -\addtogroup grpCloudFunctionObjects -@{ - Class Foam::cloudInfo +\ingroup grpCloudFunctionObjects + Description This function object outputs lagrangian cloud information to a file. The current outputs include: @@ -36,7 +35,6 @@ Description SourceFiles cloudInfo.C IOcloudInfo.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 948733c18f738f75aadb0ef90374e778a98ae78a..ec00c2935926125b19c293680c651aec0a551e5f 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::fieldAverage +\ingroup grpFieldFunctionObjects + Description Calculates the field averages given list of fieldAverageItems, e.g. @@ -83,7 +82,6 @@ Description SourceFiles fieldAverage.C fieldAverageTemplates.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index c257b0617f51e4491f094a1cdcf5f2b650436d57..618b5da5744593c90f15b8e571f5d181caa23dde 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - class Foam::fieldCoordinateSystemTransform +\ingroup grpFieldFunctionObjects + Description Transforms fields from global cartesian co-ordinates to local co-ordinate system @@ -35,7 +34,6 @@ SourceFiles fieldCoordinateSystemTransform.C fieldCoordinateSystemTransformTemplates.C IOfieldCoordinateSystemTransform.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 55198bff72dcd5d4e57d14c81d0189773d273abd..15e25484febbf4e1c55d1a0ce9eaa484bbcc4b12 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::fieldMinMax +\ingroup grpFieldFunctionObjects + Description Calculates scalar minimim and maximum field values. @@ -39,7 +38,6 @@ Description SourceFiles fieldMinMax.C IOfieldMinMax.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index 414d19bbcf5bc17b7f92197e5501fafc8dadeb13..2c12c2d024116ddcb25ccfcd557f9105e56be1f4 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 <http://www.gnu.org/licenses/>. -\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 bbfc352afea80de27cb0ccc71aa968ef1534d370..151b8cd959c4e5da62f458d7fe83340c1614b2af 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::nearWallFields +\ingroup grpFieldFunctionObjects + Description Samples near-patch volFields @@ -56,7 +55,6 @@ Description SourceFiles nearWallFields.C IOnearWallFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index 1bf8282685942345cf48a1ad0462974621a3e68b..c748e17fd1db617a12745bd6e843cb9d5e51f109 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::processorField +\ingroup grpFieldFunctionObjects + Description Writes a scalar field whose value is the local processor ID. Output field name is processorID. @@ -34,7 +33,6 @@ Description SourceFiles processorField.C IOprocessorField.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 400036e2fde9ce42023964e3d3b10d2c8db79c48..32cc119cbf611cb405defac00b2ff8cdb5ab764e 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::readFields +\ingroup grpFieldFunctionObjects + Description Reads fields from the time folders and adds them to the mesh database for further post-processing. @@ -34,7 +33,6 @@ Description SourceFiles readFields.C IOreadFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 3a7a29ccf971b606ed716fe0eeff615b45901264..95cedb6517f9926d0441add454a6f4802dbc3728 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::regionSizeDistribution +\ingroup grpFieldFunctionObjects + Description Looks up a field, interpolates it to the faces and determines a connected region from a patch where the field is above a certain value. @@ -36,7 +35,6 @@ Description SourceFiles regionSizeDistribution.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index 16d26e2a7b1d45351c27aaf919e3607c800f097a..7ee9abec129432619de70b40614b7e3e10534714 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::streamLine +\ingroup grpFieldFunctionObjects + Description Generation of streamlines. Samples along track of passive particle. SourceFiles streamLine.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 4d4697426ca7dc94f7262a1582a9e201121c67ed..b91fd6463216a1f40b69ee5add7aaf1f92e5ef47 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::surfaceInterpolateFields +\ingroup grpFieldFunctionObjects + Description Linear interpolates volFields to surfaceFields @@ -52,7 +51,6 @@ Description SourceFiles surfaceInterpolateFields.C IOsurfaceInterpolateFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 33a6f44d117ff2e670668467d3863edbdbf5b0c8..9cabbd0eb17dbd5a09dc1cf36e23e939bcac0540 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::turbulenceFields +\ingroup grpFieldFunctionObjects + Description Stores turbulence fields on the mesh database for further manipulation. @@ -37,7 +36,6 @@ Description SourceFiles turbulenceFields.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 7e20da7e0be1b07f50c60d75f09431fcfb4632d4..a9d54a2ba87a4d107b260e8a666bee31d1f2f825 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFieldFunctionObjects -@{ - Class Foam::wallBoundedStreamLine +\ingroup grpFieldFunctionObjects + Description Generation of streamlines. Samples along track of passive particle. SourceFiles wallBoundedStreamLine.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index 56351be3704e13e9a889438f319e7b11386569da..f51f180d24ad88af6d34d929dd7ae102e1545529 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 <http://www.gnu.org/licenses/>. -\addtogroup grpForcesFunctionObjects -@{ - Class Foam::forceCoeffs +\ingroup grpForcesFunctionObjects + Description Derived from the forces function object, creates a specialisation to calculate lift and drag forces. @@ -34,7 +33,6 @@ Description SourceFiles forceCoeffs.C IOforceCoeffs.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index abf9df97efc253d78af6bce7f550c4995e6b346d..d2c224abaad9b1a630ea300951027da9e455abb0 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 <http://www.gnu.org/licenses/>. -\addtogroup grpForcesFunctionObjects -@{ - Class Foam::forces +\ingroup grpForcesFunctionObjects + Description Calculates the forces and moments by integrating the pressure and skin-friction forces over a given list of patches. @@ -54,7 +53,6 @@ Note SourceFiles forces.C IOforces.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/functionObjects.dox b/src/postProcessing/functionObjects/functionObjects.dox new file mode 100644 index 0000000000000000000000000000000000000000..ee4355a65667506dc28f7c601b951c951fac9611 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\page pagePostProcessing Post-processing + +\section secFunctionObjects Function objects + +OpenFOAM includes a variety of \ref grpFunctionObjects that can be applied during +the calculation, or afterwards using the execFlowFunctionObjects utility. The +range of uses include: +- \ref grpCloudFunctionObjects +- \ref grpFieldFunctionObjects +- \ref grpForcesFunctionObjects +- \ref grpIOFunctionObjects +- \ref grpJobControlFunctionObjects +- \ref grpUtilitiesFunctionObjects + +<br> +\subsection secFieldFunctionObjectUsage Using function objects + +To employ function objects, additional entries are required in the +$FOAM_CASE/system/controlDict input dictionary. Each object is listed in a +\c functions sub-dictionary entry, e.g. + +\verbatim +functions +{ + myFunctionObject + { + type functionObjectType; + libs ("libMyFunctionObjectlib.so"); + outputControl outputTime; // output or timeStep + outputInterval 1; // only necessary for outputControl=timeStep + ... + } +} +\endverbatim + +The sub-dictionary name \c myFunctionObject is chosen by the user, and is +often used as the name of the output folder of any generated data. The \c type +entry defines the type of function object properties that follow. Since the +function objects are packaged into separate libraries, the user must tell the +code where to find the function object implementation, identified using the +\c libs entry. + + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 3d9a3f19e2992c045e2c45f534ea8cc1ce455826..143b7b38b64ac5f01d735c940754640336b29f40 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 <http://www.gnu.org/licenses/>. -\addtogroup grpJobControlFunctionObjects -@{ - Class Foam::abortCalculation +\ingroup grpJobControlFunctionObjects + Description Watches for presence of the named file in the $FOAM_CASE directory and aborts the calculation if it is present. @@ -39,7 +38,6 @@ Description SourceFiles abortCalculation.C IOabortCalculation.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index 3a3d9965affe02c1e747808261c3a5d8161ecdb1..9726836d80b970ec7c0899ee5dfac7c64e7c9a6f 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 <http://www.gnu.org/licenses/>. -\addtogroup grpFunctionObjects -@{ - Class Foam::systemCall +\ingroup grpFunctionObjects + Description Executes system calls, entered in the form of a string list SourceFiles systemCall.C IOsystemCall.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 1171951b33db8b979ca7ddfb185c89258e1872c6..8e2f1795ce184329588fd72f2cfe944e2a92d2b3 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 <http://www.gnu.org/licenses/>. -\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 57b9c317c2efa8465e96ac590fe033ab4bc50ba6..0a037a2aece78b11d69512275656bc5e008c14dc 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::dsmcFields +\ingroup grpUtilitiesFunctionObjects + Description Calculate intensive fields: - UMean @@ -38,7 +37,6 @@ Description SourceFiles dsmcFields.C IOdsmcFields.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 93be6c83443cb5f987c4c4ac8699e5c6c7df7d00..db5f1dcc4b21c5c9d24ebde6de2646182ec5a69d 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::pressureCoefficient +\ingroup grpUtilitiesFunctionObjects + Description Calculates pressure coefficient, \f$c_p\f$ @@ -41,7 +40,6 @@ Description SourceFiles pressureCoefficient.C IOpressureCoefficient.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index fae08db94a0cb98f53bf39e9df88401dbcf7ead7..56586b256d5cfaf80568f8c70c2239c5bba4152f 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::staticPressure +\ingroup grpUtilitiesFunctionObjects + Description Converts kinematic pressure to static pressure, from the name of the pressure field, and density, i.e. @@ -36,7 +35,6 @@ Description SourceFiles staticPressure.C IOstaticPressure.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index 9d6a2a578f29cefb59600347225b3872b89369f5..afb63cb3238433af229ac37899b4a99d2816443e 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::timeActivatedFileUpdate +\ingroup grpUtilitiesFunctionObjects + Description Performs a file copy/replacement once a specified time has been reached. Example usage to update the fvSolution dictionary at various times throughout the calculation: - fileUpdate1 - { - type timeActivatedFileUpdate; - functionObjectLibs ("libutilityFunctionObjects.so"); - outputControl timeStep; - outputInterval 1; - fileToUpdate "$FOAM_CASE/system/fvSolution"; - timeVsFile - ( - (-1 "$FOAM_CASE/system/fvSolution.0") - (0.10 "$FOAM_CASE/system/fvSolution.10") - (0.20 "$FOAM_CASE/system/fvSolution.20") - (0.35 "$FOAM_CASE/system/fvSolution.35") - ); - } - + \verbatim + fileUpdate1 + { + type timeActivatedFileUpdate; + functionObjectLibs ("libutilityFunctionObjects.so"); + outputControl timeStep; + outputInterval 1; + fileToUpdate "$FOAM_CASE/system/fvSolution"; + timeVsFile + ( + (-1 "$FOAM_CASE/system/fvSolution.0") + (0.10 "$FOAM_CASE/system/fvSolution.10") + (0.20 "$FOAM_CASE/system/fvSolution.20") + (0.35 "$FOAM_CASE/system/fvSolution.35") + ); + } + \endverbatim SourceFiles timeActivatedFileUpdate.C IOtimeActivatedFileUpdate.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index b0225aab16789641de0aabc814d2a6706f7a4175..14a2ba895b1bc389be2c8217e415f09bb92b0eb6 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::yPlusLES +\ingroup grpUtilitiesFunctionObjects + Description Evaluates and outputs turbulence y+ for LES models. Values written to time folders as field 'yPlusLES' @@ -34,7 +33,6 @@ Description SourceFiles yPlusLES.C IOyPlusLES.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 1ed52755619733bf552b3e6ad34ee032dd8d8ecc..3e35bb4bfba940aa78e0088a2b75028b4937fcbf 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 <http://www.gnu.org/licenses/>. -\addtogroup grpUtilitiesFunctionObjects -@{ - Class Foam::yPlusRAS +\ingroup grpUtilitiesFunctionObjects + Description Evaluates and outputs turbulence y+ for RAS models. Values written to time folders as field 'yPlusRAS' @@ -34,7 +33,6 @@ Description SourceFiles yPlusRAS.C IOyPlusRAS.H -@} \*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..152f63157800f483b636b7d43b07b832df2f0b64 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 8731d01a6e7aeaf28c53628aea09dbce675eadd7..e2dedbb2f58cbd6517964ab567cd5a0210c91033 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 25a34bf82e563868407890f422edff82569ed897..2811ea25795e9734a7faca4ebdfc0e6708aad2a5 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 25a401239a47ca54e88385e0d3d551f48678ef38..9f827b8745f2c8fb5e68a5f45b6ac1192af0f358 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 f60fb9555f8b14d144d7f176ec8abb898f394bb3..eda8faf3244b0cdf47c01234b069db195c94d00a 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 288a9e30de40ffa40073158459adc5c5868b7db5..539d5f892df03aa4fb22b4e1cb60e0c9fd987157 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 a3cf15a47ba4fe92dd23649785548f88a8fd02a0..b098ffca89b0011d2fbfe8c53ff7c31e635681af 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 0e6b27275d5997e75f4eaef1f9a99cd4bf9c96b2..41d9abbfd3f11772a41508ff1484f979711e0ea8 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 -Description - Boundary condition for turbulent thermal diffusivity when using wall - functions +Group + grpCmpWallFunctions - \li replicates OpenFOAM v1.5 (and earlier) behaviour +Description + This boundary condition provides a turbulent thermal diffusivity conditon + when using wall functions + - 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 d523c8d38f5905615ba4f2356e70bf38f31292ea..515b6054039e012907f56fe760213a144f9d9e6c 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 a2756319a52a97d165fa2dc3d81b30f6dee5d290..95953977da1c5a2d0ec501693af0973e4153f916 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 bbed4a8bbf80f4ed47b289a3f5b1607839450f80..886eb0ef7cfdb4eee9de63f805fdac08d5aa23ca 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 05f82c57f6bb001709bbfdb03a48f16d233ad226..8174270466c70aed926670f61a97575422ccc8fc 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 4157f384a15378c5df0c1b20a90dd1e35a02dece..0060806b6bae2d3d8f24684661def1692742648e 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 6071a32128c9406af282d7432a641bced807beb1..8f9d1becf4c8a565ca3e5f847af6e67334b4ea27 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 ab0478508ff7bacc99b7fe7f67df1a1c2078485a..a3f1f6db2f70bd7cef58495d5acc8842dbdcbccf 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 da413fed1cb9a7476731deb2660880b5bc036c65..13dbc72121242a54b85745736efb66ffafff40d6 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 -Description - Boundary condition for turbulent (kinematic) viscosity when using wall - functions for rough walls, based on turbulence kinetic energy. +Group + grpCmpWallFunctions - Manipulates the E parameter to account for roughness effects, based on - KsPlus. +Description + 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 0aa935d59b56bcaddda51cf47c9b35a71eef966f..400a300a55f237970d837c4c9f8b11886ddd79ca 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 db1b91b68814df0e40b7baaf9865d8cc834f3636..63fd4823e822898ea2cf3fa2f91fad1577141671 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 -Description - Provides a wall function boundary condition/constraint on omega +Group + grpCmpWallFunctions - Computed value is: +Description + This boundary condition provides a wall function constraint on turbulnce + specific dissipation, omega. The values are computed using: - 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 2dcd5c9214052eaf74087c7c1711006779bc8437..2dc42c3f02320a7625dfacdba9539d7927bca43f 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 d0fa2992bdc75a6b519f91bb85226630d99e0208..327e68d3bd85d899b0cac69a9a0c1d97a8a44a8f 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 cb3a0c9d17b0a01aad30d6328e1c8119d9290149..cde69f91f0b8f1ce5c721b25a2bbbb4b53323e17 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 <http://www.gnu.org/licenses/>. 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: - - 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 - } + /heading Patch usage + + /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 a0fee136cac87691edb173a670dc9ccbdc667736..f0e9d5bdfeaffb5fddcd4984ef270325b0aae6f7 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 1cfb9013b32346be4b475749ac17ddfa33419bef..a9cce6cbd84ffe9c3b426c25286f90ebb86814a0 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 41a871b8df03a3e6a6ae776cf6b0432d4dd16641..59b56dbd36121a3a51c0e45ea17bebc2bfed511e 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 807813d1e3ed68e7a28f900471ac1a131cfa8f6f..a8979e059d39aac7fbd99a56ca8eab6a34178a1a 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 <http://www.gnu.org/licenses/>. -\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 97a01567ea93d185143640cf370629a5b29a097e..601fbda71c96e991c8e950b10c104b1d33e12492 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 <http://www.gnu.org/licenses/>. - -\addtogroup grpIcoWallFunctions -@{ + You should have received a copy of the GNU General Public License along with + OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 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 007401a499cf1720a7c6ee9dc5c5744fc1ad37c7..6ec6b7270bd07834f8adfa770925763593403c24 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 <http://www.gnu.org/licenses/>. -\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 28861bbc65fac28d2686301e32503b6275093bfb..3f14f07338f21b601c8b2aa07e0d60919fadfa82 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 <http://www.gnu.org/licenses/>. -\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 89113aa58aeb05c5f07b2be030ec2194556e5bf2..97d70cf3bccdb1be07eed151e3c93e8d9c3c8bac 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 <http://www.gnu.org/licenses/>. -\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 abb1f0c683a67de6fe3455416817d46a8b6ee71c..5ae948a6141d78a40553ec05bda6bcb71beac28a 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 <http://www.gnu.org/licenses/>. -\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 efabcfb58fa1eddc4db8ab17aae0da15d3ba83c9..7c43c753192a69b9e3bbd810a5951333257f324f 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 <http://www.gnu.org/licenses/>. -\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 3fd38c9e375c1bea27714338cb5b6e04c601356f..d39142bc26420090ea6a0c0f8cb8d395b1e63cd0 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 <http://www.gnu.org/licenses/>. -\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 dfdebdc2ee1c0565da387e79b4821af886527d38..ecd2959720254d43180c36b39279cbeab5c16e18 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 <http://www.gnu.org/licenses/>. -\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 bef03208d0217371c0d9646991ff7dba8f631e91..3ba2b450a8c1c265d847702684539209c60c6b57 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 <http://www.gnu.org/licenses/>. -\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 57cb2c27cb60ce995fff21c7df920f681c194d3b..0682defc2d4901f3378e79364d79a613323db151 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 <http://www.gnu.org/licenses/>. -\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 61363a9c467ea473cbe227c18e9687800906320c..91156935d09a28d2a2b0d85e51dd5bf6898b0259 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 <http://www.gnu.org/licenses/>. -\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 e7c41731aaad3601fd71a5ed8c0fbf2d571010bf..ece53d3b1d3c681813595c55db9e75b406119bd7 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 <http://www.gnu.org/licenses/>. -\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