src/fvMotionSolver/motionDiffusivity/motionDiffusivity/motionDiffusivity.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::motionDiffusivity
  27
  28 Description
  29     Abstract base class for cell-centre mesh motion diffusivity.
  30
  31 SourceFiles
  32     motionDiffusivity.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef motionDiffusivity_H
  37 #define motionDiffusivity_H
  38
  39 #include "fvMotionSolver.H"
  40 #include "surfaceFieldsFwd.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class motionDiffusivity Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class motionDiffusivity
  52 {
  53     // Private data
  54
  55         //- Motion solver reference
  56         const fvMotionSolver& mSolver_;
  57
  58 public:
  59
  60     //- Runtime type information
  61     TypeName("motionDiffusivity");
  62
  63
  64     // Declare run-time constructor selection tables
  65
  66         declareRunTimeSelectionTable
  67         (
  68             autoPtr,
  69             motionDiffusivity,
  70             Istream,
  71             (
  72                 const fvMotionSolver& mSolver,
  73                 Istream& mdData
  74             ),
  75             (mSolver, mdData)
  76         );
  77
  78
  79     // Selectors
  80
  81         //- Select null constructed
  82         static autoPtr<motionDiffusivity> New
  83         (
  84             const fvMotionSolver& mSolver,
  85             Istream& mdData
  86         );
  87
  88
  89     // Constructors
  90
  91         //- Construct for the given fvMotionSolver
  92         motionDiffusivity(const fvMotionSolver& mSolver);
  93
  94
  95     // Destructor
  96
  97         virtual ~motionDiffusivity();
  98
  99
 100     // Member Functions
 101
 102         //- Return reference to the motion solver
 103         const fvMotionSolver& mSolver() const
 104         {
 105             return mSolver_;
 106         }
 107
 108         //- Return diffusivity field
 109         virtual tmp<surfaceScalarField> operator()() const = 0;
 110
 111         //- Correct the motion diffusivity
 112         virtual void correct() = 0;
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //