relative.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "relative.H"
28 
29 namespace Foam
30 {
31 namespace CorrectionLimitingMethods
32 {
34 
36  (
37  CorrectionLimitingMethod,
38  relative,
39  dictionary
40  );
41 }
42 }
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
47 :
49  e_(dict.template lookup<scalar>("e"))
50 {}
51 
52 
54 :
56  e_(cl.e_)
57 {}
58 
59 
60 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
61 
63 {}
64 
65 
66 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
67 
69 (
70  const vector uP,
71  const vector dU,
72  const vector uMean
73 ) const
74 {
75  const vector uRelative = uP - uMean;
76 
77  return minMod
78  (
79  dU,
80  - (1.0 + this->e_)*uRelative
81  );
82 }
83 
84 
85 // ************************************************************************* //
dictionary dict
virtual vector limitedVelocity(const vector uP, const vector dU, const vector uMean) const
Return the limited velocity.
Definition: relative.C:69
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
addToRunTimeSelectionTable(CorrectionLimitingMethod, absolute, dictionary)
Correction limiting method based on the relative particle velocity.
Definition: relative.H:55
Macros for easy insertion into run-time selection tables.
stressControl lookup("compactNormalStress") >> compactNormalStress
relative(const dictionary &dict)
Construct from components.
Definition: relative.C:46
Scalar minMod(const Scalar s1, const Scalar s2)
Definition: Scalar.H:227
Base class for correction limiting methods.
scalar e_
Coefficient of restitution.
Definition: relative.H:64
Namespace for OpenFOAM.
tmp< surfaceScalarField > relative(const tmp< surfaceScalarField > &tphi, const volVectorField &U)
Return the given absolute flux in relative form.
Definition: fvcMeshPhi.C:153