src/finiteVolume/fields/fvPatchFields/derived/timeVaryingFlowRateInletVelocity/timeVaryingFlowRateInletVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2006-2011 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::timeVaryingFlowRateInletVelocityFvPatchVectorField
  26
  27 Description
  28     A time-varying form of a flow normal vector boundary condition. The
  29     variation is specified as an interpolationTable (see
  30     Foam::interpolationTable).
  31
  32     Example of the boundary condition specification:
  33     \verbatim
  34     inlet
  35     {
  36         type            timeVaryingFlowRateInletVelocity;
  37         flowRate        0.2;         // Volumetric/mass flow rate [m3/s or kg/s]
  38         value           uniform (0 0 0);  // placeholder
  39         fileName        "$FOAM_CASE/time-series";
  40         outOfBounds     repeat;           // (error|warn|clamp|repeat)
  41     }
  42     \endverbatim
  43
  44 Note
  45     - The value is positive inwards
  46     - may not work correctly for transonic inlets!
  47     - strange behaviour with potentialFoam since the U equation is not solved
  48
  49 See Also
  50     Foam::interpolationTable and Foam::flowRateInletVelocityFvPatchVectorField
  51
  52 SourceFiles
  53     timeVaryingFlowRateInletVelocityFvPatchVectorField.C
  54
  55 \*---------------------------------------------------------------------------*/
  56
  57 #ifndef timeVaryingFlowRateInletVelocityFvPatchVectorField_H
  58 #define timeVaryingFlowRateInletVelocityFvPatchVectorField_H
  59
  60 #include "flowRateInletVelocityFvPatchVectorField.H"
  61 #include "interpolationTable.H"
  62
  63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  64
  65 namespace Foam
  66 {
  67 /*---------------------------------------------------------------------------*\
  68         Class timeVaryingFlowRateInletVelocityFvPatch Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class timeVaryingFlowRateInletVelocityFvPatchVectorField
  72 :
  73     public flowRateInletVelocityFvPatchVectorField
  74 {
  75     // Private data
  76
  77         //- the time series being used, including the bounding treatment
  78         interpolationTable<scalar> timeSeries_;
  79
  80
  81 public:
  82
  83     //- Runtime type information
  84     TypeName("timeVaryingFlowRateInletVelocity");
  85
  86
  87     // Constructors
  88
  89         //- Construct from patch and internal field
  90         timeVaryingFlowRateInletVelocityFvPatchVectorField
  91         (
  92             const fvPatch&,
  93             const DimensionedField<vector, volMesh>&
  94         );
  95
  96         //- Construct from patch, internal field and dictionary
  97         timeVaryingFlowRateInletVelocityFvPatchVectorField
  98         (
  99             const fvPatch&,
 100             const DimensionedField<vector, volMesh>&,
 101             const dictionary&
 102         );
 103
 104         //- Construct by mapping given patch field onto a new patch
 105         timeVaryingFlowRateInletVelocityFvPatchVectorField
 106         (
 107             const timeVaryingFlowRateInletVelocityFvPatchVectorField&,
 108             const fvPatch&,
 109             const DimensionedField<vector, volMesh>&,
 110             const fvPatchFieldMapper&
 111         );
 112
 113         //- Construct as copy
 114         timeVaryingFlowRateInletVelocityFvPatchVectorField
 115         (
 116             const timeVaryingFlowRateInletVelocityFvPatchVectorField&
 117         );
 118
 119         //- Construct and return a clone
 120         virtual tmp<fvPatchVectorField> clone() const
 121         {
 122             return tmp<fvPatchVectorField>
 123             (
 124                 new timeVaryingFlowRateInletVelocityFvPatchVectorField(*this)
 125             );
 126         }
 127
 128         //- Construct as copy setting internal field reference
 129         timeVaryingFlowRateInletVelocityFvPatchVectorField
 130         (
 131             const timeVaryingFlowRateInletVelocityFvPatchVectorField&,
 132             const DimensionedField<vector, volMesh>&
 133         );
 134
 135         //- Construct and return a clone setting internal field reference
 136         virtual tmp<fvPatchVectorField> clone
 137         (
 138             const DimensionedField<vector, volMesh>& iF
 139         ) const
 140         {
 141             return tmp<fvPatchVectorField>
 142             (
 143                 new timeVaryingFlowRateInletVelocityFvPatchVectorField
 144                 (
 145                     *this,
 146                     iF
 147                 )
 148             );
 149         }
 150
 151
 152     // Member functions
 153
 154         // Access
 155
 156             //- Return the time series used
 157             const interpolationTable<scalar>& timeSeries() const
 158             {
 159                 return timeSeries_;
 160             }
 161
 162
 163         // Evaluation functions
 164
 165             //- Update the coefficients associated with the patch field
 166             virtual void updateCoeffs();
 167
 168
 169         //- Write
 170         virtual void write(Ostream&) const;
 171 };
 172
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 } // End namespace Foam
 177
 178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 179
 180 #endif
 181
 182 // ************************************************************************* //