src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.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::waveTransmissiveFvPatchField
  27
  28 Description
  29     Foam::waveTransmissiveFvPatchField
  30
  31 SourceFiles
  32     waveTransmissiveFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef waveTransmissiveFvPatchField_H
  37 #define waveTransmissiveFvPatchField_H
  38
  39 #include "advectiveFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                    Class waveTransmissiveFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class waveTransmissiveFvPatchField
  52 :
  53     public advectiveFvPatchField<Type>
  54 {
  55
  56     // Private data
  57
  58         //- Name of the compressibility field used to calculate the wave speed
  59         word psiName_;
  60
  61         //- Name of velocity field used to calculate supercritical condition
  62         word UName_;
  63
  64         //- Heat capacity ratio
  65         scalar gamma_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("waveTransmissive");
  72
  73
  74     // Constructors
  75
  76         //- Construct from patch and internal field
  77         waveTransmissiveFvPatchField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<Type, volMesh>&
  81         );
  82
  83         //- Construct from patch, internal field and dictionary
  84         waveTransmissiveFvPatchField
  85         (
  86             const fvPatch&,
  87             const DimensionedField<Type, volMesh>&,
  88             const dictionary&
  89         );
  90
  91         //- Construct by mapping given waveTransmissiveFvPatchField
  92         //  onto a new patch
  93         waveTransmissiveFvPatchField
  94         (
  95             const waveTransmissiveFvPatchField<Type>&,
  96             const fvPatch&,
  97             const DimensionedField<Type, volMesh>&,
  98             const fvPatchFieldMapper&
  99         );
 100
 101         //- Construct as copy
 102         waveTransmissiveFvPatchField
 103         (
 104             const waveTransmissiveFvPatchField&
 105         );
 106
 107         //- Construct and return a clone
 108         virtual tmp<fvPatchField<Type> > clone() const
 109         {
 110             return tmp<fvPatchField<Type> >
 111             (
 112                 new waveTransmissiveFvPatchField<Type>(*this)
 113             );
 114         }
 115
 116         //- Construct as copy setting internal field reference
 117         waveTransmissiveFvPatchField
 118         (
 119             const waveTransmissiveFvPatchField&,
 120             const DimensionedField<Type, volMesh>&
 121         );
 122
 123         //- Construct and return a clone setting internal field reference
 124         virtual tmp<fvPatchField<Type> > clone
 125         (
 126             const DimensionedField<Type, volMesh>& iF
 127         ) const
 128         {
 129             return tmp<fvPatchField<Type> >
 130             (
 131                 new waveTransmissiveFvPatchField<Type>(*this, iF)
 132             );
 133         }
 134
 135
 136     // Member functions
 137
 138         // Access
 139
 140             //- Return the heat capacity ratio
 141             scalar gamma() const
 142             {
 143                 return gamma_;
 144             }
 145
 146             //- Return reference to the heat capacity ratio to allow adjustment
 147             scalar& gamma()
 148             {
 149                 return gamma_;
 150             }
 151
 152
 153         // Evaluation functions
 154
 155             //- Calculate and return the advection speed at the boundary
 156             virtual tmp<scalarField> advectionSpeed() const;
 157
 158             //- Calculate and return the supercritical switch at the boundary
 159             //  Supercritical = 1 converts the outlet to zeroGradient
 160             //  Supercritical = 0 no correction
 161             virtual tmp<scalarField> supercritical() const;
 162
 163
 164         //- Write
 165         virtual void write(Ostream&) const;
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "waveTransmissiveFvPatchField.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //