src/lagrangian/molecularDynamics/molecularMeasurements/bufferedAccumulator/bufferedAccumulator.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "bufferedAccumulator.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 template<class Type>
  32 const char* const
  33     Foam::bufferedAccumulator<Type>::typeName("bufferedAccumulator");
  34
  35
  36 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  37
  38 template<class Type>
  39 void Foam::bufferedAccumulator<Type>::accumulateAndResetBuffer(const label b)
  40 {
  41     accumulationBuffer() += (*this)[b];
  42
  43     averagesTaken_++;
  44
  45     (*this)[b] = Field<Type>(bufferLength(), pTraits<Type>::zero);
  46
  47     bufferOffsets_[b] = 0;
  48 }
  49
  50
  51 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  52
  53 template<class Type>
  54 Foam::bufferedAccumulator<Type>::bufferedAccumulator()
  55 :
  56     List< Field<Type> >(),
  57     averagesTaken_(),
  58     bufferOffsets_()
  59 {}
  60
  61
  62 template<class Type>
  63 Foam::bufferedAccumulator<Type>::bufferedAccumulator
  64 (
  65     const label nBuffers,
  66     const label bufferLength,
  67     const label bufferingInterval
  68 )
  69 :
  70     List< Field<Type> >(),
  71     averagesTaken_(),
  72     bufferOffsets_()
  73 {
  74     setSizes
  75     (
  76         nBuffers,
  77         bufferLength,
  78         bufferingInterval
  79     );
  80 }
  81
  82
  83 template<class Type>
  84 Foam::bufferedAccumulator<Type>::bufferedAccumulator
  85 (
  86     const bufferedAccumulator<Type>& bA
  87 )
  88 :
  89     List< Field<Type> >(static_cast< List< Field<Type> > >(bA)),
  90     averagesTaken_(bA.averagesTaken()),
  91     bufferOffsets_(bA.bufferOffsets())
  92 {}
  93
  94
  95 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  96
  97 template<class Type>
  98 Foam::bufferedAccumulator<Type>::~bufferedAccumulator()
  99 {}
 100
 101
 102 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 103
 104 template<class Type>
 105 void Foam::bufferedAccumulator<Type>::setSizes
 106 (
 107     const label nBuffers,
 108     const label bufferLength,
 109     const label bufferingInterval
 110 )
 111 {
 112     (*this).setSize(nBuffers + 1);
 113
 114     forAll((*this), b)
 115     {
 116         (*this)[b] = Field<Type>(bufferLength, pTraits<Type>::zero);
 117     }
 118
 119     averagesTaken_ = 0;
 120
 121     bufferOffsets_.setSize(nBuffers);
 122
 123     forAll(bufferOffsets_, bO)
 124     {
 125         bufferOffsets_[bO] = -bufferingInterval * bO - 1;
 126     }
 127 }
 128
 129
 130 template<class Type>
 131 Foam::label Foam::bufferedAccumulator<Type>::addToBuffers
 132 (
 133     const List<Type>& valuesToAdd
 134 )
 135 {
 136     label bufferToRefill = -1;
 137
 138     for (label b = 0; b < nBuffers(); b++)
 139     {
 140         Field<Type>& buf((*this)[b]);
 141
 142         label& bO = bufferOffsets_[b];
 143
 144         if (bO >= 0)
 145         {
 146             buf[bO] = valuesToAdd[b];
 147         }
 148
 149         bO++;
 150
 151         if (bO == bufferLength())
 152         {
 153             accumulateAndResetBuffer(b);
 154         }
 155
 156         if (bO == 0)
 157         {
 158             if (bufferToRefill != -1)
 159             {
 160                 FatalErrorIn("bufferedAccumulator<Type>::addToBuffers ")
 161                     << "More than one bufferedAccumulator accumulation "
 162                     << "buffer filled at once, this is considered an error."
 163                     << abort(FatalError);
 164             }
 165
 166             bufferToRefill = b;
 167         }
 168     }
 169
 170     return bufferToRefill;
 171 }
 172
 173
 174 template<class Type>
 175 Foam::Field<Type> Foam::bufferedAccumulator<Type>::averaged() const
 176 {
 177     if (averagesTaken_)
 178     {
 179         Field<Type> bA = accumulationBuffer()/averagesTaken_;
 180
 181         return bA;
 182     }
 183     else
 184     {
 185         WarningIn
 186         (
 187             "bufferedAccumulator<Type>::averagedbufferedAccumulator() const"
 188         )   << "Averaged correlation function requested but averagesTaken = "
 189             << averagesTaken_
 190             << ". Returning empty field."
 191             << endl;
 192
 193         return Field<Type>(bufferLength(), pTraits<Type>::zero);
 194     }
 195 }
 196
 197
 198 template<class Type>
 199 void Foam::bufferedAccumulator<Type>::resetAveraging()
 200 {
 201     accumulationBuffer() = Field<Type>(bufferLength(), pTraits<Type>::zero);
 202
 203     averagesTaken_ = 0;
 204 }
 205
 206
 207 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
 208
 209 template<class Type>
 210 void Foam::bufferedAccumulator<Type>::operator=
 211 (
 212     const bufferedAccumulator<Type>& rhs
 213 )
 214 {
 215     // Check for assignment to self
 216     if (this == &rhs)
 217     {
 218         FatalErrorIn
 219         (
 220             "bufferedAccumulator<Type>::operator=(const bufferedAccumulator&)"
 221         )   << "Attempted assignment to self"
 222             << abort(FatalError);
 223     }
 224
 225     List< Field<Type> >::operator=(rhs);
 226
 227     averagesTaken_ = rhs.averagesTaken();
 228
 229     bufferOffsets_ = rhs.bufferOffsets();
 230 }
 231
 232
 233 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 234
 235 #   include "bufferedAccumulatorIO.C"
 236
 237 // ************************************************************************* //