gradTemplates.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) 2012-2018 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 
28 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29 
30 template<class Type>
31 bool Foam::functionObjects::grad::calcGrad()
32 {
33  typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
34  typedef GeometricField<Type, fvsPatchField, surfaceMesh> SurfaceFieldType;
35 
36  if (foundObject<VolFieldType>(fieldName_))
37  {
38  return store
39  (
41  fvc::grad(lookupObject<VolFieldType>(fieldName_)),
43  );
44  }
45  else if (foundObject<SurfaceFieldType>(fieldName_))
46  {
47  return store
48  (
50  fvc::grad(lookupObject<SurfaceFieldType>(fieldName_)),
52  );
53  }
54  else
55  {
56  return false;
57  }
58 }
59 
60 
61 // ************************************************************************* //
bool changing() const
Is mesh changing (topology changing and/or moving)
Definition: polyMesh.H:540
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh >> grad(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcGrad.C:52
word resultName_
Name of result field.
Calculate the gradient of the given field.
bool cache(const word &name) const
Return true if the given field should be cached.
Definition: solution.C:229
const word fieldName_
Name of field to process.
bool store(const tmp< ObjectType > &tfield)
Store the given field in the objectRegistry.
const fvMesh & mesh_
Reference to the fvMesh.