src/fvMotionSolver/motionDiffusivity/inverseDistance/inverseDistanceDiffusivity.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     Foam::inverseDistanceDiffusivity
  26
  27 Description
  28     Inverse distance to the given patches motion diffusivity.
  29
  30 SourceFiles
  31     inverseDistanceDiffusivity.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef inverseDistanceDiffusivity_H
  36 #define inverseDistanceDiffusivity_H
  37
  38 #include "uniformDiffusivity.H"
  39 #include "wordReList.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                  Class inverseDistanceDiffusivity Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class inverseDistanceDiffusivity
  51 :
  52     public uniformDiffusivity
  53 {
  54     // Private data
  55
  56         //- Patches selected to base the distance on
  57         //  These can contain patch names or regular expressions to search for.
  58         wordReList patchNames_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Return patch-cell-centre distance field
  64         tmp<scalarField> y() const;
  65
  66         //- Disallow default bitwise copy construct
  67         inverseDistanceDiffusivity(const inverseDistanceDiffusivity&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const inverseDistanceDiffusivity&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("inverseDistance");
  77
  78
  79     // Constructors
  80
  81         //- Construct for the given fvMotionSolver and data Istream
  82         inverseDistanceDiffusivity
  83         (
  84             const fvMotionSolver& mSolver,
  85             Istream& mdData
  86         );
  87
  88
  89     //- Destructor
  90     virtual ~inverseDistanceDiffusivity();
  91
  92
  93     // Member Functions
  94
  95         //- Correct the motion diffusivity
  96         virtual void correct();
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //