src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.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::timeVaryingUniformFixedValuePointPatchField
  26
  27 Description
  28     A time-varying form of a uniform fixed value boundary condition.
  29
  30 See Also
  31     Foam::timeVaryingUniformFixedValueFvField
  32
  33 SourceFiles
  34     timeVaryingUniformFixedValuePointPatchField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef timeVaryingUniformFixedValuePointPatchField_H
  39 #define timeVaryingUniformFixedValuePointPatchField_H
  40
  41 #include "fixedValuePointPatchField.H"
  42 #include "interpolationTable.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50         Class timeVaryingUniformFixedValuePointPatchField Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class Type>
  54 class timeVaryingUniformFixedValuePointPatchField
  55 :
  56     public fixedValuePointPatchField<Type>
  57 {
  58     // Private data
  59
  60         //- the time series being used, including the bounding treatment
  61         interpolationTable<Type> timeSeries_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("timeVaryingUniformFixedValue");
  68
  69
  70     // Constructors
  71
  72         //- Construct from patch and internal field
  73         timeVaryingUniformFixedValuePointPatchField
  74         (
  75             const pointPatch&,
  76             const DimensionedField<Type, pointMesh>&
  77         );
  78
  79         //- Construct from patch, internal field and dictionary
  80         timeVaryingUniformFixedValuePointPatchField
  81         (
  82             const pointPatch&,
  83             const DimensionedField<Type, pointMesh>&,
  84             const dictionary&
  85         );
  86
  87         //- Construct by mapping given patch field onto a new patch
  88         timeVaryingUniformFixedValuePointPatchField
  89         (
  90             const timeVaryingUniformFixedValuePointPatchField<Type>&,
  91             const pointPatch&,
  92             const DimensionedField<Type, pointMesh>&,
  93             const pointPatchFieldMapper&
  94         );
  95
  96         //- Construct as copy
  97         timeVaryingUniformFixedValuePointPatchField
  98         (
  99             const timeVaryingUniformFixedValuePointPatchField<Type>&
 100         );
 101
 102         //- Construct and return a clone
 103         virtual autoPtr<pointPatchField<Type> > clone() const
 104         {
 105             return autoPtr<pointPatchField<Type> >
 106             (
 107                 new timeVaryingUniformFixedValuePointPatchField<Type>(*this)
 108             );
 109         }
 110
 111         //- Construct as copy setting internal field reference
 112         timeVaryingUniformFixedValuePointPatchField
 113         (
 114             const timeVaryingUniformFixedValuePointPatchField<Type>&,
 115             const DimensionedField<Type, pointMesh>&
 116         );
 117
 118         //- Construct and return a clone setting internal field reference
 119         virtual autoPtr<pointPatchField<Type> > clone
 120         (
 121             const DimensionedField<Type, pointMesh>& iF
 122         ) const
 123         {
 124             return autoPtr<pointPatchField<Type> >
 125             (
 126                 new timeVaryingUniformFixedValuePointPatchField<Type>(*this, iF)
 127             );
 128         }
 129
 130
 131     // Member functions
 132
 133         // Access
 134
 135             //- Return the time series used
 136             const interpolationTable<Type>& timeSeries() const
 137             {
 138                 return timeSeries_;
 139             }
 140
 141
 142         // Evaluation functions
 143
 144             //- Update the coefficients associated with the patch field
 145             virtual void updateCoeffs();
 146
 147
 148         //- Write
 149         virtual void write(Ostream&) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #ifdef NoRepository
 160 #   include "timeVaryingUniformFixedValuePointPatchField.C"
 161 #endif
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #endif
 166
 167 // ************************************************************************* //