src/lagrangian/molecularDynamics/molecularMeasurements/correlationFunction/correlationFunction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2009 OpenCFD Ltd.
   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::correlationFunction
  27
  28 Description
  29
  30 SourceFiles
  31     correlationFunctionI.H
  32     correlationFunction.C
  33     correlationFunctionIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef correlationFunction_H
  38 #define correlationFunction_H
  39
  40 #include "bufferedAccumulator.H"
  41 #include "dictionary.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 template<class Type>
  49 class correlationFunction;
  50
  51 template<class Type>
  52 Ostream& operator<<
  53 (
  54     Ostream&,
  55     const correlationFunction<Type>&
  56 );
  57
  58 /*---------------------------------------------------------------------------*\
  59                     Class correlationFunction Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 template<class Type>
  63 class correlationFunction
  64 :
  65     public bufferedAccumulator<scalar>
  66 {
  67     // Private data
  68
  69         const polyMesh& mesh_;
  70
  71         Field< Field<Type> > tZeroBuffers_;
  72
  73         scalar duration_;
  74         scalar sampleInterval_;
  75         scalar averagingInterval_;
  76
  77         label sampleSteps_;
  78
  79
  80     // Private Member Functions
  81
  82         void setTimesAndSizes(const label);
  83
  84         //- Disallow default bitwise copy construct
  85         correlationFunction(const correlationFunction<Type>&);
  86
  87         //- Disallow default bitwise assignment
  88         void operator=(const correlationFunction<Type>&);
  89
  90
  91 public:
  92
  93     //- Component type
  94     typedef typename pTraits<Type>::cmptType cmptType;
  95
  96
  97     // Static data members
  98
  99         static const char* const typeName;
 100
 101
 102     // Constructors
 103
 104         //- Construct from dictionary
 105         correlationFunction
 106         (
 107             const polyMesh&,
 108             const dictionary&,
 109             const label tZeroBufferSize
 110         );
 111
 112         //- Construct from components
 113         correlationFunction
 114         (
 115             const polyMesh&,
 116             const label tZeroBufferSize,
 117             const scalar duration,
 118             const scalar sampleInterval,
 119             const scalar averagingInterval
 120
 121         );
 122
 123
 124     // Destructor
 125
 126         ~correlationFunction();
 127
 128
 129     // Member Functions
 130
 131         void calculateCorrelationFunction(const Field<Type>&);
 132
 133         void calculateCorrelationFunction(const Type&);
 134
 135         scalar integral() const;
 136
 137         bool writeAveraged(Ostream&) const;
 138
 139
 140     // Access
 141
 142         inline const Field< Field<Type> >& tZeroBuffers() const;
 143
 144         inline scalar duration() const;
 145
 146         inline scalar sampleInterval() const;
 147
 148         inline scalar averagingInterval() const;
 149
 150         inline label sampleSteps() const;
 151
 152         inline label measurandFieldSize() const;
 153
 154
 155     // IOstream Operators
 156
 157         friend Ostream& operator<< <Type>
 158         (
 159             Ostream&,
 160             const correlationFunction<Type>&
 161         );
 162 };
 163
 164
 165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 166
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #include "correlationFunctionI.H"
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "correlationFunction.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //