kEpsilon.H
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) 2007-2023 PCOpt/NTUA
9  Copyright (C) 2013-2023 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 
29 Class
30  Foam::incompressible::RASVariables::kEpsilon
31 
32 Description
33 
34 SourceFiles
35  kEpsilon.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef incompressible_RASVariables_kEpsilon_H
40 #define incompressible_RASVariables_kEpsilon_H
41 
42 #include "RASModelVariables.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace incompressible
49 {
50 namespace RASVariables
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class kEpsilon Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class kEpsilon
58 :
59  public RASModelVariables
60 {
61 
62 protected:
63 
64  // Protected data
65 
66  //- Average of the production term
67  // Avaraged separetely due the bi-zonal treatment next to the wall
69 
70 
71  // Protected Member functions
72 
73  virtual void allocateMeanFields();
75 
76 
77 public:
78 
79  //- Runtime type information
80  TypeName("kEpsilon");
81 
82 
83  // Constructors
84 
85  //- Construct from components
86  kEpsilon
87  (
88  const fvMesh& mesh,
89  const solverControl& SolverControl
90  );
91 
92 
93  //- Destructor
94  virtual ~kEpsilon() = default;
95 
96 
97  // Member Functions
98 
99  //- Return the turbulence production term
101 
102  //- Compute mean fields on the fly
103  virtual void computeMeanFields();
104 
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace RASVariables
111 } // End namespace incompressible
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
TypeName("kEpsilon")
Runtime type information.
tmp< volScalarField::Internal > computeG()
Definition: kEpsilon.C:93
virtual tmp< volScalarField::Internal > G()
Return the turbulence production term.
Definition: kEpsilon.C:130
dynamicFvMesh & mesh
Base class for solver control classes.
Definition: solverControl.H:45
Abstract base class for objective functions. No point in making this runTime selectable since its chi...
virtual ~kEpsilon()=default
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
A class for managing temporary objects.
Definition: HashPtrTable.H:50
virtual void computeMeanFields()
Compute mean fields on the fly.
Definition: kEpsilon.C:144
kEpsilon(const fvMesh &mesh, const solverControl &SolverControl)
Construct from components.
Definition: kEpsilon.C:72
Namespace for OpenFOAM.
autoPtr< volScalarField::Internal > GMean_
Average of the production term.
Definition: kEpsilon.H:66