src/dynamicMesh/meshMotion/fvMotionSolver/motionDiffusivity/inverseDistance/inverseDistanceDiffusivity.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  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
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class inverseDistanceDiffusivity Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class inverseDistanceDiffusivity
  50 :
  51     public uniformDiffusivity
  52 {
  53     // Private data
  54
  55         //- Patches selected to base the distance on
  56         //  These can contain regular expressions and the actuallt patch names
  57         //  will be searched for.
  58         wordList 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
  91         virtual ~inverseDistanceDiffusivity();
  92
  93
  94     // Member Functions
  95
  96         //- Correct the motion diffusivity
  97         virtual void correct();
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //