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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2014-2018 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::wallDependentModel
28
29Description
30 A class which provides on-demand creation and caching of wall distance and
31 wall normal fields for use by multiple models.
32
33SourceFiles
34 wallDependentModel.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef wallDependentModel_H
39#define wallDependentModel_H
40
41#include "fvMesh.H"
42#include "volFields.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49/*---------------------------------------------------------------------------*\
50 Class wallDependentModel Declaration
51\*---------------------------------------------------------------------------*/
54{
55 // Private data
56
57 //- Reference to the mesh
58 const fvMesh& mesh_;
59
60
61 // Private Member Functions
62
63 //- Disallow default bitwise copy construct
65
66 //- Disallow default bitwise assignment
67 void operator=(const wallDependentModel&);
68
69
70public:
71
72 // Constructors
73
74 //- Construct from a mesh
76
77
78 //- Destructor
79 virtual ~wallDependentModel();
80
81 // Member Functions
82
83 // Return the wall distance, creating and storing it if necessary
84 const volScalarField& yWall() const;
85
86 // Return the wall normal, creating and storing it if necessary
87 const volVectorField& nWall() const;
88};
89
90
91// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92
93} // End namespace Foam
94
95// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97#endif
98
99// ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
A class which provides on-demand creation and caching of wall distance and wall normal fields for use...
const volScalarField & yWall() const
const volVectorField & nWall() const
virtual ~wallDependentModel()
Destructor.
dynamicFvMesh & mesh
Namespace for OpenFOAM.