fvcGrad.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 InNamespace
25  Foam::fvc
26 
27 Description
28  Calculate the gradient of the given field.
29 
30 SourceFiles
31  fvcGrad.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 
36 #ifndef fvcGrad_H
37 #define fvcGrad_H
38 
39 #include "volFieldsFwd.H"
40 #include "surfaceFieldsFwd.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Namespace fvc functions Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 namespace fvc
52 {
53  template<class Type>
54  tmp
55  <
56  GeometricField
57  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
58  > grad
59  (
60  const GeometricField<Type, fvsPatchField, surfaceMesh>&
61  );
62 
63  template<class Type>
64  tmp
65  <
66  GeometricField
67  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
68  > grad
69  (
70  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
71  );
72 
73  template<class Type>
74  tmp
75  <
76  GeometricField
77  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
78  > grad
79  (
80  const GeometricField<Type, fvPatchField, volMesh>&,
81  const word& name
82  );
83 
84  template<class Type>
85  tmp
86  <
87  GeometricField
88  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
89  > grad
90  (
91  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
92  const word& name
93  );
94 
95  template<class Type>
96  tmp
97  <
98  GeometricField
99  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
100  > grad
101  (
102  const GeometricField<Type, fvPatchField, volMesh>&
103  );
104 
105  template<class Type>
106  tmp
107  <
108  GeometricField
109  <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
110  > grad
111  (
112  const tmp<GeometricField<Type, fvPatchField, volMesh> >&
113  );
114 }
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #ifdef NoRepository
124 # include "fvcGrad.C"
125 #endif
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Namespace for OpenFOAM.
typeOfRank< typename pTraits< arg1 >::cmptType, int(pTraits< arg1 >::rank)+int(pTraits< arg2 >::rank) >::type type
Definition: products.H:72
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh >> grad(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcGrad.C:52