src/fvMotionSolver/motionDiffusivity/file/fileDiffusivity.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::fileDiffusivity
  27
  28 Description
  29     Motion diffusivity read from given file name.
  30
  31 SourceFiles
  32     fileDiffusivity.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fileDiffusivity_H
  37 #define fileDiffusivity_H
  38
  39 #include "motionDiffusivity.H"
  40 #include "surfaceFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class fileDiffusivity Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class fileDiffusivity
  52 :
  53     public motionDiffusivity
  54 {
  55
  56 protected:
  57
  58     // Protected data
  59
  60         surfaceScalarField faceDiffusivity_;
  61
  62
  63 private:
  64
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise copy construct
  68         fileDiffusivity(const fileDiffusivity&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const fileDiffusivity&);
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("file");
  78
  79
  80     // Constructors
  81
  82         //- Construct for the given fvMotionSolver and data Istream
  83         fileDiffusivity
  84         (
  85             const fvMotionSolver& mSolver,
  86             Istream& mdData
  87         );
  88
  89
  90     // Destructor
  91
  92         virtual ~fileDiffusivity();
  93
  94
  95     // Member Functions
  96
  97         //- Return diffusivity field
  98         virtual tmp<surfaceScalarField> operator()() const
  99         {
 100             return faceDiffusivity_;
 101         }
 102
 103         //- Do not correct the motion diffusivity
 104         virtual void correct()
 105         {}
 106 };
 107
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 } // End namespace Foam
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 #endif
 116
 117 // ************************************************************************* //