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