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