fvPatchFields: Corrected documentation

Resolves bug-report https://bugs.openfoam.org/view.php?id=2885
This commit is contained in:
Henry Weller
2018-03-22 11:09:42 +00:00
parent c677ba1185
commit 58b7c01dbd
3 changed files with 21 additions and 21 deletions

View File

@ -43,6 +43,21 @@ outletMappedUniformInletFvPatchField
{} {}
template<class Type>
Foam::outletMappedUniformInletFvPatchField<Type>::
outletMappedUniformInletFvPatchField
(
const fvPatch& p,
const DimensionedField<Type, volMesh>& iF,
const dictionary& dict
)
:
fixedValueFvPatchField<Type>(p, iF, dict),
outletPatchName_(dict.lookup("outletPatch")),
phiName_(dict.lookupOrDefault<word>("phi", "phi"))
{}
template<class Type> template<class Type>
Foam::outletMappedUniformInletFvPatchField<Type>:: Foam::outletMappedUniformInletFvPatchField<Type>::
outletMappedUniformInletFvPatchField outletMappedUniformInletFvPatchField
@ -59,21 +74,6 @@ outletMappedUniformInletFvPatchField
{} {}
template<class Type>
Foam::outletMappedUniformInletFvPatchField<Type>::
outletMappedUniformInletFvPatchField
(
const fvPatch& p,
const DimensionedField<Type, volMesh>& iF,
const dictionary& dict
)
:
fixedValueFvPatchField<Type>(p, iF, dict),
outletPatchName_(dict.lookup("outletPatch")),
phiName_(dict.lookupOrDefault<word>("phi", "phi"))
{}
template<class Type> template<class Type>
Foam::outletMappedUniformInletFvPatchField<Type>:: Foam::outletMappedUniformInletFvPatchField<Type>::
outletMappedUniformInletFvPatchField outletMappedUniformInletFvPatchField

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -29,14 +29,14 @@ Group
Description Description
This boundary conditon averages the field over the "outlet" patch specified This boundary conditon averages the field over the "outlet" patch specified
by name "outletPatchName" and applies this as the uniform value of the by name "outletPatch" and applies this as the uniform value of the field
field over this patch. over this patch.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
outletPatchName | name of outlet patch | yes | outletPatch | Name of outlet patch | yes |
phi | flux field name | no | phi phi | Flux field name | no | phi
\endtable \endtable
Example of the boundary condition specification: Example of the boundary condition specification:

View File

@ -62,7 +62,7 @@ Usage
Property | Description | Required | Default value Property | Description | Required | Default value
setAverage | Switch to activate setting of average value | no | false setAverage | Switch to activate setting of average value | no | false
perturb | Perturb points for regular geometries | no | 1e-5 perturb | Perturb points for regular geometries | no | 1e-5
fieldTableName | Alternative field name to sample | no| this field name fieldTable | Alternative field name to sample | no| this field name
mapMethod | Type of mapping | no | planarInterpolation mapMethod | Type of mapping | no | planarInterpolation
offset | Offset to mapped values | no | Zero offset | Offset to mapped values | no | Zero
dataDir | Top-level directory of the points and field data \\ dataDir | Top-level directory of the points and field data \\