MarshakRadiationFvPatchScalarField.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::MarshakRadiationFvPatchScalarField
28
29Group
30 grpThermoBoundaryConditions
31
32Description
33 A 'mixed' boundary condition that implements a Marshak condition for the
34 incident radiation field (usually written as G)
35
36 The radiation temperature is retrieved from the mesh database, using a
37 user specified temperature field name.
38
39Usage
40 \table
41 Property | Description | Required | Default value
42 T | temperature field name | no | T
43 \endtable
44
45 Example of the boundary condition specification:
46 \verbatim
47 <patchName>
48 {
49 type MarshakRadiation;
50 T T;
51 value uniform 0;
52 }
53 \endverbatim
54
55See also
56 Foam::radiationCoupledBase
57 Foam::mixedFvPatchField
58
59SourceFiles
60 MarshakRadiationFvPatchScalarField.C
61
62\*---------------------------------------------------------------------------*/
63
64#ifndef radiation_MarshakRadiationFvPatchScalarField_H
65#define radiation_MarshakRadiationFvPatchScalarField_H
66
67#include "mixedFvPatchFields.H"
68
69// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70
71namespace Foam
72{
73namespace radiation
74{
75
76/*---------------------------------------------------------------------------*\
77 Class MarshakRadiationFvPatchScalarField Declaration
78\*---------------------------------------------------------------------------*/
79
81:
82 public mixedFvPatchScalarField
83{
84
85 // Private data
86
87 //- Name of temperature field
88 word TName_;
90
91public:
92
93 //- Runtime type information
94 TypeName("MarshakRadiation");
95
96
97 // Constructors
98
99 //- Construct from patch and internal field
101 (
102 const fvPatch&,
104 );
105
106 //- Construct from patch, internal field and dictionary
108 (
109 const fvPatch&,
111 const dictionary&
112 );
113
114 //- Construct by mapping given MarshakRadiationFvPatchField onto a new
115 // patch
117 (
119 const fvPatch&,
121 const fvPatchFieldMapper&
122 );
123
124 //- Construct as copy
126 (
128 );
129
130 //- Construct and return a clone
131 virtual tmp<fvPatchScalarField> clone() const
132 {
134 (
136 );
137 }
138
139 //- Construct as copy setting internal field reference
141 (
144 );
145
146 //- Construct and return a clone setting internal field reference
148 (
150 ) const
151 {
153 (
155 );
157
158
159 // Member functions
160
161 // Access
162
163 //- Return the temperature field name
164 const word& TName() const
165 {
166 return TName_;
167 }
168
169 //- Return reference to the temperature field name to allow
170 // adjustment
171 word& TName()
172 {
173 return TName_;
174 }
175
176
177 // Evaluation functions
178
179 //- Update the coefficients associated with the patch field
180 virtual void updateCoeffs();
181
182
183 // I-O
184
185 //- Write
186 virtual void write(Ostream&) const;
187};
188
189
190// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191
192} // End namespace radiation
193} // End namespace Foam
194
195// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196
197#endif
198
199// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A 'mixed' boundary condition that implements a Marshak condition for the incident radiation field (us...
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
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("MarshakRadiation")
Runtime type information.
const word & TName() const
Return the temperature field name.
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73