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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2011 OpenCFD Ltd.
   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::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 #include "radiationCoupledBase.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48              Class MarshakRadiationFvPatchScalarField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class MarshakRadiationFvPatchScalarField
  52 :
  53     public mixedFvPatchScalarField,
  54     public radiationCoupledBase
  55 {
  56
  57     // Private data
  58
  59         //- Name of temperature field
  60         word TName_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("MarshakRadiation");
  67
  68
  69     // Constructors
  70
  71         //- Construct from patch and internal field
  72         MarshakRadiationFvPatchScalarField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<scalar, volMesh>&
  76         );
  77
  78         //- Construct from patch, internal field and dictionary
  79         MarshakRadiationFvPatchScalarField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<scalar, volMesh>&,
  83             const dictionary&
  84         );
  85
  86         //- Construct by mapping given MarshakRadiationFvPatchField onto a new
  87         //  patch
  88         MarshakRadiationFvPatchScalarField
  89         (
  90             const MarshakRadiationFvPatchScalarField&,
  91             const fvPatch&,
  92             const DimensionedField<scalar, volMesh>&,
  93             const fvPatchFieldMapper&
  94         );
  95
  96         //- Construct as copy
  97         MarshakRadiationFvPatchScalarField
  98         (
  99             const MarshakRadiationFvPatchScalarField&
 100         );
 101
 102         //- Construct and return a clone
 103         virtual tmp<fvPatchScalarField> clone() const
 104         {
 105             return tmp<fvPatchScalarField>
 106             (
 107                 new MarshakRadiationFvPatchScalarField(*this)
 108             );
 109         }
 110
 111         //- Construct as copy setting internal field reference
 112         MarshakRadiationFvPatchScalarField
 113         (
 114             const MarshakRadiationFvPatchScalarField&,
 115             const DimensionedField<scalar, volMesh>&
 116         );
 117
 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 MarshakRadiationFvPatchScalarField(*this, iF)
 127             );
 128         }
 129
 130
 131     // Member functions
 132
 133         // Access
 134
 135             //- Return the temperature field name
 136             const word& TName() const
 137             {
 138                 return TName_;
 139             }
 140
 141             //- Return reference to the temperature field name to allow
 142             //  adjustment
 143             word& TName()
 144             {
 145                 return TName_;
 146             }
 147
 148
 149         // Mapping functions
 150
 151             //- Map (and resize as needed) from self given a mapping object
 152             virtual void autoMap
 153             (
 154                 const fvPatchFieldMapper&
 155             );
 156
 157             //- Reverse map the given fvPatchField onto this fvPatchField
 158             virtual void rmap
 159             (
 160                 const fvPatchScalarField&,
 161                 const labelList&
 162             );
 163
 164
 165         // Evaluation functions
 166
 167             //- Update the coefficients associated with the patch field
 168             virtual void updateCoeffs();
 169
 170
 171         // I-O
 172
 173             //- Write
 174             virtual void write(Ostream&) const;
 175 };
 176
 177
 178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 179
 180 } // End namespace Foam
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 #endif
 185
 186 // ************************************************************************* //