relative.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) 2013 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
27 
28 #include "relative.H"
30 
31 namespace Foam
32 {
33 namespace CorrectionLimitingMethods
34 {
36 
38  (
39  CorrectionLimitingMethod,
40  relative,
41  dictionary
42  );
43 }
44 }
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 :
51  e_(dict.get<scalar>("e"))
52 {}
53 
54 
56 :
58  e_(cl.e_)
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
63 
65 {}
66 
67 
68 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
69 
71 (
72  const vector uP,
73  const vector dU,
74  const vector uMean
75 ) const
76 {
77  const vector uRelative = uP - uMean;
78 
79  return minMod
80  (
81  dU,
82  - (1.0 + this->e_)*uRelative
83  );
84 }
85 
86 
87 // ************************************************************************* //
Foam::CorrectionLimitingMethods::relative::~relative
virtual ~relative()
Destructor.
Definition: relative.C:64
Foam::CorrectionLimitingMethods::relative
Correction limiting method based on the relative particle velocity.
Definition: relative.H:60
Foam::CorrectionLimitingMethods::relative::limitedVelocity
virtual vector limitedVelocity(const vector uP, const vector dU, const vector uMean) const
Return the limited velocity.
Definition: relative.C:71
Foam::CorrectionLimitingMethods::addToRunTimeSelectionTable
addToRunTimeSelectionTable(CorrectionLimitingMethod, absolute, dictionary)
Foam::CorrectionLimitingMethods::defineTypeNameAndDebug
defineTypeNameAndDebug(absolute, 0)
Foam::CorrectionLimitingMethod
Base class for correction limiting methods.
Definition: CorrectionLimitingMethod.H:55
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::CorrectionLimitingMethods::relative::relative
relative(const dictionary &dict)
Construct from components.
Definition: relative.C:48
Foam::Vector< scalar >
Foam::minMod
Scalar minMod(const Scalar s1, const Scalar s2)
Definition: Scalar.H:298
Foam::fvc::relative
tmp< surfaceScalarField > relative(const tmp< surfaceScalarField > &tphi, const volVectorField &U)
Return the given absolute flux in relative form.
Definition: fvcMeshPhi.C:155
relative.H