src/lagrangian/molecularDynamics/molecularMeasurements/bufferedAccumulator/bufferedAccumulator.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::bufferedAccumulator
  27
  28 Description
  29
  30 SourceFiles
  31     bufferedAccumulatorI.H
  32     bufferedAccumulator.C
  33     bufferedAccumulatorIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef bufferedAccumulator_H
  38 #define bufferedAccumulator_H
  39
  40 #include "Field.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 template<class Type>
  48 class bufferedAccumulator;
  49
  50 template<class Type>
  51 Ostream& operator<<
  52 (
  53     Ostream&,
  54     const bufferedAccumulator<Type>&
  55 );
  56
  57 /*---------------------------------------------------------------------------*\
  58                       Class bufferedAccumulator Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 template<class Type>
  62 class bufferedAccumulator
  63 :
  64     public List< Field<Type> >
  65 {
  66     // Private data
  67
  68         label averagesTaken_;
  69
  70         List<label> bufferOffsets_;
  71
  72
  73     // Private Member Functions
  74
  75         inline Field<Type>& accumulationBuffer();
  76
  77         inline const Field<Type>& accumulationBuffer() const;
  78
  79         void accumulateAndResetBuffer(const label b);
  80
  81
  82 public:
  83
  84     //- Component type
  85     typedef typename pTraits<Type>::cmptType cmptType;
  86
  87
  88     // Static data members
  89
  90         static const char* const typeName;
  91
  92
  93     // Constructors
  94
  95         //- Construct null
  96         bufferedAccumulator();
  97
  98         //- Construct from components
  99         bufferedAccumulator
 100         (
 101             const label nBuffers,
 102             const label bufferLength,
 103             const label bufferingInterval
 104         );
 105
 106         //- Construct as copy
 107         bufferedAccumulator(const bufferedAccumulator<Type>&);
 108
 109
 110     // Destructor
 111
 112         ~bufferedAccumulator();
 113
 114
 115     // Member Functions
 116
 117         label addToBuffers(const List<Type>& valuesToAdd);
 118
 119         Field<Type> averaged() const;
 120
 121         void resetAveraging();
 122
 123
 124         // Access
 125
 126             inline label averagesTaken() const;
 127
 128             inline label nBuffers() const;
 129
 130             inline label bufferLength() const;
 131
 132             inline const List<label>& bufferOffsets() const;
 133
 134
 135         // Edit
 136
 137             void setSizes
 138             (
 139                 const label nBuffers,
 140                 const label bufferLength,
 141                 const label bufferingInterval
 142             );
 143
 144
 145     // Member Operators
 146
 147         void operator=(const bufferedAccumulator<Type>&);
 148
 149
 150     // IOstream Operators
 151
 152         friend Ostream& operator<< <Type>
 153         (
 154             Ostream&,
 155             const bufferedAccumulator<Type>&
 156         );
 157 };
 158
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 } // End namespace Foam
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #include "bufferedAccumulatorI.H"
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #ifdef NoRepository
 171 #   include "bufferedAccumulator.C"
 172 #endif
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //