wallHeatTransferFvPatchScalarField.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) 2011-2016 OpenFOAM Foundation
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::wallHeatTransferFvPatchScalarField
28
29Group
30 grpThermoBoundaryConditions grpWallBoundaryConditions
31
32Description
33 This boundary condition provides an enthalpy condition for wall heat
34 transfer
35
36Usage
37 \table
38 Property | Description | Required | Default value
39 Tinf | wall temperature | yes |
40 alphaWall | thermal diffusivity | yes |
41 \endtable
42
43 Example of the boundary condition specification:
44 \verbatim
45 <patchName>
46 {
47 type wallHeatTransfer;
48 Tinf uniform 500;
49 alphaWall uniform 1;
50 }
51 \endverbatim
52
53SourceFiles
54 wallHeatTransferFvPatchScalarField.C
55
56\*---------------------------------------------------------------------------*/
57
58#ifndef wallHeatTransferFvPatchScalarField_H
59#define wallHeatTransferFvPatchScalarField_H
60
61#include "mixedFvPatchFields.H"
62
63// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64
65namespace Foam
66{
67
68/*---------------------------------------------------------------------------*\
69 Class wallHeatTransferFvPatchScalarField Declaration
70\*---------------------------------------------------------------------------*/
71
72class wallHeatTransferFvPatchScalarField
73:
74 public mixedFvPatchScalarField
75{
76 // Private data
77
78 //- Temperature at the wall
79 scalarField Tinf_;
80
81 //- Thermal diffusivity at the wall
82 scalarField alphaWall_;
83
84
85public:
87 //- Runtime type information
88 TypeName("wallHeatTransfer");
89
90
91 // Constructors
92
93 //- Construct from patch and internal field
95 (
96 const fvPatch&,
98 );
99
100 //- Construct from patch, internal field and dictionary
103 const fvPatch&,
105 const dictionary&
106 );
107
108 //- Construct by mapping given wallHeatTransferFvPatchScalarField
109 // onto a new patch
111 (
113 const fvPatch&,
115 const fvPatchFieldMapper&
116 );
117
118 //- Construct as copy
120 (
122 );
123
124 //- Construct and return a clone
125 virtual tmp<fvPatchScalarField> clone() const
126 {
128 (
130 );
131 }
132
133 //- Construct as copy setting internal field reference
135 (
138 );
140 //- Construct and return a clone setting internal field reference
142 (
144 ) const
145 {
147 (
149 );
150 }
151
152
153 // Member functions
154
155 // Access
156
157 //- Return Tinf
158 const scalarField& Tinf() const
159 {
160 return Tinf_;
161 }
162
163 //- Return reference to Tinf to allow adjustment
165 {
166 return Tinf_;
167 }
168
169 //- Return alphaWall
170 const scalarField& alphaWall() const
171 {
172 return alphaWall_;
173 }
174
175 //- Return reference to alphaWall to allow adjustment
177 {
178 return alphaWall_;
179 }
180
181
182 // Mapping functions
183
184 //- Map (and resize as needed) from self given a mapping object
185 virtual void autoMap
186 (
187 const fvPatchFieldMapper&
188 );
189
190 //- Reverse map the given fvPatchField onto this fvPatchField
191 virtual void rmap
192 (
193 const fvPatchScalarField&,
194 const labelList&
195 );
196
197
198 // Evaluation functions
199
200 //- Update the coefficients associated with the patch field
201 virtual void updateCoeffs();
202
203
204 //- Write
205 virtual void write(Ostream&) const;
206};
207
208
209// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210
211} // End namespace Foam
212
213// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
214
215#endif
216
217// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
This boundary condition provides an enthalpy condition for wall heat transfer.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
scalarField & alphaWall()
Return reference to alphaWall to allow adjustment.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
TypeName("wallHeatTransfer")
Runtime type information.
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
const scalarField & alphaWall() const
Return alphaWall.
scalarField & Tinf()
Return reference to Tinf to allow adjustment.
Namespace for OpenFOAM.
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73