src/finiteVolume/fields/fvPatchFields/derived/timeVaryingUniformTotalPressure/timeVaryingUniformTotalPressureFvPatchScalarField.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::timeVaryingUniformTotalPressureFvPatchScalarField
  27
  28 Description
  29     A time-varying form of a uniform total pressure boundary condition.
  30
  31 See Also
  32     Foam::timeVaryingUniformFixedValueFvPatchField
  33     and Foam::totalPressureFvPatchScalarField.H
  34
  35 SourceFiles
  36     timeVaryingUniformTotalPressureFvPatchScalarField.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef timeVaryingUniformTotalPressureFvPatchScalarField_H
  41 #define timeVaryingUniformTotalPressureFvPatchScalarField_H
  42
  43 #include "fixedValueFvPatchFields.H"
  44 #include "interpolationTable.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                Class timeVaryingTotalPressureFvPatch Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class timeVaryingUniformTotalPressureFvPatchScalarField
  56 :
  57     public fixedValueFvPatchScalarField
  58 {
  59     // Private data
  60
  61         //- Name of the velocity field
  62         word UName_;
  63
  64         //- Name of the flux transporting the field
  65         word phiName_;
  66
  67         //- Name of the density field used to normalise the mass flux
  68         //  if neccessary
  69         word rhoName_;
  70
  71         //- Name of the compressibility field used to calculate the wave speed
  72         word psiName_;
  73
  74         //- Heat capacity ratio
  75         scalar gamma_;
  76
  77         //- Total pressure
  78         scalar p0_;
  79
  80         //- Table of time vs total pressure, including the bounding treatment
  81         interpolationTable<scalar> timeSeries_;
  82
  83
  84 public:
  85
  86     //- Runtime type information
  87     TypeName("timeVaryingTotalPressure");
  88
  89
  90     // Constructors
  91
  92         //- Construct from patch and internal field
  93         timeVaryingUniformTotalPressureFvPatchScalarField
  94         (
  95             const fvPatch&,
  96             const DimensionedField<scalar, volMesh>&
  97         );
  98
  99         //- Construct from patch, internal field and dictionary
 100         timeVaryingUniformTotalPressureFvPatchScalarField
 101         (
 102             const fvPatch&,
 103             const DimensionedField<scalar, volMesh>&,
 104             const dictionary&
 105         );
 106
 107         //- Construct by mapping given patch field onto a new patch
 108         timeVaryingUniformTotalPressureFvPatchScalarField
 109         (
 110             const timeVaryingUniformTotalPressureFvPatchScalarField&,
 111             const fvPatch&,
 112             const DimensionedField<scalar, volMesh>&,
 113             const fvPatchFieldMapper&
 114         );
 115
 116         //- Construct as copy
 117         timeVaryingUniformTotalPressureFvPatchScalarField
 118         (
 119             const timeVaryingUniformTotalPressureFvPatchScalarField&
 120         );
 121
 122         //- Construct and return a clone
 123         virtual tmp<fvPatchScalarField> clone() const
 124         {
 125             return tmp<fvPatchScalarField>
 126             (
 127                 new timeVaryingUniformTotalPressureFvPatchScalarField(*this)
 128             );
 129         }
 130
 131         //- Construct as copy setting internal field reference
 132         timeVaryingUniformTotalPressureFvPatchScalarField
 133         (
 134             const timeVaryingUniformTotalPressureFvPatchScalarField&,
 135             const DimensionedField<scalar, volMesh>&
 136         );
 137
 138         //- Construct and return a clone setting internal field reference
 139         virtual tmp<fvPatchScalarField> clone
 140         (
 141             const DimensionedField<scalar, volMesh>& iF
 142         ) const
 143         {
 144             return tmp<fvPatchScalarField>
 145             (
 146                 new timeVaryingUniformTotalPressureFvPatchScalarField(*this, iF)
 147             );
 148         }
 149
 150
 151     // Member functions
 152
 153         // Access
 154
 155             //- Return the name of the velocity field
 156             const word& UName() const
 157             {
 158                 return UName_;
 159             }
 160
 161             //- Return reference to the name of the velocity field
 162             //  to allow adjustment
 163             word& UName()
 164             {
 165                 return UName_;
 166             }
 167
 168             //- Return the heat capacity ratio
 169             scalar gamma() const
 170             {
 171                 return gamma_;
 172             }
 173
 174             //- Return reference to the heat capacity ratio to allow adjustment
 175             scalar& gamma()
 176             {
 177                 return gamma_;
 178             }
 179
 180             //- Return the total pressure
 181             scalar p0() const
 182             {
 183                 return p0_;
 184             }
 185
 186             //- Return reference to the total pressure to allow adjustment
 187             scalar p0()
 188             {
 189                 return p0_;
 190             }
 191
 192             //- Return the time series used
 193             const interpolationTable<scalar>& totalPressureTimeSeries() const
 194             {
 195                 return timeSeries_;
 196             }
 197
 198
 199         // Evaluation functions
 200
 201             //- Update the coefficients associated with the patch field
 202             //  using the given patch velocity field
 203             virtual void updateCoeffs(const vectorField& Up);
 204
 205             //- Update the coefficients associated with the patch field
 206             virtual void updateCoeffs();
 207
 208
 209         //- Write
 210         virtual void write(Ostream&) const;
 211 };
 212
 213
 214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 215
 216 } // End namespace Foam
 217
 218 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 219
 220 #endif
 221
 222 // ************************************************************************* //