src/lagrangian/molecularDynamics/molecule/distribution/distribution.H

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