src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.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 Namespace
  26     Foam::limitFuncs
  27
  28 Description
  29     Namespace for limiting functions
  30
  31
  32 Class
  33     Foam::limitFuncs::LimitFuncs
  34
  35 Description
  36     Class to create NVD/TVD limited weighting-factors.
  37
  38     The particular differencing scheme class is supplied as a template
  39     argument, the weight function of which is called by the weight function
  40     of this class for the internal faces as well as faces of coupled
  41     patches (e.g. processor-processor patches). The weight function is
  42     supplied the central-differencing weighting factor, the face-flux, the
  43     cell and face gradients (from which the normalised variable
  44     distribution may be created) and the cell centre distance.
  45
  46     This code organisation is both neat and efficient, allowing for
  47     convenient implementation of new schemes to run on parallelised cases.
  48
  49 SourceFiles
  50     LimitFuncs.C
  51
  52 \*---------------------------------------------------------------------------*/
  53
  54 #ifndef LimitFuncs_H
  55 #define LimitFuncs_H
  56
  57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  58
  59 namespace Foam
  60 {
  61
  62 namespace limitFuncs
  63 {
  64
  65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  66
  67 template<class Type>
  68 class null
  69 {
  70 public:
  71
  72     null()
  73     {}
  74
  75     inline tmp<GeometricField<Type, fvPatchField, volMesh> > operator()
  76     (
  77         const GeometricField<Type, fvPatchField, volMesh>& phi
  78     ) const
  79     {
  80         return phi;
  81     }
  82 };
  83
  84
  85 template<class Type>
  86 class magSqr
  87 {
  88 public:
  89
  90     magSqr()
  91     {}
  92
  93     inline tmp<volScalarField> operator()
  94     (
  95         const GeometricField<Type, fvPatchField, volMesh>&
  96     ) const;
  97 };
  98
  99
 100 template<class Type>
 101 class rhoMagSqr
 102 {
 103 public:
 104
 105     rhoMagSqr()
 106     {}
 107
 108     inline tmp<volScalarField> operator()
 109     (
 110         const GeometricField<Type, fvPatchField, volMesh>&
 111     ) const;
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace limitFuncs
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #ifdef NoRepository
 123 #   include "LimitFuncs.C"
 124 #endif
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //