src/finiteVolume/finiteVolume/fvc/fvcGrad.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 InNamespace
  26     Foam::fvc
  27
  28 Description
  29     Calculate the gradient of the given field.
  30
  31 SourceFiles
  32     fvcGrad.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36
  37 #ifndef fvcGrad_H
  38 #define fvcGrad_H
  39
  40 #include "volFieldsFwd.H"
  41 #include "surfaceFieldsFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                      Namespace fvc functions Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 namespace fvc
  53 {
  54     template<class Type>
  55     tmp
  56     <
  57         GeometricField
  58         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
  59     > grad
  60     (
  61         const GeometricField<Type, fvsPatchField, surfaceMesh>&
  62     );
  63
  64     template<class Type>
  65     tmp
  66     <
  67         GeometricField
  68         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
  69     > grad
  70     (
  71         const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
  72     );
  73
  74     template<class Type>
  75     tmp
  76     <
  77         GeometricField
  78         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
  79     > grad
  80     (
  81         const GeometricField<Type, fvPatchField, volMesh>&,
  82         const word& name
  83     );
  84
  85     template<class Type>
  86     tmp
  87     <
  88         GeometricField
  89         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
  90     > grad
  91     (
  92         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
  93         const word& name
  94     );
  95
  96     template<class Type>
  97     tmp
  98     <
  99         GeometricField
 100         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
 101     > grad
 102     (
 103         const GeometricField<Type, fvPatchField, volMesh>&
 104     );
 105
 106     template<class Type>
 107     tmp
 108     <
 109         GeometricField
 110         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
 111     > grad
 112     (
 113         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 114     );
 115 }
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #ifdef NoRepository
 125 #   include "fvcGrad.C"
 126 #endif
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #endif
 131
 132 // ************************************************************************* //