applications/solvers/surfaceTracking/freeSurface/patchCorrectedSnGrad/patchCorrectedSnGrad.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     patchCorrectedSnGrad
  26
  27 Description
  28     Simple central-difference snGrad scheme with non-orthogonal correction.
  29
  30 SourceFiles
  31     patchCorrectedSnGrad.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef patchCorrectedSnGrad_H
  36 #define patchCorrectedSnGrad_H
  37
  38 #include "snGradScheme.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace fv
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                  Class patchCorrectedSnGrad Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class Type>
  55 class patchCorrectedSnGrad
  56 :
  57     public snGradScheme<Type>
  58 {
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise assignment
  62         void operator=(const patchCorrectedSnGrad&);
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("patchCorrected");
  69
  70
  71     // Constructors
  72
  73         //- Construct from mesh
  74         patchCorrectedSnGrad(const fvMesh& mesh)
  75         :
  76             snGradScheme<Type>(mesh)
  77         {}
  78
  79
  80         //- Construct from mesh and data stream
  81         patchCorrectedSnGrad(const fvMesh& mesh, Istream&)
  82         :
  83             snGradScheme<Type>(mesh)
  84         {}
  85
  86
  87     // Destructor
  88
  89         virtual ~patchCorrectedSnGrad();
  90
  91
  92     // Member Functions
  93
  94         //- Return the interpolation weighting factors for the given field
  95         virtual tmp<surfaceScalarField> deltaCoeffs
  96         (
  97             const GeometricField<Type, fvPatchField, volMesh>&
  98         ) const
  99         {
 100             return this->mesh().deltaCoeffs();
 101         }
 102
 103         //- Return true if this scheme uses an explicit correction
 104         virtual bool corrected() const
 105         {
 106             return !this->mesh().orthogonal();
 107         }
 108
 109         //- Return the explicit correction to the patchCorrectedSnGrad
 110         //  for the given field
 111         virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 112         correction(const GeometricField<Type, fvPatchField, volMesh>&) 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 "patchCorrectedSnGrad.C"
 128 #endif
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //