src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresGrad.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::fv::leastSquaresGrad
  27
  28 Description
  29     Second-order gradient scheme using least-squares.
  30
  31 SourceFiles
  32     leastSquaresGrad.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef leastSquaresGrad_H
  37 #define leastSquaresGrad_H
  38
  39 #include "gradScheme.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace fv
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                       Class leastSquaresGrad Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class leastSquaresGrad
  57 :
  58     public fv::gradScheme<Type>
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         leastSquaresGrad(const leastSquaresGrad&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const leastSquaresGrad&);
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("leastSquares");
  73
  74
  75     // Constructors
  76
  77         //- Construct from mesh
  78         leastSquaresGrad(const fvMesh& mesh)
  79         :
  80             gradScheme<Type>(mesh)
  81         {}
  82
  83         //- Construct from Istream
  84         leastSquaresGrad(const fvMesh& mesh, Istream&)
  85         :
  86             gradScheme<Type>(mesh)
  87         {}
  88
  89
  90     // Member Functions
  91
  92         tmp
  93         <
  94             GeometricField
  95             <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
  96         > grad
  97         (
  98             const GeometricField<Type, fvPatchField, volMesh>&
  99         ) const;
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace fv
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #ifdef NoRepository
 114 #   include "leastSquaresGrad.C"
 115 #endif
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //