phaseFraction.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::wallBoilingModels::partitioningModels::phaseFraction
28 
29 Description
30  Wall heat-flux partitioned according to the phase volume fraction.
31 
32 SourceFiles
33  phaseFraction.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef phaseFraction_H
38 #define phaseFraction_H
39 
40 #include "partitioningModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace wallBoilingModels
47 {
48 namespace partitioningModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class phaseFraction Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class phaseFraction
56 :
57  public partitioningModel
58 {
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("phaseFraction");
64 
65 
66  // Constructors
67 
68  //- Construct from a dictionary
70 
71 
72  //- Destructor
73  virtual ~phaseFraction();
74 
75 
76  // Member Functions
77 
78  //- Calculate and return the wall heat-flux partitioning
79  virtual tmp<scalarField> fLiquid(const scalarField& alphaLiquid) const;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace partitioningModels
86 } // End namespace wallBoilingModels
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
Foam::wallBoilingModels::partitioningModels::phaseFraction
Wall heat-flux partitioned according to the phase volume fraction.
Definition: phaseFraction.H:54
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::wallBoilingModels::partitioningModel
Base class for wall heat flux partitioning models.
Definition: partitioningModel.H:55
Foam::wallBoilingModels::partitioningModels::phaseFraction::TypeName
TypeName("phaseFraction")
Runtime type information.
partitioningModel.H
wallBoilingModels
Critical heat flux (CHF) correlation.
Foam::wallBoilingModels::partitioningModels::phaseFraction::fLiquid
virtual tmp< scalarField > fLiquid(const scalarField &alphaLiquid) const
Calculate and return the wall heat-flux partitioning.
Definition: phaseFraction.C:72
Foam::wallBoilingModels::partitioningModels::phaseFraction::phaseFraction
phaseFraction(const dictionary &dict)
Construct from a dictionary.
Definition: phaseFraction.C:54
Foam::Field< scalar >
Foam::wallBoilingModels::partitioningModels::phaseFraction::~phaseFraction
virtual ~phaseFraction()
Destructor.
Definition: phaseFraction.C:63
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33