applications/solvers/coupled/conjugateHeatTransfer/fvPatchFields/externalRadiation/ersViewFactor/ersViewFactor.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::ersViewFactor
  26
  27 Description
  28     helper class to sum up external radiation sources
  29
  30
  31 SourceFiles
  32     ersViewFactor.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ersViewFactor_H
  37 #define ersViewFactor_H
  38
  39 #include "externalRadiationSource.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                   Class wallHeatTransferFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class ersViewFactor
  51 :
  52     public externalRadiationSource
  53 {
  54     // Private data
  55
  56         //- temperature at infinity
  57         scalar Tinf_;
  58
  59         //- view factor
  60         scalarField F_;
  61
  62         //- espison
  63         scalar epsilon_;
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("viewFactor");
  69
  70
  71     // Constructors
  72
  73         //- Construct from components
  74         explicit ersViewFactor
  75         (
  76             const word& name,
  77             const dictionary& dict,
  78             const fvPatch& p
  79         );
  80
  81
  82         //- Construct from components
  83         explicit ersViewFactor
  84         (
  85             const word& name,
  86             const dictionary& dict
  87         );
  88
  89
  90         //- Construct and return a clone
  91         virtual autoPtr<externalRadiationSource> clone() const
  92         {
  93             return autoPtr<externalRadiationSource>
  94             (
  95                 new ersViewFactor(*this)
  96             );
  97         }
  98
  99     // Destructor
 100
 101         virtual ~ersViewFactor()
 102         {};
 103
 104
 105     // Member functions
 106
 107         // Access
 108
 109         const scalarField& F() const
 110         {
 111             return F_;
 112         };
 113
 114         scalarField& F()
 115         {
 116             return F_;
 117         };
 118
 119         const scalar& epsilon() const
 120         {
 121             return epsilon_;
 122         };
 123
 124         scalar& epsilson()
 125         {
 126             return epsilon_;
 127         };
 128
 129
 130         // Mapping functions
 131
 132         // Evaluation functions
 133
 134             //- Return heat flux
 135             virtual tmp<scalarField> q(const scalarField& Tw) const;
 136
 137
 138         //- Write
 139         virtual void write(Ostream&) const;
 140 };
 141
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 } // End namespace Foam
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //