src/finiteVolume/fields/fvPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValueFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::timeVaryingUniformFixedValueFvPatchField
  26
  27 Description
  28     A time-varying form of a uniform fixed value boundary condition. The
  29     variation is specified as an interpolationTable (see
  30     Foam::interpolationTable for read options).
  31
  32     Example of the boundary condition specification:
  33     \verbatim
  34     inlet
  35     {
  36         type            timeVaryingUniformFixedValue;
  37         fileName        "$FOAM_CASE/time-series";
  38         outOfBounds     clamp;           // (error|warn|clamp|repeat)
  39     }
  40     \endverbatim
  41
  42 Note
  43     This class is derived directly from a fixedValue patch rather than from
  44     a uniformFixedValue patch.
  45
  46 See Also
  47     Foam::interpolationTable and Foam::fixedValueFvPatchField
  48
  49 SourceFiles
  50     timeVaryingUniformFixedValueFvPatchField.C
  51
  52 \*---------------------------------------------------------------------------*/
  53
  54 #ifndef timeVaryingUniformFixedValueFvPatchField_H
  55 #define timeVaryingUniformFixedValueFvPatchField_H
  56
  57 #include "fixedValueFvPatchField.H"
  58 #include "interpolationTable.H"
  59
  60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  61
  62 namespace Foam
  63 {
  64
  65 /*---------------------------------------------------------------------------*\
  66            Class timeVaryingUniformFixedValueFvPatch Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 template<class Type>
  70 class timeVaryingUniformFixedValueFvPatchField
  71 :
  72     public fixedValueFvPatchField<Type>
  73 {
  74     // Private data
  75
  76         //- The time series being used, including the bounding treatment
  77         interpolationTable<Type> timeSeries_;
  78
  79
  80 public:
  81
  82     //- Runtime type information
  83     TypeName("timeVaryingUniformFixedValue");
  84
  85
  86     // Constructors
  87
  88         //- Construct from patch and internal field
  89         timeVaryingUniformFixedValueFvPatchField
  90         (
  91             const fvPatch&,
  92             const DimensionedField<Type, volMesh>&
  93         );
  94
  95         //- Construct from patch, internal field and dictionary
  96         timeVaryingUniformFixedValueFvPatchField
  97         (
  98             const fvPatch&,
  99             const DimensionedField<Type, volMesh>&,
 100             const dictionary&
 101         );
 102
 103         //- Construct by mapping given patch field onto a new patch
 104         timeVaryingUniformFixedValueFvPatchField
 105         (
 106             const timeVaryingUniformFixedValueFvPatchField<Type>&,
 107             const fvPatch&,
 108             const DimensionedField<Type, volMesh>&,
 109             const fvPatchFieldMapper&
 110         );
 111
 112         //- Construct as copy
 113         timeVaryingUniformFixedValueFvPatchField
 114         (
 115             const timeVaryingUniformFixedValueFvPatchField<Type>&
 116         );
 117
 118         //- Construct and return a clone
 119         virtual tmp<fvPatchField<Type> > clone() const
 120         {
 121             return tmp<fvPatchField<Type> >
 122             (
 123                 new timeVaryingUniformFixedValueFvPatchField<Type>(*this)
 124             );
 125         }
 126
 127         //- Construct as copy setting internal field reference
 128         timeVaryingUniformFixedValueFvPatchField
 129         (
 130             const timeVaryingUniformFixedValueFvPatchField<Type>&,
 131             const DimensionedField<Type, volMesh>&
 132         );
 133
 134         //- Construct and return a clone setting internal field reference
 135         virtual tmp<fvPatchField<Type> > clone
 136         (
 137             const DimensionedField<Type, volMesh>& iF
 138         ) const
 139         {
 140             return tmp<fvPatchField<Type> >
 141             (
 142                 new timeVaryingUniformFixedValueFvPatchField<Type>(*this, iF)
 143             );
 144         }
 145
 146
 147     // Member functions
 148
 149         // Access
 150
 151             //- Return the time series used
 152             const interpolationTable<Type>& timeSeries() const
 153             {
 154                 return timeSeries_;
 155             }
 156
 157
 158         // Evaluation functions
 159
 160             //- Update the coefficients associated with the patch field
 161             virtual void updateCoeffs();
 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 "timeVaryingUniformFixedValueFvPatchField.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //