zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: fvPatchFields: Corrected documentation

Browse Source 
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
committed by Andrew Heather
parent f246a81f8a
commit a8261a5626
3 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C
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>
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

10
src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
View File

@ -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 "outletPatch" 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
outletPatch | 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:

2
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
View File

@ -51,7 +51,7 @@ Usage
setAverage | Switch to activate setting of average value | no | false
perturb | Perturb points for regular geometries | no | 1e-5
points | Name of points file | no | points
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
\endtable