MarshakRadiationFixedTemperatureFvPatchScalarField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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::MarshakRadiationFixedTemperatureFvPatchScalarField
26 
27 Description
28  A 'mixed' boundary condition that implements a Marshak condition for the
29  incident radiation field (usually written as G)
30 
31  The radiation temperature field across the patch is supplied by the user
32  using the \c Trad entry.
33 
34 Usage
35  \table
36  Property | Description | Required | Default value
37  T | temperature field name | no | T
38  \endtable
39 
40  Example of the boundary condition specification:
41  \verbatim
42  <patchName>
43  {
44  type MarshakRadiationFixedTemperature;
45  Trad uniform 1000; // radiation temperature field
46  value uniform 0; // place holder
47  }
48  \endverbatim
49 
50 See also
51  Foam::radiationCoupledBase
52  Foam::mixedFvPatchField
53 
54 SourceFiles
55  MarshakRadiationFixedTemperatureFvPatchScalarField.C
56 
57 \*---------------------------------------------------------------------------*/
58 
59 #ifndef MarshakRadiationFixedTemperatureFvPatchScalarField_H
60 #define MarshakRadiationFixedTemperatureFvPatchScalarField_H
61 
62 #include "mixedFvPatchFields.H"
63 #include "radiationCoupledBase.H"
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 namespace Foam
68 {
69 
70 /*---------------------------------------------------------------------------*\
71  Class MarshakRadiationFixedTemperatureFvPatchScalarField Declaration
72 \*---------------------------------------------------------------------------*/
73 
74 class MarshakRadiationFixedTemperatureFvPatchScalarField
75 :
76  public mixedFvPatchScalarField,
77  public radiationCoupledBase
78 {
79 
80  // Private Data
81 
82  //- Radiation temperature field
83  scalarField Trad_;
84 
85 
86 public:
87 
88  //- Runtime type information
89  TypeName("MarshakRadiationFixedTemperature");
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 MarshakRadiationFvPatchField onto a new
110  // patch
112  (
114  const fvPatch&,
116  const fvPatchFieldMapper&
117  );
118 
119  //- Copy constructor
121  (
123  );
124 
125  //- Construct and return a clone
126  virtual tmp<fvPatchScalarField> clone() const
127  {
129  (
131  );
132  }
133 
134  //- Copy constructor setting internal field reference
136  (
139  );
140 
141  //- Construct and return a clone setting internal field reference
143  (
145  ) const
146  {
148  (
150  (
151  *this,
152  iF
153  )
154  );
155  }
156 
157 
158  // Member Functions
159 
160  // Access
161 
162  //- Return the radiation temperature
163  const scalarField& Trad() const
164  {
165  return Trad_;
166  }
167 
168  //- Return reference to the radiation temperature to allow
169  // adjustment
170  scalarField& Trad()
171  {
172  return Trad_;
173  }
174 
175 
176  // Mapping functions
177 
178  //- Map (and resize as needed) from self given a mapping object
179  // Used to update fields following mesh topology change
180  virtual void autoMap(const fvPatchFieldMapper&);
181 
182  //- Reverse map the given fvPatchField onto this fvPatchField
183  // Used to reconstruct fields
184  virtual void rmap(const fvPatchScalarField&, const labelList&);
185 
186 
187  // Evaluation functions
188 
189  //- Update the coefficients associated with the patch field
190  virtual void updateCoeffs();
191 
192 
193  // I-O
194 
195  //- Write
196  virtual void write(Ostream&) const;
197 };
198 
199 
200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
201 
202 } // End namespace Foam
203 
204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
205 
206 #endif
207 
208 // ************************************************************************* //
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
MarshakRadiationFixedTemperatureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
TypeName("MarshakRadiationFixedTemperature")
Runtime type information.
A &#39;mixed&#39; boundary condition that implements a Marshak condition for the incident radiation field (us...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Namespace for OpenFOAM.