initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / finiteVolume / fvc / fvcSnGrad.H
blob807efe3e4b2bc88eba68ff2cfd20f36edf9373cd
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.
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.
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.
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
25 InNamespace
26     Foam::fvc
28 Description
29     Calculate the snGrad of the given volField.
31 SourceFiles
32     fvcSnGrad.C
34 \*---------------------------------------------------------------------------*/
37 #ifndef fvcSnGrad_H
38 #define fvcSnGrad_H
40 #include "volFieldsFwd.H"
41 #include "surfaceFieldsFwd.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                      Namespace fvc functions Declaration
50 \*---------------------------------------------------------------------------*/
52 namespace fvc
54     template<class Type>
55     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > snGrad
56     (
57         const GeometricField<Type, fvPatchField, volMesh>&,
58         const word& name
59     );
61     template<class Type>
62     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > snGrad
63     (
64         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
65         const word& name
66     );
68     template<class Type>
69     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > snGrad
70     (
71         const GeometricField<Type, fvPatchField, volMesh>&
72     );
74     template<class Type>
75     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > snGrad
76     (
77         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
78     );
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 } // End namespace Foam
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 #ifdef NoRepository
89 #   include "fvcSnGrad.C"
90 #endif
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 #endif
96 // ************************************************************************* //