src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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::turbulentHeatFluxTemperatureFvPatchScalarField
  26
  27 Description
  28     Fixed heat boundary condition to specify temperature gradient. Input
  29     heat source either specified in terms of an absolute power [W], or as a
  30     flux [W/m2].
  31
  32     Example usage:
  33
  34         hotWall
  35         {
  36             type            compressible::turbulentHeatFluxTemperature;
  37             heatSource      flux;        // power [W]; flux [W/m2]
  38             q               uniform 10;  // heat power or flux
  39             K               basicThermo; // calculate K by alphaEff*thermo.Cp
  40             value           uniform 300; // initial temperature value
  41         }
  42
  43
  44 SourceFiles
  45     turbulentHeatFluxTemperatureFvPatchScalarField.C
  46
  47 \*---------------------------------------------------------------------------*/
  48
  49 #ifndef turbulentHeatFluxTemperatureFvPatchScalarFields_H
  50 #define turbulentHeatFluxTemperatureFvPatchScalarFields_H
  51
  52 #include "fixedGradientFvPatchFields.H"
  53 #include "temperatureCoupledBase.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59 namespace compressible
  60 {
  61
  62 /*---------------------------------------------------------------------------*\
  63       Class turbulentHeatFluxTemperatureFvPatchScalarField Declaration
  64 \*---------------------------------------------------------------------------*/
  65
  66 class turbulentHeatFluxTemperatureFvPatchScalarField
  67 :
  68     public fixedGradientFvPatchScalarField,
  69     public temperatureCoupledBase
  70 {
  71 public:
  72
  73     // Data types
  74
  75         //- Enumeration listing the possible hest source input modes
  76         enum heatSourceType
  77         {
  78             hsPower,
  79             hsFlux
  80         };
  81
  82
  83 private:
  84
  85     // Private data
  86
  87         //- Heat source type names
  88         static const NamedEnum<heatSourceType, 2> heatSourceTypeNames_;
  89
  90         //- Heat source type
  91         heatSourceType heatSource_;
  92
  93         //- Heat power [W] or flux [W/m2]
  94         scalarField q_;
  95
  96
  97 public:
  98
  99     //- Runtime type information
 100     TypeName("compressible::turbulentHeatFluxTemperature");
 101
 102
 103     // Constructors
 104
 105         //- Construct from patch and internal field
 106         turbulentHeatFluxTemperatureFvPatchScalarField
 107         (
 108             const fvPatch&,
 109             const DimensionedField<scalar, volMesh>&
 110         );
 111
 112         //- Construct from patch, internal field and dictionary
 113         turbulentHeatFluxTemperatureFvPatchScalarField
 114         (
 115             const fvPatch&,
 116             const DimensionedField<scalar, volMesh>&,
 117             const dictionary&
 118         );
 119
 120         //- Construct by mapping given
 121         //  turbulentHeatFluxTemperatureFvPatchScalarField onto
 122         //  a new patch
 123         turbulentHeatFluxTemperatureFvPatchScalarField
 124         (
 125             const turbulentHeatFluxTemperatureFvPatchScalarField&,
 126             const fvPatch&,
 127             const DimensionedField<scalar, volMesh>&,
 128             const fvPatchFieldMapper&
 129         );
 130
 131         //- Construct as copy
 132         turbulentHeatFluxTemperatureFvPatchScalarField
 133         (
 134             const turbulentHeatFluxTemperatureFvPatchScalarField&
 135         );
 136
 137         //- Construct and return a clone
 138         virtual tmp<fvPatchScalarField> clone() const
 139         {
 140             return tmp<fvPatchScalarField>
 141             (
 142                 new turbulentHeatFluxTemperatureFvPatchScalarField(*this)
 143             );
 144         }
 145
 146         //- Construct as copy setting internal field reference
 147         turbulentHeatFluxTemperatureFvPatchScalarField
 148         (
 149             const turbulentHeatFluxTemperatureFvPatchScalarField&,
 150             const DimensionedField<scalar, volMesh>&
 151         );
 152
 153         //- Construct and return a clone setting internal field reference
 154         virtual tmp<fvPatchScalarField> clone
 155         (
 156             const DimensionedField<scalar, volMesh>& iF
 157         ) const
 158         {
 159             return tmp<fvPatchScalarField>
 160             (
 161                 new turbulentHeatFluxTemperatureFvPatchScalarField
 162                 (
 163                     *this,
 164                     iF
 165                 )
 166             );
 167         }
 168
 169
 170     // Member functions
 171
 172         // Mapping functions
 173
 174             //- Map (and resize as needed) from self given a mapping object
 175             virtual void autoMap(const fvPatchFieldMapper&);
 176
 177             //- Reverse map the given fvPatchField onto this fvPatchField
 178             virtual void rmap
 179             (
 180                 const fvPatchScalarField&,
 181                 const labelList&
 182             );
 183
 184
 185         // Evaluation functions
 186
 187             //- Update the coefficients associated with the patch field
 188             virtual void updateCoeffs();
 189
 190
 191         // I-O
 192
 193             //- Write
 194             virtual void write(Ostream&) const;
 195 };
 196
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 } // End namespace compressible
 201 } // End namespace Foam
 202
 203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 204
 205 #endif
 206
 207 // ************************************************************************* //