epsilonmWallFunctionFvPatchScalarField.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) 2022-2024 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::epsilonmWallFunctionFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulence dissipation wall constraint
29  for the mixtureKEpsilon model
30 
31 SourceFiles
32  epsilonmWallFunctionFvPatchScalarField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef epsilonmWallFunctionFvPatchScalarField_H
37 #define epsilonmWallFunctionFvPatchScalarField_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class epsilonmWallFunctionFvPatchScalarField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54 private:
55 
56  // Private Member Functions
57 
58  //- Constrain the matrix such that the wall cells take the value
59  // specified by the wall function
60  void manipulateMatrixMaster(fvMatrix<scalar>& matrix);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("epsilonmWallFunction");
67 
68 
69  // Constructors
70 
71  //- Construct from patch, internal field and dictionary
73  (
74  const fvPatch&,
76  const dictionary&
77  );
78 
79  //- Construct by mapping given
80  // epsilonmWallFunctionFvPatchScalarField
81  // onto a new patch
83  (
85  const fvPatch&,
87  const fieldMapper&
88  );
89 
90  //- Disallow copy without setting internal field reference
92  (
94  ) = delete;
95 
96  //- Copy constructor setting internal field reference
98  (
101  );
102 
103  //- Construct and return a clone setting internal field reference
105  (
107  ) const
108  {
110  (
112  );
113  }
114 
115 
116  //- Destructor
118  {}
119 
120 
121  // Member Functions
122 
123  // Evaluation functions
124 
125  //- Update the coefficients associated with the patch field
126  virtual void updateCoeffs();
127 
128  //- Manipulate matrix
129  virtual void manipulateMatrix(fvMatrix<scalar>& matrix);
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
This boundary condition provides a turbulence dissipation wall constraint for the mixtureKEpsilon mod...
virtual void manipulateMatrix(fvMatrix< scalar > &matrix)
Manipulate matrix.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("epsilonmWallFunction")
Runtime type information.
epsilonmWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
Abstract base class for field mapping.
Definition: fieldMapper.H:48
A special matrix type and solver, designed for finite volume solutions of scalar equations....
Definition: fvMatrix.H:118
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:204
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
Base class for wall functions that modify cell values.
Namespace for OpenFOAM.