Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / finiteVolume / fvMesh / wallDist / nearWallDist.H
blobd8fe6ca387cfe37049e47871f0fa275627b5aaf1
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::nearWallDist
27 Description
28     Distance calculation for cells with face on a wall.
29     Searches pointNeighbours to find closest.
31 SourceFiles
32     nearWallDist.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef nearWallDist_H
37 #define nearWallDist_H
39 #include "volFields.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 class fvMesh;
49 /*---------------------------------------------------------------------------*\
50                            Class nearWallDist Declaration
51 \*---------------------------------------------------------------------------*/
53 class nearWallDist
55     public volScalarField::GeometricBoundaryField
57     // Private data
59         //- Reference to mesh
60         const fvMesh& mesh_;
63     // Private Member Functions
65         //- Do all calculations.
66         void doAll();
68         //- Disallow default bitwise copy construct
69         nearWallDist(const nearWallDist&);
71         //- Disallow default bitwise assignment
72         void operator=(const nearWallDist&);
75 public:
77     // Constructors
79         //- Construct from components
80         nearWallDist(const fvMesh& mesh);
83     //- Destructor
84     virtual ~nearWallDist();
87     // Member Functions
89         const volScalarField::GeometricBoundaryField& y() const
90         {
91             return *this;
92         }
94         //- Correct for mesh geom/topo changes
95         virtual void correct();
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 } // End namespace Foam
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 #endif
107 // ************************************************************************* //