src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.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::timeVaryingMappedFixedValueFvPatchField
  27
  28 Description
  29     Foam::timeVaryingMappedFixedValueFvPatchField
  30
  31 SourceFiles
  32     timeVaryingMappedFixedValueFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef timeVaryingMappedFixedValueFvPatchField_H
  37 #define timeVaryingMappedFixedValueFvPatchField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40 #include "coordinateSystem.H"
  41 #include "FixedList.H"
  42 #include "instantList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50               Class timeVaryingMappedFixedValueFvPatch Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class Type>
  54 class timeVaryingMappedFixedValueFvPatchField
  55 :
  56     public fixedValueFvPatchField<Type>
  57 {
  58     // Private data
  59
  60         //- Name of the field data table, defaults to the name of the field
  61         word fieldTableName_;
  62
  63         //- If true adjust the mapped field to maintain average value
  64         bool setAverage_;
  65
  66         //- Coordinate system
  67         autoPtr<coordinateSystem> referenceCS_;
  68
  69         //- Current interpolation addressing to face centres of underlying
  70         //  patch
  71         List<FixedList<label, 3> > nearestVertex_;
  72
  73         //- Current interpolation factors to face centres of underlying
  74         //  patch
  75         List<FixedList<scalar, 3> > nearestVertexWeight_;
  76
  77         //- List of boundaryData time directories
  78         instantList sampleTimes_;
  79
  80         //- Current starting index in sampleTimes
  81         label startSampleTime_;
  82
  83         //- Interpolated values from startSampleTime
  84         Field<Type> startSampledValues_;
  85
  86         //- If setAverage: starting average value
  87         Type startAverage_;
  88
  89         //- Current end index in sampleTimes
  90         label endSampleTime_;
  91
  92         //- Interpolated values from endSampleTime
  93         Field<Type> endSampledValues_;
  94
  95         //- If setAverage: end average value
  96         Type endAverage_;
  97
  98
  99     // Private Member Functions
 100
 101         //- Get names of times
 102         static wordList timeNames(const instantList&);
 103
 104         //- Find times around current time
 105         void findTime
 106         (
 107             const fileName& instance,
 108             const fileName& local,
 109             const scalar timeVal,
 110             label& lo,
 111             label& hi
 112         ) const;
 113
 114         //- Read boundary points and determine interpolation weights to patch
 115         //  faceCentres
 116         void readSamplePoints();
 117
 118         //- Find boundary data inbetween current time and interpolate
 119         void checkTable();
 120
 121         //- Do actual interpolation using current weights
 122         tmp<Field<Type> > interpolate(const Field<Type>&) const;
 123
 124
 125 public:
 126
 127     //- Runtime type information
 128     TypeName("timeVaryingMappedFixedValue");
 129
 130
 131     // Constructors
 132
 133         //- Construct from patch and internal field
 134         timeVaryingMappedFixedValueFvPatchField
 135         (
 136             const fvPatch&,
 137             const DimensionedField<Type, volMesh>&
 138         );
 139
 140         //- Construct from patch, internal field and dictionary
 141         timeVaryingMappedFixedValueFvPatchField
 142         (
 143             const fvPatch&,
 144             const DimensionedField<Type, volMesh>&,
 145             const dictionary&
 146         );
 147
 148         //- Construct by mapping given timeVaryingMappedFixedValueFvPatchField
 149         //  onto a new patch
 150         timeVaryingMappedFixedValueFvPatchField
 151         (
 152             const timeVaryingMappedFixedValueFvPatchField<Type>&,
 153             const fvPatch&,
 154             const DimensionedField<Type, volMesh>&,
 155             const fvPatchFieldMapper&
 156         );
 157
 158         //- Construct as copy
 159         timeVaryingMappedFixedValueFvPatchField
 160         (
 161             const timeVaryingMappedFixedValueFvPatchField<Type>&
 162         );
 163
 164         //- Construct and return a clone
 165         virtual tmp<fvPatchField<Type> > clone() const
 166         {
 167             return tmp<fvPatchField<Type> >
 168             (
 169                 new timeVaryingMappedFixedValueFvPatchField<Type>(*this)
 170             );
 171         }
 172
 173         //- Construct as copy setting internal field reference
 174         timeVaryingMappedFixedValueFvPatchField
 175         (
 176             const timeVaryingMappedFixedValueFvPatchField<Type>&,
 177             const DimensionedField<Type, volMesh>&
 178         );
 179
 180         //- Construct and return a clone setting internal field reference
 181         virtual tmp<fvPatchField<Type> > clone
 182         (
 183             const DimensionedField<Type, volMesh>& iF
 184         ) const
 185         {
 186             return tmp<fvPatchField<Type> >
 187             (
 188                 new timeVaryingMappedFixedValueFvPatchField<Type>(*this, iF)
 189             );
 190         }
 191
 192
 193     // Member functions
 194
 195         // Access
 196
 197             //- Return the coordinateSystem
 198             const coordinateSystem& referenceCS() const
 199             {
 200                 return referenceCS_;
 201             }
 202
 203
 204         // Mapping functions
 205
 206             //- Map (and resize as needed) from self given a mapping object
 207             virtual void autoMap
 208             (
 209                 const fvPatchFieldMapper&
 210             );
 211
 212             //- Reverse map the given fvPatchField onto this fvPatchField
 213             virtual void rmap
 214             (
 215                 const fvPatchField<Type>&,
 216                 const labelList&
 217             );
 218
 219
 220         // Evaluation functions
 221
 222             //- Update the coefficients associated with the patch field
 223             virtual void updateCoeffs();
 224
 225
 226         //- Write
 227         virtual void write(Ostream&) const;
 228 };
 229
 230
 231 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 232
 233 } // End namespace Foam
 234
 235 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 236
 237 #ifdef NoRepository
 238 #   include "timeVaryingMappedFixedValueFvPatchField.C"
 239 #endif
 240
 241 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 242
 243 #endif
 244
 245 // ************************************************************************* //