Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / fvMotionSolver / motionDiffusivity / inversePointDistance / inversePointDistanceDiffusivity.H
blob3ea4b7b2fac75a0aa550eb09f8b753ae20c2a169
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
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::inversePointDistanceDiffusivity
27 Description
28     Inverse distance to the given patches motion diffusivity.
30 SourceFiles
31     inversePointDistanceDiffusivity.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef inversePointDistanceDiffusivity_H
36 #define inversePointDistanceDiffusivity_H
38 #include "uniformDiffusivity.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                            Class inversePointDistanceDiffusivity Declaration
47 \*---------------------------------------------------------------------------*/
49 class inversePointDistanceDiffusivity
51     public uniformDiffusivity
53     // Private data
55         //- Patches selected to base the distance on
56         wordList patchNames_;
59     // Private Member Functions
61         //- Disallow default bitwise copy construct
62         inversePointDistanceDiffusivity(const inversePointDistanceDiffusivity&);
64         //- Disallow default bitwise assignment
65         void operator=(const inversePointDistanceDiffusivity&);
68 public:
70     //- Runtime type information
71     TypeName("inversePointDistance");
74     // Constructors
76         //- Construct for the given fvMotionSolver and data Istream
77         inversePointDistanceDiffusivity
78         (
79             const fvMotionSolver& mSolver,
80             Istream& mdData
81         );
84     //- Destructor
85     virtual ~inversePointDistanceDiffusivity();
88     // Member Functions
90         //- Correct the motion diffusivity
91         virtual void correct();
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 } // End namespace Foam
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 #endif
103 // ************************************************************************* //