From a8261a5626bed657ba64dc97fc0b014e30b59df4 Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Thu, 22 Mar 2018 11:09:42 +0000 Subject: [PATCH] STYLE: fvPatchFields: Corrected documentation Resolves bug-report https://bugs.openfoam.org/view.php?id=2885 --- .../outletMappedUniformInletFvPatchField.C | 30 +++++++++---------- .../outletMappedUniformInletFvPatchField.H | 10 +++---- .../timeVaryingMappedFixedValueFvPatchField.H | 2 +- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C index 5490a8a930..ddc9fd7eea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C @@ -43,6 +43,21 @@ outletMappedUniformInletFvPatchField {} +template +Foam::outletMappedUniformInletFvPatchField:: +outletMappedUniformInletFvPatchField +( + const fvPatch& p, + const DimensionedField& iF, + const dictionary& dict +) +: + fixedValueFvPatchField(p, iF, dict), + outletPatchName_(dict.lookup("outletPatch")), + phiName_(dict.lookupOrDefault("phi", "phi")) +{} + + template Foam::outletMappedUniformInletFvPatchField:: outletMappedUniformInletFvPatchField @@ -59,21 +74,6 @@ outletMappedUniformInletFvPatchField {} -template -Foam::outletMappedUniformInletFvPatchField:: -outletMappedUniformInletFvPatchField -( - const fvPatch& p, - const DimensionedField& iF, - const dictionary& dict -) -: - fixedValueFvPatchField(p, iF, dict), - outletPatchName_(dict.lookup("outletPatch")), - phiName_(dict.lookupOrDefault("phi", "phi")) -{} - - template Foam::outletMappedUniformInletFvPatchField:: outletMappedUniformInletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index dd367ca3f8..7c4ea1ceaa 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -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: diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 2320ffe2ab..46f720a723 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -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