applications/solvers/coupled/conjugateHeatFoam/conjugateHeatTransfer/fvPatchFields/externalRadiation/externalRadiationSource/externalRadiationSource.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   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::externalRadiationSource
  26
  27 Description
  28     Virtual base class for external radiation sources
  29
  30
  31 SourceFiles
  32     externalRadiationSource.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef externalRadiationSource_H
  37 #define externalRadiationSource_H
  38
  39 #include "scalarField.H"
  40 #include "tmp.H"
  41 #include "fvPatch.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                   Class wallHeatTransferFvPatch Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class externalRadiationSource
  53 {
  54     // Private data
  55
  56         //- name
  57         word name_;
  58
  59
  60 public:
  61
  62     //- Runtime type information
  63     TypeName("externalRadiationSource");
  64
  65     // Declare run-time constructor selection table
  66
  67         declareRunTimeSelectionTable
  68         (
  69             autoPtr,
  70             externalRadiationSource,
  71             dictionary,
  72             (
  73                 const word& name,
  74                 const dictionary& dict,
  75                 const fvPatch& p
  76             ),
  77             (name, dict, p)
  78         );
  79
  80
  81     // Destructor
  82
  83         virtual ~externalRadiationSource()
  84         {};
  85
  86     // Selectors
  87
  88         //- Return a reference to the selected thermal model
  89         static autoPtr<externalRadiationSource> New
  90         (
  91             const word& name,
  92             const dictionary& dict,
  93             const fvPatch& p
  94         );
  95
  96
  97         //- Construct and return a clone
  98         virtual autoPtr<externalRadiationSource> clone() const
  99         {
 100             notImplemented("autoPt<externalRadiationSource> clone() const");
 101             return autoPtr<externalRadiationSource>(NULL);
 102
 103             return autoPtr<externalRadiationSource>
 104             (
 105                 new externalRadiationSource(*this)
 106             );
 107         };
 108
 109     // Constructors
 110
 111         //- Construct from components
 112         explicit externalRadiationSource
 113         (
 114             const word& name
 115         );
 116
 117
 118     // Member functions
 119
 120         // Access
 121
 122         const word& name() const
 123         {
 124             return name_;
 125         }
 126
 127         // Mapping functions
 128
 129         // Evaluation functions
 130
 131             //- Return heat flux
 132             virtual tmp<scalarField> q(const scalarField& Tw) const
 133             {
 134                 notImplemented
 135                 (
 136                     type() +"::q(const scalarField& Tw) const"
 137                 );
 138
 139                 return tmp<scalarField>(NULL);
 140             };
 141
 142
 143         //- Write
 144
 145             virtual void write(Ostream&) const;
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //