initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / fvMotionSolver / motionDiffusivity / inverseFaceDistance / inverseFaceDistanceDiffusivity.H
blobeec6d3cc812c8560dba95492834437b63c2e6a94
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::inverseFaceDistanceDiffusivity
28 Description
29     Inverse distance to the given patches motion diffusivity.
31 SourceFiles
32     inverseFaceDistanceDiffusivity.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef inverseFaceDistanceDiffusivity_H
37 #define inverseFaceDistanceDiffusivity_H
39 #include "uniformDiffusivity.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class inverseFaceDistanceDiffusivity Declaration
48 \*---------------------------------------------------------------------------*/
50 class inverseFaceDistanceDiffusivity
52     public uniformDiffusivity
54     // Private data
55         
56         //- Patches selected to base the distance on
57         wordList patchNames_;
60     // Private Member Functions
62         //- Disallow default bitwise copy construct
63         inverseFaceDistanceDiffusivity(const inverseFaceDistanceDiffusivity&);
65         //- Disallow default bitwise assignment
66         void operator=(const inverseFaceDistanceDiffusivity&);
69 public:
71     //- Runtime type information
72     TypeName("inverseFaceDistance");
75     // Constructors
77         //- Construct for the given fvMotionSolver and data Istream
78         inverseFaceDistanceDiffusivity
79         (
80             const fvMotionSolver& mSolver,
81             Istream& mdData
82         );
85     // Destructor
87         virtual ~inverseFaceDistanceDiffusivity();
90     // Member Functions
92         //- Correct the motion diffusivity
93         virtual void correct();
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 } // End namespace Foam
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 #endif
105 // ************************************************************************* //