src/fvMotionSolver/motionDiffusivity/manipulators/exponential/exponentialDiffusivity.H

   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.
  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     Foam::exponentialDiffusivity
  27
  28 Description
  29     Mesh motion diffusivity maipulator which returns the exp(-alpha/D)
  30     of the given diffusivity D.
  31
  32 SourceFiles
  33     exponentialDiffusivity.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef exponentialDiffusivity_H
  38 #define exponentialDiffusivity_H
  39
  40 #include "motionDiffusivity.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class exponentialDiffusivity Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class exponentialDiffusivity
  52 :
  53     public motionDiffusivity
  54 {
  55     // Private data
  56
  57         scalar alpha_;
  58         autoPtr<motionDiffusivity> basicDiffusivityPtr_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow default bitwise copy construct
  64         exponentialDiffusivity(const exponentialDiffusivity&);
  65
  66         //- Disallow default bitwise assignment
  67         void operator=(const exponentialDiffusivity&);
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("exponential");
  74
  75
  76     // Constructors
  77
  78         //- Construct for the given fvMotionSolver and data Istream
  79         exponentialDiffusivity
  80         (
  81             const fvMotionSolver& mSolver,
  82             Istream& mdData
  83         );
  84
  85
  86     // Destructor
  87
  88         virtual ~exponentialDiffusivity();
  89
  90
  91     // Member Functions
  92
  93         //- Return diffusivity field
  94         virtual tmp<surfaceScalarField> operator()() const;
  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 // ************************************************************************* //