multiphaseInterHtcModel.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) 2022 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::functionObjects::multiphaseInterHtcModel
28
29Description
30 A heat transfer coefficient for multiphase inter solvers
31 (i.e. icoReactingMultiphaseFoam).
32
33SourceFiles
34 multiphaseInterHtcModel.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef Foam_functionObjects_multiphaseInterHtcModel_H
39#define Foam_functionObjects_multiphaseInterHtcModel_H
40
41#include "HashSet.H"
42#include "volFields.H"
43#include "fieldExpression.H"
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51namespace functionObjects
52{
53
54/*---------------------------------------------------------------------------*\
55 Class multiphaseInterHtcModel Declaration
56\*---------------------------------------------------------------------------*/
59:
60 public fieldExpression
61{
62 // Private Data
63
64 //- Heat transfer coefficient model
66
67
68protected:
69
70 // Protected Member Functions
71
72 //- Calculate the heat transfer coefficient field
73 // \return true on success
74 virtual bool calc();
75
76 //- Calculate heat flux
78
79 //- No copy construct
81
82 //- No copy assignment
83 void operator=(const multiphaseInterHtcModel&) = delete;
84
85
86public:
87
88 //- Runtime type information
89 TypeName("multiphaseInterHtcModel");
90
91
92 // Constructors
93
94 //- Construct from components
96 (
97 const word& name,
98 const Time& runTime,
99 const dictionary& dict
100 );
101
102
103 //- Destructor
104 virtual ~multiphaseInterHtcModel() = default;
105
106
107 // Member Functions
108
109 //- Read the heatTransferCoeff data
110 virtual bool read(const dictionary& dict);
111};
112
113// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114
115} // End namespace functionObjects
116} // End namespace Foam
117
118// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120#endif
121
122// ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const word & name() const noexcept
Return the name of this functionObject.
Intermediate class for handling field expression function objects (e.g. blendingFactor etc....
A heat transfer coefficient for multiphase inter solvers (i.e. icoReactingMultiphaseFoam).
virtual bool calc()
Calculate the heat transfer coefficient field.
virtual bool read(const dictionary &dict)
Read the heatTransferCoeff data.
multiphaseInterHtcModel(const multiphaseInterHtcModel &)=delete
No copy construct.
tmp< FieldField< Field, scalar > > q() const
Calculate heat flux.
void operator=(const multiphaseInterHtcModel &)=delete
No copy assignment.
virtual ~multiphaseInterHtcModel()=default
Destructor.
TypeName("multiphaseInterHtcModel")
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
engineTime & runTime
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73