Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / tetMotionSolver / motionDiffs / patchEnhanced / patchEnhancedDiff.H
blob3d936a6ef582d253d58bf130277df8fd5d789ec1
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     patchEnhancedDiff
27 Description
28     Patch-enhanced motion diffusion.
30 SourceFiles
31     patchEnhancedDiff.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef patchEnhancedDiff_H
36 #define patchEnhancedDiff_H
38 #include "motionDiff.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                      Class patchEnhancedDiff Declaration
47 \*---------------------------------------------------------------------------*/
49 class patchEnhancedDiff
51     public motionDiff
53 private:
55     // Private data
57         //- Patches selected to base the distance on
58         wordList patchNames_;
60         elementScalarField motionGamma_;
63     // Private Member Functions
65         //- Disallow default bitwise copy construct
66         patchEnhancedDiff(const patchEnhancedDiff&);
68         //- Disallow default bitwise assignment
69         void operator=(const patchEnhancedDiff&);
72 public:
74     //- Runtime type information
75     TypeName("patchEnhanced");
78     // Constructors
80         //- Construct from components
81         patchEnhancedDiff
82         (
83             const tetMotionSolver& mSolver
84         );
87     // Destructor
89         virtual ~patchEnhancedDiff();
92     // Member Functions
94         //- Enhance given difusivity
95         void enhance(elementScalarField&) const;
97         //- Return diffusivity field
98         virtual const elementScalarField& motionGamma() const
99         {
100             return motionGamma_;
101         }
103         //- Correct the motion diffusivity
104         virtual void correct()
105         {}
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 } // End namespace Foam
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 #endif
117 // ************************************************************************* //