src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.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::totalTemperatureFvPatchScalarField
  26
  27 Description
  28     Foam::totalTemperatureFvPatchScalarField
  29
  30 SourceFiles
  31     totalTemperatureFvPatchScalarField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef totalTemperatureFvPatchScalarField_H
  36 #define totalTemperatureFvPatchScalarField_H
  37
  38 #include "fixedValueFvPatchFields.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class totalTemperatureFvPatch Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class totalTemperatureFvPatchScalarField
  50 :
  51     public fixedValueFvPatchScalarField
  52 {
  53     // Private data
  54
  55         //- Name of the velocity field
  56         word UName_;
  57
  58         //- Name of the flux transporting the field
  59         word phiName_;
  60
  61         //- Name of the compressibility field used to calculate the wave speed
  62         word psiName_;
  63
  64         //- Heat capacity ratio
  65         scalar gamma_;
  66
  67         //- Total pressure
  68         scalarField T0_;
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("totalTemperature");
  75
  76
  77     // Constructors
  78
  79         //- Construct from patch and internal field
  80         totalTemperatureFvPatchScalarField
  81         (
  82             const fvPatch&,
  83             const DimensionedField<scalar, volMesh>&
  84         );
  85
  86         //- Construct from patch, internal field and dictionary
  87         totalTemperatureFvPatchScalarField
  88         (
  89             const fvPatch&,
  90             const DimensionedField<scalar, volMesh>&,
  91             const dictionary&
  92         );
  93
  94         //- Construct by mapping given totalTemperatureFvPatchScalarField
  95         //  onto a new patch
  96         totalTemperatureFvPatchScalarField
  97         (
  98             const totalTemperatureFvPatchScalarField&,
  99             const fvPatch&,
 100             const DimensionedField<scalar, volMesh>&,
 101             const fvPatchFieldMapper&
 102         );
 103
 104         //- Construct as copy
 105         totalTemperatureFvPatchScalarField
 106         (
 107             const totalTemperatureFvPatchScalarField&
 108         );
 109
 110         //- Construct and return a clone
 111         virtual tmp<fvPatchScalarField> clone() const
 112         {
 113             return tmp<fvPatchScalarField>
 114             (
 115                 new totalTemperatureFvPatchScalarField(*this)
 116             );
 117         }
 118
 119         //- Construct as copy setting internal field reference
 120         totalTemperatureFvPatchScalarField
 121         (
 122             const totalTemperatureFvPatchScalarField&,
 123             const DimensionedField<scalar, volMesh>&
 124         );
 125
 126         //- Construct and return a clone setting internal field reference
 127         virtual tmp<fvPatchScalarField> clone
 128         (
 129             const DimensionedField<scalar, volMesh>& iF
 130         ) const
 131         {
 132             return tmp<fvPatchScalarField>
 133             (
 134                 new totalTemperatureFvPatchScalarField(*this, iF)
 135             );
 136         }
 137
 138
 139     // Member functions
 140
 141         // Access
 142
 143             //- Return the total pressure
 144             const scalarField& T0() const
 145             {
 146                 return T0_;
 147             }
 148
 149             //- Return reference to the total pressure to allow adjustment
 150             scalarField& T0()
 151             {
 152                 return T0_;
 153             }
 154
 155
 156         // Mapping functions
 157
 158             //- Map (and resize as needed) from self given a mapping object
 159             virtual void autoMap
 160             (
 161                 const fvPatchFieldMapper&
 162             );
 163
 164             //- Reverse map the given fvPatchField onto this fvPatchField
 165             virtual void rmap
 166             (
 167                 const fvPatchScalarField&,
 168                 const labelList&
 169             );
 170
 171
 172         // Evaluation functions
 173
 174             //- Update the coefficients associated with the patch field
 175             virtual void updateCoeffs();
 176
 177
 178         //- Write
 179         virtual void write(Ostream&) const;
 180 };
 181
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 } // End namespace Foam
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 #endif
 190
 191 // ************************************************************************* //