gradTemplates.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "fvcGrad.H"
29
30// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
31
32template<class Type>
33bool Foam::functionObjects::grad::calcGrad()
34{
35 typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
36 typedef GeometricField<Type, fvsPatchField, surfaceMesh> SurfaceFieldType;
37
38 if (foundObject<VolFieldType>(fieldName_, false))
39 {
40 return store
41 (
43 fvc::grad(lookupObject<VolFieldType>(fieldName_)),
45 );
46 }
47 else if (foundObject<SurfaceFieldType>(fieldName_, false))
48 {
49 return store
50 (
52 fvc::grad(lookupObject<SurfaceFieldType>(fieldName_)),
54 );
55 }
56
57 return false;
58}
59
60
61// ************************************************************************* //
word resultName_
Name of result field.
word fieldName_
Name of field to process.
const fvMesh & mesh_
Reference to the fvMesh.
bool store(word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
Store the field in the (sub) objectRegistry under the given name.
bool changing() const noexcept
Is mesh changing (topology changing and/or moving)
Definition: polyMesh.H:562
bool cache(const word &name) const
Return true if the given field should be cached.
Definition: solution.C:270
Calculate the gradient of the given field.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > grad(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcGrad.C:54