relaxedSnGrad.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) 2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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\*---------------------------------------------------------------------------*/
27
28#include "fv.H"
29#include "relaxedSnGrad.H"
30#include "volFields.H"
31#include "surfaceFields.H"
32
33// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
34
35template<class Type>
38(
40) const
41{
43
44 // Calculate explicit correction field
45 tmp<SurfFieldType> tcorrection = correctedScheme_().correction(vf);
46
47 // Retrieve relaxation factor value
48 const word fieldName(vf.name());
49 const word oldFieldName(fieldName + "_0");
50 const scalar relax =
51 vf.mesh().fieldRelaxationFactor("snGrad("+fieldName+")");
52
53 // Return explicit correction field if
54 // previous-time step correction is unavailable
55 const objectRegistry& obr = vf.db();
56 if (!obr.foundObject<SurfFieldType>(oldFieldName))
57 {
58 SurfFieldType* oldCorrection =
59 new SurfFieldType(oldFieldName, tcorrection());
60 oldCorrection->store();
61 }
62
63 // Return under/over-relaxed explicit correction field
64 tmp<SurfFieldType> trelaxedCorrection(new SurfFieldType(tcorrection()));
65
66 SurfFieldType& oldCorrection =
67 obr.lookupObjectRef<SurfFieldType>(oldFieldName);
68
69 trelaxedCorrection.ref() *= relax;
70 trelaxedCorrection.ref() += (scalar(1) - relax)*oldCorrection;
71
72 oldCorrection = tcorrection;
73
74 return trelaxedCorrection;
75}
76
77
78// ************************************************************************* //
const Mesh & mesh() const
Return mesh.
Generic GeometricField class.
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:65
const objectRegistry & db() const noexcept
Return the local objectRegistry.
Definition: IOobject.C:500
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction(const GeometricField< Type, fvPatchField, volMesh > &) const
Definition: relaxedSnGrad.C:38
Registry of regIOobjects.
bool foundObject(const word &name, const bool recursive=false) const
Is the named Type found?
Type & lookupObjectRef(const word &name, const bool recursive=false) const
A class for managing temporary objects.
Definition: tmp.H:65
T & ref() const
Definition: tmpI.H:227
A class for handling words, derived from Foam::string.
Definition: word.H:68
UEqn relax()
Foam::surfaceFields.