streamFunction.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) 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::streamFunction
26 
27 Group
28  grpFieldFunctionObjects
29 
30 Description
31  This function object calculates and outputs the stream-function as a
32  pointScalarField.
33 
34 See also
35  Foam::functionObjects::fieldExpression
36  Foam::functionObjects::fvMeshFunctionObject
37 
38 SourceFiles
39  streamFunction.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef functionObjects_streamFunction_H
44 #define functionObjects_streamFunction_H
45 
46 #include "fieldExpression.H"
47 #include "surfaceFieldsFwd.H"
48 #include "pointFieldsFwd.H"
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 namespace Foam
53 {
54 namespace functionObjects
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class streamFunction Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 class streamFunction
62 :
63  public fieldExpression
64 {
65  // Private Member Functions
66 
67  tmp<pointScalarField> calc(const surfaceScalarField& phi) const;
68 
69  //- Calculate the stream-function and return true if successful
70  virtual bool calc();
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("streamFunction");
77 
78 
79  // Constructors
80 
81  //- Construct for given objectRegistry and dictionary.
82  // Allow the possibility to load fields from files
84  (
85  const word& name,
86  const Time& runTime,
87  const dictionary& dict
88  );
89 
90 
91  //- Destructor
92  virtual ~streamFunction();
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace functionObjects
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
surfaceScalarField & phi
dictionary dict
streamFunction(const word &name, const Time &runTime, const dictionary &dict)
Construct for given objectRegistry and dictionary.
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
TypeName("streamFunction")
Runtime type information.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
This function object calculates and outputs the stream-function as a pointScalarField.
A class for handling words, derived from string.
Definition: word.H:59
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.