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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField
28 
29 Group
30  grpThermoBoundaryConditions
31 
32 Description
33  This boundary condition provides a wide-band, diffusive radiation
34  condition, where the patch temperature is specified.
35 
36 Usage
37  \table
38  Property | Description | Required | Default value
39  T | temperature field name | no | T
40  \endtable
41 
42  Example of the boundary condition specification:
43  \verbatim
44  <patchName>
45  {
46  type wideBandDiffusiveRadiation;
47  value uniform 0;
48  }
49  \endverbatim
50 
51 See also
52  Foam::mixedFvPatchScalarField
53  Foam::radiationCoupledBase
54 
55 SourceFiles
56  wideBandDiffusiveRadiationMixedFvPatchScalarField.C
57 
58 \*---------------------------------------------------------------------------*/
59 
60 #ifndef wideBandDiffusiveRadiationMixedFvPatchScalarField_H
61 #define wideBandDiffusiveRadiationMixedFvPatchScalarField_H
62 
63 #include "mixedFvPatchFields.H"
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 namespace radiation
71 {
72 /*---------------------------------------------------------------------------*\
73  Class wideBandDiffusiveRadiationMixedFvPatchScalarField Declaration
74 \*---------------------------------------------------------------------------*/
75 
76 class wideBandDiffusiveRadiationMixedFvPatchScalarField
77 :
78  public mixedFvPatchScalarField
79 {
80 public:
81 
82  //- Runtime type information
83  TypeName("wideBandDiffusiveRadiation");
84 
85 
86  // Constructors
87 
88  //- Construct from patch and internal field
90  (
91  const fvPatch&,
93  );
94 
95  //- Construct from patch, internal field and dictionary
97  (
98  const fvPatch&,
100  const dictionary&
101  );
102 
103  //- Construct by mapping given GreyDiffusiveRadiationMixedFvPatchField
104  // onto a new patch
106  (
108  const fvPatch&,
110  const fvPatchFieldMapper&
111  );
112 
113  //- Construct as copy
115  (
117  );
118 
119  //- Construct and return a clone
120  virtual tmp<fvPatchScalarField> clone() const
121  {
123  (
125  );
126  }
127 
128  //- Construct as copy setting internal field reference
130  (
133  );
134 
135  //- Construct and return a clone setting internal field reference
137  (
139  ) const
140  {
142  (
144  );
145  }
146 
147 
148  // Member functions
149 
150 
151 
152  // Evaluation functions
153 
154  //- Update the coefficients associated with the patch field
155  virtual void updateCoeffs();
156 
157 
158  // I-O
159 
160  //- Write
161  virtual void write(Ostream&) const;
162 };
163 
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 } // End namespace Foam
168 }
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::clone
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.H:129
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::TypeName
TypeName("wideBandDiffusiveRadiation")
Runtime type information.
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField
This boundary condition provides a wide-band, diffusive radiation condition, where the patch temperat...
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.H:85
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
radiation
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
mixedFvPatchFields.H
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField
wideBandDiffusiveRadiationMixedFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:46
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:127
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::write
virtual void write(Ostream &) const
Write.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:304
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54