ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / radiationModels / derivedFvPatchFields / greyDiffusiveViewFactor / greyDiffusiveViewFactorFixedValueFvPatchScalarField.H
blob74a552ddb16476ea4e4fb9a402adaeae7183f281
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField
27 Description
28     Radiation temperature specified
30 SourceFiles
31     greyDiffusiveViewFactorFixedValueFvPatchScalarField.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef greyDiffusiveViewFactorFixedValueFvPatchScalarField_H
36 #define greyDiffusiveViewFactorFixedValueFvPatchScalarField_H
38 #include "radiationCoupledBase.H"
39 #include "fixedValueFvPatchFields.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace radiation
47 /*---------------------------------------------------------------------------*\
48       Class greyDiffusiveViewFactorFixedValueFvPatchScalarField declaration
49 \*---------------------------------------------------------------------------*/
51 class greyDiffusiveViewFactorFixedValueFvPatchScalarField
53     public fixedValueFvPatchScalarField,
54     public radiationCoupledBase
56     // Private data
58         //- External radiative heat flux
59         scalarField Qro_;
62 public:
64     //- Runtime type information
65     TypeName("greyDiffusiveRadiationViewFactor");
68     // Constructors
70         //- Construct from patch and internal field
71         greyDiffusiveViewFactorFixedValueFvPatchScalarField
72         (
73             const fvPatch&,
74             const DimensionedField<scalar, volMesh>&
75         );
77         //- Construct from patch, internal field and dictionary
78         greyDiffusiveViewFactorFixedValueFvPatchScalarField
79         (
80             const fvPatch&,
81             const DimensionedField<scalar, volMesh>&,
82             const dictionary&
83         );
85         //- Construct by mapping given a
86         // greyDiffusiveViewFactorFixedValueFvPatchScalarField onto a new patch
87         greyDiffusiveViewFactorFixedValueFvPatchScalarField
88         (
89             const greyDiffusiveViewFactorFixedValueFvPatchScalarField&,
90             const fvPatch&,
91             const DimensionedField<scalar, volMesh>&,
92             const fvPatchFieldMapper&
93         );
95         //- Construct as copy
96         greyDiffusiveViewFactorFixedValueFvPatchScalarField
97         (
98             const greyDiffusiveViewFactorFixedValueFvPatchScalarField&
99         );
101         //- Construct and return a clone
102         virtual tmp<fvPatchScalarField> clone() const
103         {
104             return tmp<fvPatchScalarField>
105             (
106                 new greyDiffusiveViewFactorFixedValueFvPatchScalarField(*this)
107             );
108         }
110         //- Construct as copy setting internal field reference
111         greyDiffusiveViewFactorFixedValueFvPatchScalarField
112         (
113             const greyDiffusiveViewFactorFixedValueFvPatchScalarField&,
114             const DimensionedField<scalar, volMesh>&
115         );
117         //- Construct and return a clone setting internal field reference
118         virtual tmp<fvPatchScalarField> clone
119         (
120             const DimensionedField<scalar, volMesh>& iF
121         ) const
122         {
123             return tmp<fvPatchScalarField>
124             (
125                 new greyDiffusiveViewFactorFixedValueFvPatchScalarField
126                 (
127                     *this,
128                     iF
129                 )
130             );
131         }
134     // Member functions
136         // Access
138             //- Return external radiative heat flux
139             const scalarList& Qro()
140             {
141                 return Qro_;
142             }
145         // Evaluation functions
147             //- Update the coefficients associated with the patch field
148             virtual void updateCoeffs();
151         // I-O
153             //- Write
154             virtual void write(Ostream&) const;
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 } // End namespace Foam
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 #endif
167 // ************************************************************************* //