fvcCorrectAlpha.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 InNamespace
27  Foam::fvc
28 
29 Description
30  Correct flux-U difference in the internal loop using relaxation factor
31 
32 SourceFiles
33  fvcCorrectAlpha.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #include "fvcCorrectAlpha.H"
38 #include "fvMesh.H"
39 #include "surfaceInterpolate.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace fvc
49 {
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 tmp<GeometricField<scalar, fvsPatchField, surfaceMesh>> alphaCorr
54 (
57  const bool finalIter
58 )
59 {
60  const fvMesh& mesh = U.mesh();
61  const word fieldName = U.select(finalIter);
62 
63  scalar alpha = 1;
64  if (mesh.relaxEquation(fieldName))
65  {
66  alpha = mesh.equationRelaxationFactor(fieldName);
67  }
68 
69  return
70  (1 - alpha)
71  *(phiU.prevIter() - (fvc::interpolate(U.prevIter()) & mesh.Sf()));
72 }
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 } // End namespace fvc
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 } // End namespace Foam
81 
82 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::constant::atomic::alpha
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Definition: readThermalProperties.H:212
Foam::GeometricField::prevIter
const GeometricField< Type, PatchField, GeoMesh > & prevIter() const
Return previous iteration field.
Definition: GeometricField.C:923
Foam::fvc::alphaCorr
tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > alphaCorr(const GeometricField< vector, fvPatchField, volMesh > &U, const GeometricField< scalar, fvsPatchField, surfaceMesh > &phiU, const bool finalIter)
Definition: fvcCorrectAlpha.C:54
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:84
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fvc::interpolate
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &tvf, const surfaceScalarField &faceFlux, Istream &schemeData)
Interpolate field onto faces using scheme given by Istream.
U
U
Definition: pEqn.H:72
Foam::GeometricField< vector, fvPatchField, volMesh >
fvcCorrectAlpha.H
Correct flux-U difference in the internal loop using relaxation factor.