src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.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::distribution
  27
  28 Description
  29
  30 SourceFiles
  31     distributionI.H
  32     distribution.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef distribution_H
  37 #define distribution_H
  38
  39 #include "Map.H"
  40 #include "Pair.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                         Class distribution Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class distribution
  52 :
  53     public Map<label>
  54 {
  55     // Private data
  56
  57         scalar binWidth_;
  58
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct null
  65         distribution();
  66
  67         //- Construct from binWidth
  68         distribution(const scalar binWidth);
  69
  70         //- Construct as copy
  71         distribution(const distribution&);
  72
  73
  74     // Destructor
  75
  76         ~distribution();
  77
  78
  79     // Member Functions
  80
  81         label totalEntries() const;
  82
  83         scalar approxTotalEntries() const;
  84
  85         scalar mean() const;
  86
  87         scalar median();
  88
  89         //- Add a value to the appropriate bin of the distribution.
  90         void add(const scalar valueToAdd);
  91
  92         void add(const label valueToAdd);
  93
  94         void insertMissingKeys();
  95
  96         List<Pair<scalar> > normalised();
  97
  98         List<Pair<scalar> > normalisedMinusMean();
  99
 100         List<Pair<scalar> > normalisedShifted(const scalar shiftValue);
 101
 102         List<Pair<scalar> > raw();
 103
 104
 105         // Access
 106
 107             inline scalar binWidth() const;
 108
 109
 110     // Member Operators
 111
 112         void operator=(const distribution&);
 113
 114
 115     // IOstream Operators
 116
 117         friend Ostream& operator<<(Ostream&, const distribution&);
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #include "distributionI.H"
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //