grad.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) 2012-2016 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 Class
25  Foam::functionObjects::grad
26 
27 Group
28  grpFieldFunctionObjects
29 
30 Description
31  This function object calculates the gradient of a field. The operation is
32  limited to scalar and vector volume or surface fields, and the output is a
33  volume vector or tensor field.
34 
35 See also
36  Foam::functionObjects::fvMeshFunctionObject
37 
38 SourceFiles
39  grad.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef functionObjects_grad_H
44 #define functionObjects_grad_H
45 
46 #include "fieldExpression.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace functionObjects
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class grad Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 class grad
60 :
61  public fieldExpression
62 {
63  // Private Member Functions
64 
65  //- Calculate the magnitude of the field and register the result
66  template<class Type>
67  bool calcGrad();
68 
69  //- Calculate the gradient field and return true if successful
70  virtual bool calc();
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("grad");
77 
78 
79  // Constructors
80 
81  //- Construct from Time and dictionary
82  grad
83  (
84  const word& name,
85  const Time& runTime,
86  const dictionary& dict
87  );
88 
89 
90  //- Destructor
91  virtual ~grad();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace functionObjects
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #ifdef NoRepository
103  #include "gradTemplates.C"
104 #endif
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
const word & name() const
Return the name of this functionObject.
A class for handling words, derived from string.
Definition: word.H:59
This function object calculates the gradient of a field. The operation is limited to scalar and vecto...
Definition: grad.H:58
TypeName("grad")
Runtime type information.
grad(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: grad.C:57
Namespace for OpenFOAM.
virtual ~grad()
Destructor.
Definition: grad.C:71