FreeFOAM The Cross-Platform CFD Toolkit
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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::wallHeatTransferFvPatchScalarField
26 
27 Description
28  Enthalpy boundary conditions for wall heat transfer
29 
30 SourceFiles
31  wallHeatTransferFvPatchScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef wallHeatTransferFvPatchScalarField_H
36 #define wallHeatTransferFvPatchScalarField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class wallHeatTransferFvPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public mixedFvPatchScalarField
52 {
53  // Private data
54 
55  //- Tinf
56  scalarField Tinf_;
57 
58  //- alphaWall
59  scalarField alphaWall_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("wallHeatTransfer");
66 
67 
68  // Constructors
69 
70  //- Construct from patch and internal field
72  (
73  const fvPatch&,
75  );
76 
77  //- Construct from patch, internal field and dictionary
79  (
80  const fvPatch&,
82  const dictionary&
83  );
84 
85  //- Construct by mapping given wallHeatTransferFvPatchScalarField
86  // onto a new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
103  {
105  (
107  );
108  }
109 
110  //- Construct as copy setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
124  (
126  );
127  }
128 
129 
130  // Member functions
131 
132  // Access
133 
134  //- Return Tinf
135  const scalarField& Tinf() const
136  {
137  return Tinf_;
138  }
139 
140  //- Return reference to Tinf to allow adjustment
142  {
143  return Tinf_;
144  }
145 
146  //- Return alphaWall
147  const scalarField& alphaWall() const
148  {
149  return alphaWall_;
150  }
151 
152  //- Return reference to alphaWall to allow adjustment
154  {
155  return alphaWall_;
156  }
157 
158 
159  // Mapping functions
160 
161  //- Map (and resize as needed) from self given a mapping object
162  virtual void autoMap
163  (
164  const fvPatchFieldMapper&
165  );
166 
167  //- Reverse map the given fvPatchField onto this fvPatchField
168  virtual void rmap
169  (
170  const fvPatchScalarField&,
171  const labelList&
172  );
173 
174 
175  // Evaluation functions
176 
177  //- Update the coefficients associated with the patch field
178  virtual void updateCoeffs();
179 
180 
181  //- Write
182  virtual void write(Ostream&) const;
183 };
184 
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 } // End namespace Foam
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #endif
193 
194 // ************************ vim: set sw=4 sts=4 et: ************************ //