src/finiteVolume/finiteVolume/snGradSchemes/correctedSnGrad/correctedSnGrad.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::correctedSnGrad
  27
  28 Description
  29     Simple central-difference snGrad scheme with non-orthogonal correction.
  30
  31 SourceFiles
  32     correctedSnGrad.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef correctedSnGrad_H
  37 #define correctedSnGrad_H
  38
  39 #include "snGradScheme.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace fv
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                  Class correctedSnGrad Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class correctedSnGrad
  57 :
  58     public snGradScheme<Type>
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const correctedSnGrad&);
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("corrected");
  70
  71
  72     // Constructors
  73
  74         //- Construct from mesh
  75         correctedSnGrad(const fvMesh& mesh)
  76         :
  77             snGradScheme<Type>(mesh)
  78         {}
  79
  80
  81         //- Construct from mesh and data stream
  82         correctedSnGrad(const fvMesh& mesh, Istream&)
  83         :
  84             snGradScheme<Type>(mesh)
  85         {}
  86
  87
  88     // Destructor
  89
  90         virtual ~correctedSnGrad();
  91
  92
  93     // Member Functions
  94
  95         //- Return the interpolation weighting factors for the given field
  96         virtual tmp<surfaceScalarField> deltaCoeffs
  97         (
  98             const GeometricField<Type, fvPatchField, volMesh>&
  99         ) const
 100         {
 101             return this->mesh().deltaCoeffs();
 102         }
 103
 104         //- Return true if this scheme uses an explicit correction
 105         virtual bool corrected() const
 106         {
 107             return !this->mesh().orthogonal();
 108         }
 109
 110         //- Return the explicit correction to the correctedSnGrad
 111         //  for the given field
 112         virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 113         correction(const GeometricField<Type, fvPatchField, volMesh>&) const;
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace fv
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #ifdef NoRepository
 128 #   include "correctedSnGrad.C"
 129 #endif
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //