ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / radiationModels / derivedFvPatchFields / MarshakRadiationFixedT / MarshakRadiationFixedTMixedFvPatchScalarField.H
blob97bde41076786e4a4fde990ec4d47853b9c4bb5b
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::MarshakRadiationFixedTMixedFvPatchScalarField
27 Description
28     Marshak boundary for radiation G field
29     - radiation temperature specified
31 SourceFiles
32     MarshakRadiationFixedTMixedFvPatchScalarField.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef MarshakRadiationFixedTMixedFvPatchField_H
37 #define MarshakRadiationFixedTMixedFvPatchField_H
39 #include "mixedFvPatchFields.H"
40 #include "radiationCoupledBase.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48         Class MarshakRadiationFixedTMixedFvPatchScalarField Declaration
49 \*---------------------------------------------------------------------------*/
51 class MarshakRadiationFixedTMixedFvPatchScalarField
53     public mixedFvPatchScalarField,
54     public radiationCoupledBase
57     // Private data
59         //- Radiation temperature field
60         scalarField Trad_;
63 public:
65     //- Runtime type information
66     TypeName("MarshakRadiationFixedT");
69     // Constructors
71         //- Construct from patch and internal field
72         MarshakRadiationFixedTMixedFvPatchScalarField
73         (
74             const fvPatch&,
75             const DimensionedField<scalar, volMesh>&
76         );
78         //- Construct from patch, internal field and dictionary
79         MarshakRadiationFixedTMixedFvPatchScalarField
80         (
81             const fvPatch&,
82             const DimensionedField<scalar, volMesh>&,
83             const dictionary&
84         );
86         //- Construct by mapping given MarshakRadiationFvPatchField onto a new
87         //  patch
88         MarshakRadiationFixedTMixedFvPatchScalarField
89         (
90             const MarshakRadiationFixedTMixedFvPatchScalarField&,
91             const fvPatch&,
92             const DimensionedField<scalar, volMesh>&,
93             const fvPatchFieldMapper&
94         );
96         //- Construct as copy
97         MarshakRadiationFixedTMixedFvPatchScalarField
98         (
99             const MarshakRadiationFixedTMixedFvPatchScalarField&
100         );
102         //- Construct and return a clone
103         virtual tmp<fvPatchScalarField> clone() const
104         {
105             return tmp<fvPatchScalarField>
106             (
107                 new MarshakRadiationFixedTMixedFvPatchScalarField(*this)
108             );
109         }
111         //- Construct as copy setting internal field reference
112         MarshakRadiationFixedTMixedFvPatchScalarField
113         (
114             const MarshakRadiationFixedTMixedFvPatchScalarField&,
115             const DimensionedField<scalar, volMesh>&
116         );
118         //- Construct and return a clone setting internal field reference
119         virtual tmp<fvPatchScalarField> clone
120         (
121             const DimensionedField<scalar, volMesh>& iF
122         ) const
123         {
124             return tmp<fvPatchScalarField>
125             (
126                 new MarshakRadiationFixedTMixedFvPatchScalarField(*this, iF)
127             );
128         }
131     // Member functions
133         // Access
135             //- Return the radiation temperature
136             const scalarField& Trad() const
137             {
138                 return Trad_;
139             }
141             //- Return reference to the radiation temperature to allow
142             //  adjustment
143             scalarField& Trad()
144             {
145                 return Trad_;
146             }
149         // Mapping functions
151             //- Map (and resize as needed) from self given a mapping object
152             virtual void autoMap
153             (
154                 const fvPatchFieldMapper&
155             );
157             //- Reverse map the given fvPatchField onto this fvPatchField
158             virtual void rmap
159             (
160                 const fvPatchScalarField&,
161                 const labelList&
162             );
165         // Evaluation functions
167             //- Update the coefficients associated with the patch field
168             virtual void updateCoeffs();
171         // I-O
173             //- Write
174             virtual void write(Ostream&) const;
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 } // End namespace Foam
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 #endif
186 // ************************************************************************* //