mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-12-28 03:37:59 +00:00
844685d29d
Changed the underlying map to be a Map<scalar> to allow the addition of a value to the Distribution to be weighted (by timestep or by cell size for example) component by-component - default weight is one. Adding normalisation, write, mean snd median functions. Test application DistributionTest draws numbers from the Random class and creates distributions of them, writing to disk, for the main types: scalar, vector, symmTensior, sphericalTensor and tensor. Creating a labelVector distibution, but need to check what is happening to the mean and median values and what happens when an odd number is used as a binWidth, as truncation to label will be occurring.
167 lines
4.2 KiB
C++
167 lines
4.2 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by the
|
|
Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM; if not, write to the Free Software Foundation,
|
|
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
Class
|
|
Foam::Distribution
|
|
|
|
Description
|
|
Accumulating histogram of component values.
|
|
Specified bin resolution automatic generation of bins.
|
|
|
|
SourceFiles
|
|
DistributionI.H
|
|
Distribution.C
|
|
DistributionIO.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef Distribution_H
|
|
#define Distribution_H
|
|
|
|
#include "Map.H"
|
|
#include "Pair.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
template<class Type>
|
|
class Distribution;
|
|
|
|
template<class Type>
|
|
Ostream& operator<<(Ostream&, const Distribution<Type>&);
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class Distribution Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class Distribution
|
|
:
|
|
public List< Map<scalar> >
|
|
{
|
|
// Private data
|
|
|
|
Type binWidth_;
|
|
|
|
|
|
public:
|
|
|
|
//- Component type
|
|
typedef typename pTraits<Type>::cmptType cmptType;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
Distribution();
|
|
|
|
//- Construct from separate binWidth for each component
|
|
Distribution(const Type& binWidth);
|
|
|
|
//- Construct from single binWidth for each component
|
|
// Distribution(const cmptType& binWidth);
|
|
|
|
//- Construct as copy
|
|
Distribution(const Distribution& d);
|
|
|
|
|
|
//- Destructor
|
|
~Distribution();
|
|
|
|
// Member Functions
|
|
|
|
scalar totalWeight(direction cmpt) const;
|
|
|
|
Type mean() const;
|
|
|
|
// From http://mathworld.wolfram.com/StatisticalMedian.html
|
|
// The statistical median is the value of the Distribution
|
|
// variable where the cumulative Distribution = 0.5.
|
|
Type median();
|
|
|
|
void add
|
|
(
|
|
const Type& valueToAdd,
|
|
const Type& weight = pTraits<Type>::one
|
|
);
|
|
|
|
void insertMissingKeys();
|
|
|
|
List< List<Pair<scalar> > > normalised();
|
|
|
|
// List<Pair<scalar> > normalisedMinusMean();
|
|
|
|
// List<Pair<scalar> > normalisedShifted(scalar shift Value);
|
|
|
|
List< List < Pair<scalar> > > raw();
|
|
|
|
// Access
|
|
|
|
inline const Type& binWidth() const;
|
|
|
|
// Write
|
|
|
|
void write
|
|
(
|
|
const fileName& filePrefix,
|
|
const List< List<Pair<scalar> > >& pairs
|
|
) const;
|
|
|
|
|
|
// Member Operators
|
|
|
|
void operator=(const Distribution<Type>&);
|
|
|
|
// IOstream Operators
|
|
|
|
friend Ostream& operator<< <Type>
|
|
(
|
|
Ostream&,
|
|
const Distribution<Type>&
|
|
);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "DistributionI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
# include "Distribution.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|