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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::MarshakRadiationFvPatchScalarField
  26
  27 Description
  28     Marshak boundary for radiation G field
  29     - radiation temperature taken from patch value
  30
  31 SourceFiles
  32     MarshakRadiationFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef MarshakRadiationMixedFvPatchField_H
  37 #define MarshakRadiationMixedFvPatchField_H
  38
  39 #include "mixedFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47              Class MarshakRadiationFvPatchScalarField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class MarshakRadiationFvPatchScalarField
  51 :
  52     public mixedFvPatchScalarField
  53 {
  54
  55     // Private data
  56
  57         //- Name of temperature field
  58         word TName_;
  59
  60         //- Emissivity
  61         scalar emissivity_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("MarshakRadiation");
  68
  69
  70     // Constructors
  71
  72         //- Construct from patch and internal field
  73         MarshakRadiationFvPatchScalarField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<scalar, volMesh>&
  77         );
  78
  79         //- Construct from patch, internal field and dictionary
  80         MarshakRadiationFvPatchScalarField
  81         (
  82             const fvPatch&,
  83             const DimensionedField<scalar, volMesh>&,
  84             const dictionary&
  85         );
  86
  87         //- Construct by mapping given MarshakRadiationFvPatchField onto a new
  88         //  patch
  89         MarshakRadiationFvPatchScalarField
  90         (
  91             const MarshakRadiationFvPatchScalarField&,
  92             const fvPatch&,
  93             const DimensionedField<scalar, volMesh>&,
  94             const fvPatchFieldMapper&
  95         );
  96
  97         //- Construct as copy
  98         MarshakRadiationFvPatchScalarField
  99         (
 100             const MarshakRadiationFvPatchScalarField&
 101         );
 102
 103         //- Construct and return a clone
 104         virtual tmp<fvPatchScalarField> clone() const
 105         {
 106             return tmp<fvPatchScalarField>
 107             (
 108                 new MarshakRadiationFvPatchScalarField(*this)
 109             );
 110         }
 111
 112         //- Construct as copy setting internal field reference
 113         MarshakRadiationFvPatchScalarField
 114         (
 115             const MarshakRadiationFvPatchScalarField&,
 116             const DimensionedField<scalar, volMesh>&
 117         );
 118
 119         //- Construct and return a clone setting internal field reference
 120         virtual tmp<fvPatchScalarField> clone
 121         (
 122             const DimensionedField<scalar, volMesh>& iF
 123         ) const
 124         {
 125             return tmp<fvPatchScalarField>
 126             (
 127                 new MarshakRadiationFvPatchScalarField(*this, iF)
 128             );
 129         }
 130
 131
 132     // Member functions
 133
 134         // Access
 135
 136             //- Return the temperature field name
 137             const word& TName() const
 138             {
 139                 return TName_;
 140             }
 141
 142             //- Return reference to the temperature field name to allow
 143             //  adjustment
 144             word& TName()
 145             {
 146                 return TName_;
 147             }
 148
 149             //- Return the emissivity
 150             const scalar& emissivity() const
 151             {
 152                 return emissivity_;
 153             }
 154
 155             //- Return reference to the emissivity to allow adjustment
 156             scalar& emissivity()
 157             {
 158                 return emissivity_;
 159             }
 160
 161
 162         // Mapping functions
 163
 164             //- Map (and resize as needed) from self given a mapping object
 165             virtual void autoMap
 166             (
 167                 const fvPatchFieldMapper&
 168             );
 169
 170             //- Reverse map the given fvPatchField onto this fvPatchField
 171             virtual void rmap
 172             (
 173                 const fvPatchScalarField&,
 174                 const labelList&
 175             );
 176
 177
 178         // Evaluation functions
 179
 180             //- Update the coefficients associated with the patch field
 181             virtual void updateCoeffs();
 182
 183
 184         // I-O
 185
 186             //- Write
 187             virtual void write(Ostream&) const;
 188 };
 189
 190
 191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 192
 193 } // End namespace Foam
 194
 195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 196
 197 #endif
 198
 199 // ************************************************************************* //