wideBandDiffusiveRadiationMixedFvPatchScalarField.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) 2011-2015 OpenFOAM Foundation
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::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField
26 
27 Group
28  grpThermoBoundaryConditions
29 
30 Description
31  This boundary condition provides a wide-band, diffusive radiation
32  condition, where the patch temperature is specified.
33 
34  \heading Patch usage
35 
36  \table
37  Property | Description | Required | Default value
38  T | temperature field name | no | T
39  \endtable
40 
41  Example of the boundary condition specification:
42  \verbatim
43  myPatch
44  {
45  type wideBandDiffusiveRadiation;
46  value uniform 0;
47  }
48  \endverbatim
49 
50 SeeAlso
51  Foam::mixedFvPatchScalarField
52  Foam::radiationCoupledBase
53 
54 SourceFiles
55  wideBandDiffusiveRadiationMixedFvPatchScalarField.C
56 
57 \*---------------------------------------------------------------------------*/
58 
59 #ifndef wideBandDiffusiveRadiationMixedFvPatchScalarField_H
60 #define wideBandDiffusiveRadiationMixedFvPatchScalarField_H
61 
62 #include "mixedFvPatchFields.H"
63 #include "radiationCoupledBase.H"
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 namespace Foam
68 {
69 namespace radiation
70 {
71 /*---------------------------------------------------------------------------*\
72  Class wideBandDiffusiveRadiationMixedFvPatchScalarField Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 class wideBandDiffusiveRadiationMixedFvPatchScalarField
76 :
77  public mixedFvPatchScalarField,
79 {
80  // Private data
81 
82  //- Name of temperature field
83  word TName_;
84 
85 
86 public:
87 
88  //- Runtime type information
89  TypeName("wideBandDiffusiveRadiation");
90 
91 
92  // Constructors
93 
94  //- Construct from patch and internal field
96  (
97  const fvPatch&,
99  );
100 
101  //- Construct from patch, internal field and dictionary
103  (
104  const fvPatch&,
106  const dictionary&
107  );
108 
109  //- Construct by mapping given GreyDiffusiveRadiationMixedFvPatchField
110  // onto a new patch
112  (
114  const fvPatch&,
116  const fvPatchFieldMapper&
117  );
118 
119  //- Construct as copy
121  (
123  );
124 
125  //- Construct and return a clone
126  virtual tmp<fvPatchScalarField> clone() const
127  {
129  (
131  );
132  }
133 
134  //- Construct as copy setting internal field reference
136  (
139  );
140 
141  //- Construct and return a clone setting internal field reference
143  (
145  ) const
146  {
148  (
150  );
151  }
153 
154  // Member functions
155 
156  // Access
157 
158  //- Return the temperature field name
159  const word& TName() const
160  {
161  return TName_;
162  }
163 
164  //- Return reference to the temperature field name to allow
165  // adjustment
166  word& TName()
167  {
168  return TName_;
169  }
170 
171 
172  // Evaluation functions
173 
174  //- Update the coefficients associated with the patch field
175  virtual void updateCoeffs();
176 
177 
178  // I-O
179 
180  //- Write
181  virtual void write(Ostream&) const;
182 };
183 
184 
185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
186 
187 } // End namespace Foam
188 }
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #endif
193 
194 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Common functions to emissivity. It gets supplied from lookup into a dictionary or calculated by the s...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
This boundary condition provides a wide-band, diffusive radiation condition, where the patch temperat...
wideBandDiffusiveRadiationMixedFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for managing temporary objects.
Definition: PtrList.H:118
TypeName("wideBandDiffusiveRadiation")
Runtime type information.