src/tetDecompositionMotionSolver/motionDiffs/linear/linearDiff.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     linearDiff
  27
  28 Description
  29     Linear distance-based motion diffusion.
  30
  31 SourceFiles
  32     linearDiff.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef linearDiff_H
  37 #define linearDiff_H
  38
  39 #include "motionDiff.H"
  40 #include "elementFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class linearDiff Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class linearDiff
  52 :
  53     public motionDiff
  54 {
  55 private:
  56
  57     // Private data
  58
  59         //- Patches selected to base the distance on
  60         wordList patchNames_;
  61
  62         //- Diffusion field
  63         elementScalarField motionGamma_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct
  69         linearDiff(const linearDiff&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const linearDiff&);
  73
  74
  75 protected:
  76
  77         //- Return non constant diffusivity field
  78         elementScalarField& motionGamma()
  79         {
  80             return motionGamma_;
  81         }
  82
  83 public:
  84
  85     //- Runtime type information
  86     TypeName("linear");
  87
  88
  89     // Constructors
  90
  91         //- Construct from components
  92         linearDiff
  93         (
  94             const tetDecompositionMotionSolver& mSolver
  95         );
  96
  97
  98     // Destructor
  99
 100         virtual ~linearDiff();
 101
 102
 103     // Member Functions
 104
 105         //- Return cell distance field
 106         tmp<scalarField> L() const;
 107
 108         //- Return diffusivity field
 109         virtual const elementScalarField& motionGamma() const
 110         {
 111             return motionGamma_;
 112         }
 113
 114         //- Correct the motion diffusivity
 115         virtual void correct();
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //