src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationMixedFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::MarshakRadiationFvPatchScalarField
  27
  28 Description
  29     Marshak boundary for radiation G field
  30     - radiation temperature taken from patch value
  31
  32 SourceFiles
  33     MarshakRadiationFvPatchScalarField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef MarshakRadiationMixedFvPatchField_H
  38 #define MarshakRadiationMixedFvPatchField_H
  39
  40 #include "mixedFvPatchFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48              Class MarshakRadiationFvPatchScalarField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class MarshakRadiationFvPatchScalarField
  52 :
  53     public mixedFvPatchScalarField
  54 {
  55
  56     // Private data
  57
  58         //- Name of temperature field
  59         word TName_;
  60
  61         //- Emissivity
  62         scalar emissivity_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("MarshakRadiation");
  69
  70
  71     // Constructors
  72
  73         //- Construct from patch and internal field
  74         MarshakRadiationFvPatchScalarField
  75         (
  76             const fvPatch&,
  77             const DimensionedField<scalar, volMesh>&
  78         );
  79
  80         //- Construct from patch, internal field and dictionary
  81         MarshakRadiationFvPatchScalarField
  82         (
  83             const fvPatch&,
  84             const DimensionedField<scalar, volMesh>&,
  85             const dictionary&
  86         );
  87
  88         //- Construct by mapping given MarshakRadiationFvPatchField onto a new
  89         //  patch
  90         MarshakRadiationFvPatchScalarField
  91         (
  92             const MarshakRadiationFvPatchScalarField&,
  93             const fvPatch&,
  94             const DimensionedField<scalar, volMesh>&,
  95             const fvPatchFieldMapper&
  96         );
  97
  98         //- Construct as copy
  99         MarshakRadiationFvPatchScalarField
 100         (
 101             const MarshakRadiationFvPatchScalarField&
 102         );
 103
 104         //- Construct and return a clone
 105         virtual tmp<fvPatchScalarField> clone() const
 106         {
 107             return tmp<fvPatchScalarField>
 108             (
 109                 new MarshakRadiationFvPatchScalarField(*this)
 110             );
 111         }
 112
 113         //- Construct as copy setting internal field reference
 114         MarshakRadiationFvPatchScalarField
 115         (
 116             const MarshakRadiationFvPatchScalarField&,
 117             const DimensionedField<scalar, volMesh>&
 118         );
 119
 120         //- Construct and return a clone setting internal field reference
 121         virtual tmp<fvPatchScalarField> clone
 122         (
 123             const DimensionedField<scalar, volMesh>& iF
 124         ) const
 125         {
 126             return tmp<fvPatchScalarField>
 127             (
 128                 new MarshakRadiationFvPatchScalarField(*this, iF)
 129             );
 130         }
 131
 132
 133     // Member functions
 134
 135         // Access
 136
 137             //- Return the temperature field name
 138             const word& TName() const
 139             {
 140                 return TName_;
 141             }
 142
 143             //- Return reference to the temperature field name to allow
 144             //  adjustment
 145             word& TName()
 146             {
 147                 return TName_;
 148             }
 149
 150             //- Return the emissivity
 151             const scalar& emissivity() const
 152             {
 153                 return emissivity_;
 154             }
 155
 156             //- Return reference to the emissivity to allow adjustment
 157             scalar& emissivity()
 158             {
 159                 return emissivity_;
 160             }
 161
 162
 163         // Mapping functions
 164
 165             //- Map (and resize as needed) from self given a mapping object
 166             virtual void autoMap
 167             (
 168                 const fvPatchFieldMapper&
 169             );
 170
 171             //- Reverse map the given fvPatchField onto this fvPatchField
 172             virtual void rmap
 173             (
 174                 const fvPatchScalarField&,
 175                 const labelList&
 176             );
 177
 178
 179         // Evaluation functions
 180
 181             //- Update the coefficients associated with the patch field
 182             virtual void updateCoeffs();
 183
 184
 185         // I-O
 186
 187             //- Write
 188             virtual void write(Ostream&) const;
 189 };
 190
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 } // End namespace Foam
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 #endif
 199
 200 // ************************************************************************* //