wallDependentModel.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) 2014-2023 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::wallDependentModel
26 
27 Description
28  A class which provides on-demand creation and caching of wall distance and
29  wall normal fields for use by multiple models.
30 
31 SourceFiles
32  wallDependentModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef wallDependentModel_H
37 #define wallDependentModel_H
38 
39 #include "fvMesh.H"
40 #include "volFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class wallDependentModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private Data
54 
55  //- Reference to the mesh
56  const fvMesh& mesh_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct from a mesh
64  wallDependentModel(const fvMesh& mesh);
65 
66  //- Disallow default bitwise copy construction
67  wallDependentModel(const wallDependentModel&) = delete;
68 
69 
70  //- Destructor
71  virtual ~wallDependentModel();
72 
73 
74  // Member Functions
75 
76  //- Return the wall distance, creating and storing it if necessary
77  const volScalarField& yWall() const;
78 
79  //- Return the wall normal, creating and storing it if necessary
80  const volVectorField& nWall() const;
81 
82 
83  // Member Operators
84 
85  //- Disallow default bitwise assignment
86  void operator=(const wallDependentModel&) = delete;
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
Generic GeometricField class.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
A class which provides on-demand creation and caching of wall distance and wall normal fields for use...
const volScalarField & yWall() const
Return the wall distance, creating and storing it if necessary.
const volVectorField & nWall() const
Return the wall normal, creating and storing it if necessary.
wallDependentModel(const fvMesh &mesh)
Construct from a mesh.
void operator=(const wallDependentModel &)=delete
Disallow default bitwise assignment.
virtual ~wallDependentModel()
Destructor.
Namespace for OpenFOAM.