blendingFactor.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) 2013-2020 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::blendingFactor
26 
27 Description
28  Calculates and outputs the blendingFactor as used by the bended convection
29  schemes. The output is a volume field (cells) whose value is calculated via
30  the maximum blending factor for any cell face.
31 
32 See also
33  Foam::functionObjects::fieldExpression
34  Foam::functionObjects::fvMeshFunctionObject
35 
36 SourceFiles
37  blendingFactor.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef functionObjects_blendingFactor_H
42 #define functionObjects_blendingFactor_H
43 
44 #include "fieldExpression.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace functionObjects
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class blendingFactor Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class blendingFactor
58 :
59  public fieldExpression
60 {
61  // Private member data
62 
63  //- Name of flux field, default is "phi"
64  word phiName_;
65 
66 
67  // Private Member Functions
68 
69  //- Calculate the blending factor field
70  template<class Type>
71  bool calcBF();
72 
73  //- Calculate the blending factor field and return true if successful
74  virtual bool calc();
75 
76 
77 public:
78 
79  //- Runtime type information
80  TypeName("blendingFactor");
81 
82 
83  // Constructors
84 
85  //- Construct from Time and dictionary
87  (
88  const word& name,
89  const Time& runTime,
90  const dictionary& dict
91  );
92 
93 
94  //- Destructor
95  virtual ~blendingFactor();
96 
97 
98  // Member Functions
99 
100  //- Read the blendingFactor data
101  virtual bool read(const dictionary&);
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace functionObjects
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113  #include "blendingFactorTemplates.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
dictionary dict
Calculates and outputs the blendingFactor as used by the bended convection schemes. The output is a volume field (cells) whose value is calculated via the maximum blending factor for any cell face.
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:156
engineTime & runTime
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
virtual bool read(const dictionary &)
Read the blendingFactor data.
A class for handling words, derived from string.
Definition: word.H:59
virtual ~blendingFactor()
Destructor.
TypeName("blendingFactor")
Runtime type information.
Namespace for OpenFOAM.
blendingFactor(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.