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