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