wallDependentModel.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 | Copyright (C) 2014-2015 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  // Private Member Functions
60 
61  //- Disallow default bitwise copy construct
63 
64  //- Disallow default bitwise assignment
65  void operator=(const wallDependentModel&);
66 
67 
68 public:
69 
70  // Constructors
71 
72  //- Construct from a mesh
74 
75 
76  //- Destructor
77  virtual ~wallDependentModel();
78 
79  // Member Functions
80 
81  // Return the wall distance, creating and storing it if necessary
82  const volScalarField& yWall() const;
83 
84  // Return the wall normal, creating and storing it if necessary
85  const volVectorField& nWall() const;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
dynamicFvMesh & mesh
Namespace for OpenFOAM.
A class which provides on-demand creation and caching of wall distance and wall normal fields for use...
const volVectorField & nWall() const
virtual ~wallDependentModel()
Destructor.
const volScalarField & yWall() const