v2fBase.H
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) 2015-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 Class
25  Foam::RASModels::v2fBase
26 
27 Description
28  Abstract base-class for v2-f models to provide BCs access to the v2 and f
29  fields.
30 
31 See also
32  Foam::RASModels::v2f
33 
34 SourceFiles
35  v2fBase.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef v2fBase_H
40 #define v2fBase_H
41 
42 #include "RASModel.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace RASModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class v2fBase Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class v2fBase
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("v2fBase");
61 
62 
63  // Constructors
64 
65  v2fBase()
66  {}
67 
68 
69  //- Destructor
70  virtual ~v2fBase()
71  {}
72 
73 
74  // Member Functions
75 
76  //- Return turbulence stress normal to streamlines
77  virtual tmp<volScalarField> v2() const = 0;
78 
79  //- Return the damping function
80  virtual tmp<volScalarField> f() const = 0;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace RASModels
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
Abstract base-class for v2-f models to provide BCs access to the v2 and f fields.
Definition: v2fBase.H:55
virtual tmp< volScalarField > v2() const =0
Return turbulence stress normal to streamlines.
TypeName("v2fBase")
Runtime type information.
virtual tmp< volScalarField > f() const =0
Return the damping function.
virtual ~v2fBase()
Destructor.
Definition: v2fBase.H:69
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.