fvcGrad.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2022 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<VolField<typename outerProduct<vector, Type>::type>>
55  grad
56  (
57  const SurfaceField<Type>&
58  );
59 
60  template<class Type>
61  tmp<VolField<typename outerProduct<vector, Type>::type>>
62  grad
63  (
64  const tmp<SurfaceField<Type>>&
65  );
66 
67  template<class Type>
68  tmp<VolField<typename outerProduct<vector, Type>::type>>
69  grad
70  (
71  const VolField<Type>&,
72  const word& name
73  );
74 
75  template<class Type>
76  tmp<VolField<typename outerProduct<vector, Type>::type>>
77  grad
78  (
79  const tmp<VolField<Type>>&,
80  const word& name
81  );
82 
83  template<class Type>
84  tmp<VolField<typename outerProduct<vector, Type>::type>>
85  grad
86  (
87  const VolField<Type>&
88  );
89 
90  template<class Type>
91  tmp<VolField<typename outerProduct<vector, Type>::type>>
92  grad
93  (
94  const tmp<VolField<Type>>&
95  );
96 }
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #ifdef NoRepository
106  #include "fvcGrad.C"
107 #endif
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
tmp< VolField< typename outerProduct< vector, Type >::type > > grad(const SurfaceField< Type > &ssf)
Definition: fvcGrad.C:46
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39