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