src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H

   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.
  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::greyDiffusiveRadiationMixedFvPatchScalarField
  26
  27 Description
  28     Radiation temperature specified
  29
  30 SourceFiles
  31     greyDiffusiveRadiationMixedFvPatchScalarField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef greyDiffusiveRadiationMixedFvPatchScalarField_H
  36 #define greyDiffusiveRadiationMixedFvPatchScalarField_H
  37
  38 #include "mixedFvPatchFields.H"
  39 #include "radiationCoupledBase.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace radiation
  46 {
  47 /*---------------------------------------------------------------------------*\
  48         Class greyDiffusiveRadiationMixedFvPatchScalarField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class greyDiffusiveRadiationMixedFvPatchScalarField
  52 :
  53     public mixedFvPatchScalarField,
  54     public radiationCoupledBase
  55 {
  56     // Private data
  57
  58         //- Name of temperature field
  59         word TName_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("greyDiffusiveRadiation");
  66
  67
  68     // Constructors
  69
  70         //- Construct from patch and internal field
  71         greyDiffusiveRadiationMixedFvPatchScalarField
  72         (
  73             const fvPatch&,
  74             const DimensionedField<scalar, volMesh>&
  75         );
  76
  77         //- Construct from patch, internal field and dictionary
  78         greyDiffusiveRadiationMixedFvPatchScalarField
  79         (
  80             const fvPatch&,
  81             const DimensionedField<scalar, volMesh>&,
  82             const dictionary&
  83         );
  84
  85         //- Construct by mapping given a
  86         //  greyDiffusiveRadiationMixedFvPatchScalarField onto a new patch
  87         greyDiffusiveRadiationMixedFvPatchScalarField
  88         (
  89             const greyDiffusiveRadiationMixedFvPatchScalarField&,
  90             const fvPatch&,
  91             const DimensionedField<scalar, volMesh>&,
  92             const fvPatchFieldMapper&
  93         );
  94
  95         //- Construct as copy
  96         greyDiffusiveRadiationMixedFvPatchScalarField
  97         (
  98             const greyDiffusiveRadiationMixedFvPatchScalarField&
  99         );
 100
 101         //- Construct and return a clone
 102         virtual tmp<fvPatchScalarField> clone() const
 103         {
 104             return tmp<fvPatchScalarField>
 105             (
 106                 new greyDiffusiveRadiationMixedFvPatchScalarField(*this)
 107             );
 108         }
 109
 110         //- Construct as copy setting internal field reference
 111         greyDiffusiveRadiationMixedFvPatchScalarField
 112         (
 113             const greyDiffusiveRadiationMixedFvPatchScalarField&,
 114             const DimensionedField<scalar, volMesh>&
 115         );
 116
 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 greyDiffusiveRadiationMixedFvPatchScalarField(*this, iF)
 126             );
 127         }
 128
 129
 130     // Member functions
 131
 132         // Access
 133
 134             //- Return the temperature field name
 135             const word& TName() const
 136             {
 137                 return TName_;
 138             }
 139
 140             //- Return reference to the temperature field name to allow
 141             //  adjustment
 142             word& TName()
 143             {
 144                 return TName_;
 145             }
 146
 147
 148         // Evaluation functions
 149
 150             //- Update the coefficients associated with the patch field
 151             virtual void updateCoeffs();
 152
 153
 154         // I-O
 155
 156             //- Write
 157             virtual void write(Ostream&) const;
 158 };
 159
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 } // End namespace Foam
 164 }
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //