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