cosine.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::wallBoilingModels::partitioningModels::cosine
26 
27 Description
28  Cosine wall heat flux partitioning model.
29 
30  Proposed threshold liquid fractions:
31  - alphaLiquid1 0.1
32  - alphaLiquid0 0.05
33 
34  \verbatim
35  Tentner, A., Lo, S., & Kozlov, V. (2006).
36  Advances in computational fluid dynamics modeling
37  of two-phase flow in boiling water reactor fuel assemblies.
38  In International Conference of Nuclear Engineering,
39  Miami, Florida, USA.
40  \endverbatim
41 
42 SourceFiles
43  cosine.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef cosine_H
48 #define cosine_H
49 
50 #include "partitioningModel.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 namespace wallBoilingModels
57 {
58 namespace partitioningModels
59 {
60 
61 /*---------------------------------------------------------------------------*\
62  Class cosine Declaration
63 \*---------------------------------------------------------------------------*/
64 
65 class cosine
66 :
67  public partitioningModel
68 {
69  // Private data
70 
71  // Model parameters, threshold liquid phase fractions
72  scalar alphaLiquid1_;
73  scalar alphaLiquid0_;
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("cosine");
80 
81 
82  // Constructors
83 
84  //- Construct from a dictionary
85  cosine(const dictionary& dict);
86 
87 
88  //- Destructor
89  virtual ~cosine();
90 
91 
92  // Member Functions
93 
94  //- Calculate and return the wall heat-flux partitioning
95  virtual tmp<scalarField> fLiquid(const scalarField& alphaLiquid) const;
96 
97  virtual void write(Ostream& os) const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace partitioningModels
104 } // End namespace wallBoilingModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
dictionary dict
cosine(const dictionary &dict)
Construct from a dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Cosine wall heat flux partitioning model.
Definition: cosine.H:64
TypeName("cosine")
Runtime type information.
virtual tmp< scalarField > fLiquid(const scalarField &alphaLiquid) const
Calculate and return the wall heat-flux partitioning.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A class for managing temporary objects.
Definition: PtrList.H:53
Base class for wall heat flux partitioning models.
Namespace for OpenFOAM.