fvPatchFields: Corrected documentation
Resolves bug-report https://bugs.openfoam.org/view.php?id=2885
This commit is contained in:
@ -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>
|
||||
Foam::outletMappedUniformInletFvPatchField<Type>::
|
||||
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>
|
||||
Foam::outletMappedUniformInletFvPatchField<Type>::
|
||||
outletMappedUniformInletFvPatchField
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,14 +29,14 @@ Group
|
||||
|
||||
Description
|
||||
This boundary conditon averages the field over the "outlet" patch specified
|
||||
by name "outletPatchName" and applies this as the uniform value of the
|
||||
field over this patch.
|
||||
by name "outletPatch" and applies this as the uniform value of the field
|
||||
over this patch.
|
||||
|
||||
Usage
|
||||
\table
|
||||
Property | Description | Required | Default value
|
||||
outletPatchName | name of outlet patch | yes |
|
||||
phi | flux field name | no | phi
|
||||
outletPatch | Name of outlet patch | yes |
|
||||
phi | Flux field name | no | phi
|
||||
\endtable
|
||||
|
||||
Example of the boundary condition specification:
|
||||
|
||||
@ -62,7 +62,7 @@ Usage
|
||||
Property | Description | Required | Default value
|
||||
setAverage | Switch to activate setting of average value | no | false
|
||||
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
|
||||
offset | Offset to mapped values | no | Zero
|
||||
dataDir | Top-level directory of the points and field data \\
|
||||
|
||||
Reference in New Issue
Block a user