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 
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
78 {
79 public:
80 
81  //- Runtime type information
82  TypeName("wideBandDiffusiveRadiation");
83 
84 
85  // Constructors
86 
87  //- Construct from patch and internal field
89  (
90  const fvPatch&,
92  );
93 
94  //- Construct from patch, internal field and dictionary
96  (
97  const fvPatch&,
99  const dictionary&
100  );
101 
102  //- Construct by mapping given GreyDiffusiveRadiationMixedFvPatchField
103  // onto a new patch
105  (
107  const fvPatch&,
109  const fvPatchFieldMapper&
110  );
111 
112  //- Construct as copy
114  (
116  );
117 
118  //- Construct and return a clone
119  virtual tmp<fvPatchScalarField> clone() const
120  {
122  (
124  );
125  }
126 
127  //- Construct as copy setting internal field reference
129  (
132  );
133 
134  //- Construct and return a clone setting internal field reference
136  (
138  ) const
139  {
141  (
143  );
144  }
145 
146 
147  // Member functions
148 
149 
150 
151  // Evaluation functions
152 
153  //- Update the coefficients associated with the patch field
154  virtual void updateCoeffs();
155 
156 
157  // I-O
158 
159  //- Write
160  virtual void write(Ostream&) const;
161 };
162 
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 } // End namespace Foam
167 }
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 #endif
172 
173 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::clone
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.H:128
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:84
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
radiation
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
mixedFvPatchFields.H
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField
wideBandDiffusiveRadiationMixedFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:43
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:45
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:124
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::write
virtual void write(Ostream &) const
Write.
Definition: wideBandDiffusiveRadiationMixedFvPatchScalarField.C:230
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:51