src/thermophysicalModels/basic/derivedFvPatchFields/isentropicTotalPressure/isentropicTotalPressureFvPatchScalarField.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::isentropicTotalPressureFvPatchScalarField
  26
  27 Description
  28     Isentropic total pressure boundary condition.  The snGrad is set to
  29     zero to stop back-diffusion
  30
  31 SourceFiles
  32     isentropicTotalPressureFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef isentropicTotalPressureFvPatchScalarField_H
  37 #define isentropicTotalPressureFvPatchScalarField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47            Class isentropicTotalPressureFvPatchScalarField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class isentropicTotalPressureFvPatchScalarField
  51 :
  52     public fixedValueFvPatchScalarField
  53 {
  54     // Private data
  55
  56         //- Name of the velocity field
  57         word UName_;
  58
  59         //- Name of the static temperature field
  60         word TName_;
  61
  62         //- Total pressure field
  63         scalarField p0_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("isentropicTotalPressure");
  70
  71
  72     // Constructors
  73
  74         //- Construct from patch and internal field
  75         isentropicTotalPressureFvPatchScalarField
  76         (
  77             const fvPatch&,
  78             const DimensionedField<scalar, volMesh>&
  79         );
  80
  81         //- Construct from patch, internal field and dictionary
  82         isentropicTotalPressureFvPatchScalarField
  83         (
  84             const fvPatch&,
  85             const DimensionedField<scalar, volMesh>&,
  86             const dictionary&
  87         );
  88
  89         //- Construct by mapping given
  90         //  isentropicTotalPressureFvPatchScalarField onto a new patch
  91         isentropicTotalPressureFvPatchScalarField
  92         (
  93             const isentropicTotalPressureFvPatchScalarField&,
  94             const fvPatch&,
  95             const DimensionedField<scalar, volMesh>&,
  96             const fvPatchFieldMapper&
  97         );
  98
  99         //- Construct as copy
 100         isentropicTotalPressureFvPatchScalarField
 101         (
 102             const isentropicTotalPressureFvPatchScalarField&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvPatchScalarField> clone() const
 107         {
 108             return tmp<fvPatchScalarField>
 109             (
 110                 new isentropicTotalPressureFvPatchScalarField(*this)
 111             );
 112         }
 113
 114         //- Construct as copy setting internal field reference
 115         isentropicTotalPressureFvPatchScalarField
 116         (
 117             const isentropicTotalPressureFvPatchScalarField&,
 118             const DimensionedField<scalar, volMesh>&
 119         );
 120
 121         //- Construct and return a clone setting internal field reference
 122         virtual tmp<fvPatchScalarField> clone
 123         (
 124             const DimensionedField<scalar, volMesh>& iF
 125         ) const
 126         {
 127             return tmp<fvPatchScalarField>
 128             (
 129                 new isentropicTotalPressureFvPatchScalarField(*this, iF)
 130             );
 131         }
 132
 133
 134     // Member functions
 135
 136         // Access
 137
 138             //- Return the name of the velocity field
 139             const word& UName() const
 140             {
 141                 return UName_;
 142             }
 143
 144             //- Return reference to the name of the velocity field
 145             //  to allow adjustment
 146             word& UName()
 147             {
 148                 return UName_;
 149             }
 150
 151             //- Return the total pressure
 152             const scalarField& p0() const
 153             {
 154                 return p0_;
 155             }
 156
 157             //- Return reference to the total pressure to allow adjustment
 158             scalarField& p0()
 159             {
 160                 return p0_;
 161             }
 162
 163
 164         // Mapping functions
 165
 166             //- Map (and resize as needed) from self given a mapping object
 167             virtual void autoMap
 168             (
 169                 const fvPatchFieldMapper&
 170             );
 171
 172             //- Reverse map the given fvPatchField onto this fvPatchField
 173             virtual void rmap
 174             (
 175                 const fvPatchScalarField&,
 176                 const labelList&
 177             );
 178
 179
 180         // Evaluation functions
 181
 182             //- Update the coefficients associated with the patch field
 183             //  using the given patch velocity field
 184             virtual void updateCoeffs(const vectorField& Up);
 185
 186             //- Update the coefficients associated with the patch field
 187             virtual void updateCoeffs();
 188
 189             //- Return patch-normal gradient: set to zero
 190             virtual tmp<scalarField> snGrad() const;
 191
 192             //- Return the matrix diagonal coefficients corresponding to the
 193             //  evaluation of the gradient of this patchField
 194             //  Removed gradient contribution
 195             virtual tmp<scalarField> gradientInternalCoeffs() const;
 196
 197             //- Return the matrix source coefficients corresponding to the
 198             //  evaluation of the gradient of this patchField
 199             virtual tmp<scalarField> gradientBoundaryCoeffs() const;
 200
 201
 202         //- Write
 203         virtual void write(Ostream&) const;
 204 };
 205
 206
 207 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 208
 209 } // End namespace Foam
 210
 211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 212
 213 #endif
 214
 215 // ************************************************************************* //