reactingEulerHtcModel.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) 2020-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::reactingEulerHtcModel
28
29Description
30 A heat transfer coefficient for reactingEuler solvers
31
32SourceFiles
33 reactingEulerHtcModel.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef Foam_functionObjects_reactingEulerHtcModel_H
38#define Foam_functionObjects_reactingEulerHtcModel_H
39
40#include "HashSet.H"
41#include "volFields.H"
42#include "fieldExpression.H"
45
46// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48namespace Foam
49{
50namespace functionObjects
51{
52
53/*---------------------------------------------------------------------------*\
54 Class reactingEulerHtcModel Declaration
55\*---------------------------------------------------------------------------*/
58:
59 public fieldExpression
60{
61 // Private Data
62
63 //- Heat transfer coefficient model
65
66
67protected:
68
69 // Protected Member Functions
70
71 //- Calculate the heat transfer coefficient field
72 // \return true on success
73 virtual bool calc();
74
75 //- Calculate heat flux
77
78 //- No copy construct
80
81 //- No copy assignment
82 void operator=(const reactingEulerHtcModel&) = delete;
83
84
85public:
86
87 //- Runtime type information
88 TypeName("reactingEulerHtcModel");
89
90
91 // Constructors
92
93 //- Construct from components
95 (
96 const word& name,
97 const Time& runTime,
98 const dictionary& dict
99 );
100
101
102 //- Destructor
103 virtual ~reactingEulerHtcModel() = default;
104
105
106 // Member Functions
107
108 //- Read the heatTransferCoeff data
109 virtual bool read(const dictionary& dict);
110};
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 reactingEuler solvers.
reactingEulerHtcModel(const reactingEulerHtcModel &)=delete
No copy construct.
virtual bool calc()
Calculate the heat transfer coefficient field.
virtual bool read(const dictionary &dict)
Read the heatTransferCoeff data.
tmp< FieldField< Field, scalar > > q() const
Calculate heat flux.
void operator=(const reactingEulerHtcModel &)=delete
No copy assignment.
virtual ~reactingEulerHtcModel()=default
Destructor.
TypeName("reactingEulerHtcModel")
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