fvcGrad.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "fvcGrad.H"
27 #include "fvcSurfaceIntegrate.H"
28 #include "fvMesh.H"
29 #include "gaussGrad.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
37 
38 namespace fvc
39 {
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 template<class Type>
44 tmp
45 <
46  GeometricField
47  <
48  typename outerProduct<vector, Type>::type, fvPatchField, volMesh
49  >
50 >
51 grad
52 (
54 )
55 {
56  return fv::gaussGrad<Type>::gradf(ssf, "grad(" + ssf.name() + ')');
57 }
58 
59 
60 template<class Type>
61 tmp
62 <
64  <
65  typename outerProduct<vector,Type>::type, fvPatchField, volMesh
66  >
67 >
68 grad
69 (
71 )
72 {
73  typedef typename outerProduct<vector, Type>::type GradType;
75  (
76  fvc::grad(tssf())
77  );
78  tssf.clear();
79  return Grad;
80 }
81 
82 
83 template<class Type>
84 tmp
85 <
87  <
88  typename outerProduct<vector,Type>::type, fvPatchField, volMesh
89  >
90 >
91 grad
92 (
94  const word& name
95 )
96 {
98  (
99  vf.mesh(),
100  vf.mesh().schemes().grad(name)
101  )().grad(vf, name);
102 }
103 
104 
105 template<class Type>
106 tmp
107 <
109  <
110  typename outerProduct<vector,Type>::type, fvPatchField, volMesh
111  >
112 >
113 grad
114 (
116  const word& name
117 )
118 {
119  tmp
120  <
122  <
123  typename outerProduct<vector, Type>::type, fvPatchField, volMesh
124  >
125  > tGrad
126  (
127  fvc::grad(tvf(), name)
128  );
129  tvf.clear();
130  return tGrad;
131 }
132 
133 
134 template<class Type>
135 tmp
136 <
138  <
139  typename outerProduct<vector,Type>::type, fvPatchField, volMesh
140  >
141 >
142 grad
143 (
145 )
146 {
147  return fvc::grad(vf, "grad(" + vf.name() + ')');
148 }
149 
150 
151 template<class Type>
152 tmp
153 <
155  <
156  typename outerProduct<vector,Type>::type, fvPatchField, volMesh
157  >
158 >
159 grad
160 (
162 )
163 {
164  typedef typename outerProduct<vector, Type>::type GradType;
166  (
167  fvc::grad(tvf())
168  );
169  tvf.clear();
170  return Grad;
171 }
172 
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 } // End namespace fvc
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 } // End namespace Foam
181 
182 // ************************************************************************* //
Surface integrate surfaceField creating a volField. Surface sum a surfaceField creating a volField...
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh >> grad(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcGrad.C:52
const word & name() const
Return name.
Definition: IOobject.H:315
static tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > gradf(const GeometricField< Type, fvsPatchField, surfaceMesh > &, const word &name)
Return the gradient of the given field.
Generic GeometricField class.
Mesh data needed to do the Finite Volume discretisation.
Definition: volMesh.H:53
Calculate the gradient of the given field.
A class for handling words, derived from string.
Definition: word.H:59
const Mesh & mesh() const
Return mesh.
static tmp< gradScheme< Type > > New(const fvMesh &mesh, Istream &schemeData)
Return a pointer to a new gradScheme created on freestore.
Definition: gradScheme.C:34
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.