Merge branch 'master' of /home/noisy3/OpenFOAM/OpenFOAM-dev
This commit is contained in:
mattijs
commit
fc1e443116
292
applications/test/Distribution/DistributionTest.C
Normal file
292
applications/test/Distribution/DistributionTest.C
Normal file
@ -0,0 +1,292 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2009-2011 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Application
|
||||||
|
DistributionTest
|
||||||
|
|
||||||
|
Description
|
||||||
|
Test the Distribution class
|
||||||
|
|
||||||
|
Plot normal distribution test in gnuplot using:
|
||||||
|
|
||||||
|
@verbatim
|
||||||
|
normalDistribution(mean, sigma, x) = \
|
||||||
|
sqrt(1.0/(2.0*pi*sigma**2))*exp(-(x - mean)**2.0/(2.0*sigma**2))
|
||||||
|
|
||||||
|
plot normalDistribution(8.5, 2.5, x), "Distribution_scalar_test_x" w p
|
||||||
|
@endverbatim
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
#include "vector.H"
|
||||||
|
#include "labelVector.H"
|
||||||
|
#include "tensor.H"
|
||||||
|
#include "Distribution.H"
|
||||||
|
#include "Random.H"
|
||||||
|
#include "dimensionedTypes.H"
|
||||||
|
#include "argList.H"
|
||||||
|
#include "PstreamReduceOps.H"
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
using namespace Foam;
|
||||||
|
|
||||||
|
int main(int argc, char *argv[])
|
||||||
|
{
|
||||||
|
# include "setRootCase.H"
|
||||||
|
|
||||||
|
Random R(918273);
|
||||||
|
|
||||||
|
{
|
||||||
|
// scalar
|
||||||
|
label randomDistributionTestSize = 50000000;
|
||||||
|
|
||||||
|
Distribution<scalar> dS(scalar(5e-2));
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<scalar>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from GaussNormal distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dS.add(2.5*R.GaussNormal() + 8.5);
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dS.mean() << nl
|
||||||
|
<< "Median " << dS.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dS.write("Distribution_scalar_test_1");
|
||||||
|
|
||||||
|
Distribution<scalar> dS2(scalar(1e-2));
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<scalar>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from GaussNormal distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dS2.add(1.5*R.GaussNormal() -6.0);
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dS2.mean() << nl
|
||||||
|
<< "Median " << dS2.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dS2.write("Distribution_scalar_test_2");
|
||||||
|
|
||||||
|
Info<< nl << "Adding previous two Distribution<scalar>" << endl;
|
||||||
|
|
||||||
|
dS = dS + dS2;
|
||||||
|
|
||||||
|
dS.write("Distribution_scalar_test_1+2");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Pstream::parRun())
|
||||||
|
{
|
||||||
|
// scalar in parallel
|
||||||
|
label randomDistributionTestSize = 100000000;
|
||||||
|
|
||||||
|
Distribution<scalar> dS(scalar(1e-1));
|
||||||
|
|
||||||
|
Pout<< "Distribution<scalar>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from uniform distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dS.add(R.scalar01() + 10*Pstream::myProcNo());
|
||||||
|
}
|
||||||
|
|
||||||
|
Pout<< "Mean " << dS.mean() << nl
|
||||||
|
<< "Median " << dS.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
reduce(dS, sumOp< Distribution<scalar> >());
|
||||||
|
|
||||||
|
if (Pstream::master())
|
||||||
|
{
|
||||||
|
Info<< "Reducing parallel Distribution<scalar>" << nl
|
||||||
|
<< "Mean " << dS.mean() << nl
|
||||||
|
<< "Median " << dS.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dS.write("Distribution_scalar_test_parallel_reduced");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
// vector
|
||||||
|
Distribution<vector> dV(vector(0.1, 0.05, 0.15));
|
||||||
|
|
||||||
|
label randomDistributionTestSize = 1000000;
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<vector>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from uniform and GaussNormal distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dV.add(R.vector01());
|
||||||
|
|
||||||
|
// Adding separate GaussNormal components with component
|
||||||
|
// weights
|
||||||
|
|
||||||
|
dV.add
|
||||||
|
(
|
||||||
|
vector
|
||||||
|
(
|
||||||
|
R.GaussNormal()*3.0 + 1.5,
|
||||||
|
R.GaussNormal()*0.25 + 4.0,
|
||||||
|
R.GaussNormal()*3.0 - 1.5
|
||||||
|
),
|
||||||
|
vector(1.0, 2.0, 5.0)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dV.mean() << nl
|
||||||
|
<< "Median " << dV.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dV.write("Distribution_vector_test");
|
||||||
|
}
|
||||||
|
|
||||||
|
// {
|
||||||
|
// // labelVector
|
||||||
|
// Distribution<labelVector> dLV(labelVector::one*10);
|
||||||
|
|
||||||
|
// label randomDistributionTestSize = 2000000;
|
||||||
|
|
||||||
|
// Info<< nl << "Distribution<labelVector>" << nl
|
||||||
|
// << "Sampling "
|
||||||
|
// << randomDistributionTestSize
|
||||||
|
// << " times from uniform distribution."
|
||||||
|
// << endl;
|
||||||
|
|
||||||
|
// for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
// {
|
||||||
|
// dLV.add
|
||||||
|
// (
|
||||||
|
// labelVector
|
||||||
|
// (
|
||||||
|
// R.integer(-1000, 1000),
|
||||||
|
// R.integer(-5000, 5000),
|
||||||
|
// R.integer(-2000, 7000)
|
||||||
|
// )
|
||||||
|
// );
|
||||||
|
// }
|
||||||
|
|
||||||
|
// Info<< "Mean " << dLV.mean() << nl
|
||||||
|
// << "Median " << dLV.median()
|
||||||
|
// << endl;
|
||||||
|
|
||||||
|
// dLV.write("Distribution_labelVector_test");
|
||||||
|
// }
|
||||||
|
|
||||||
|
{
|
||||||
|
// tensor
|
||||||
|
Distribution<tensor> dT(tensor::one*1e-2);
|
||||||
|
|
||||||
|
label randomDistributionTestSize = 2000000;
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<tensor>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from uniform distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dT.add(R.tensor01());
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dT.mean() << nl
|
||||||
|
<< "Median " << dT.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dT.write("Distribution_tensor_test");
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
// symmTensor
|
||||||
|
Distribution<symmTensor> dSyT(symmTensor::one*1e-2);
|
||||||
|
|
||||||
|
label randomDistributionTestSize = 2000000;
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<symmTensor>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from uniform distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dSyT.add(R.symmTensor01());
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dSyT.mean() << nl
|
||||||
|
<< "Median " << dSyT.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dSyT.write("Distribution_symmTensor_test");
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
// sphericalTensor
|
||||||
|
Distribution<sphericalTensor> dSpT(sphericalTensor::one*1e-2);
|
||||||
|
|
||||||
|
label randomDistributionTestSize = 50000000;
|
||||||
|
|
||||||
|
Info<< nl << "Distribution<sphericalTensor>" << nl
|
||||||
|
<< "Sampling "
|
||||||
|
<< randomDistributionTestSize
|
||||||
|
<< " times from uniform distribution."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
for (label i = 0; i < randomDistributionTestSize; i++)
|
||||||
|
{
|
||||||
|
dSpT.add(R.sphericalTensor01());
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< "Mean " << dSpT.mean() << nl
|
||||||
|
<< "Median " << dSpT.median()
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
dSpT.write("Distribution_sphericalTensor_test");
|
||||||
|
}
|
||||||
|
|
||||||
|
Info<< nl << "End" << nl << endl;
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
3
applications/test/Distribution/Make/files
Normal file
3
applications/test/Distribution/Make/files
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
DistributionTest.C
|
||||||
|
|
||||||
|
EXE = $(FOAM_USER_APPBIN)/Test-DistributionTest
|
||||||
2
applications/test/Distribution/Make/options
Normal file
2
applications/test/Distribution/Make/options
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
/* EXE_INC = */
|
||||||
|
/* EXE_LIBS = */
|
||||||
43
bin/foamExec
43
bin/foamExec
@ -3,7 +3,7 @@
|
|||||||
# ========= |
|
# ========= |
|
||||||
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
# \\ / O peration |
|
# \\ / O peration |
|
||||||
# \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
# \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||||
# \\/ M anipulation |
|
# \\/ M anipulation |
|
||||||
#-------------------------------------------------------------------------------
|
#-------------------------------------------------------------------------------
|
||||||
# License
|
# License
|
||||||
@ -59,10 +59,10 @@ USAGE
|
|||||||
# This script must exist in <foamInstall>/OpenFOAM-<VERSION>/bin/
|
# This script must exist in <foamInstall>/OpenFOAM-<VERSION>/bin/
|
||||||
# or <foamInstall>/openfoam<VERSION>/bin/ (for the debian version)
|
# or <foamInstall>/openfoam<VERSION>/bin/ (for the debian version)
|
||||||
#
|
#
|
||||||
# foamEtcFile is found in the same directory
|
# foamEtcFile must be found in the same directory as this script
|
||||||
#-------------------------------------------------------------------------------
|
#-------------------------------------------------------------------------------
|
||||||
|
|
||||||
unset etcOpts
|
unset etcOpts version
|
||||||
# parse options
|
# parse options
|
||||||
while [ "$#" -gt 0 ]
|
while [ "$#" -gt 0 ]
|
||||||
do
|
do
|
||||||
@ -72,7 +72,13 @@ do
|
|||||||
;;
|
;;
|
||||||
-v | -version)
|
-v | -version)
|
||||||
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
||||||
etcOpts="-version $2"
|
version="$2"
|
||||||
|
etcOpts="$etcOpts $1 $2" # pass-thru to foamEtcFile
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
-m | -mode | -p | -prefix)
|
||||||
|
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
||||||
|
etcOpts="$etcOpts $1 $2" # pass-thru to foamEtcFile
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
--)
|
--)
|
||||||
@ -89,19 +95,28 @@ do
|
|||||||
shift
|
shift
|
||||||
done
|
done
|
||||||
|
|
||||||
[ "$#" -ge 1 ] || usage "no application specified"
|
|
||||||
|
|
||||||
# find OpenFOAM settings (bashrc)
|
#
|
||||||
foamDotFile="$(${0%/*}/foamEtcFile $etcOpts bashrc)" || {
|
# Find and source OpenFOAM settings (bashrc)
|
||||||
echo "Error : bashrc file could not be found for OpenFOAM-$version" 1>&2
|
# placed in function to preserve command-line arguments
|
||||||
exit 1
|
#
|
||||||
|
sourceRc()
|
||||||
|
{
|
||||||
|
# default is the current version
|
||||||
|
: ${version:=${WM_PROJECT_VERSION:-unknown}}
|
||||||
|
|
||||||
|
foamDotFile="$(${0%/*}/foamEtcFile $etcOpts bashrc)" || {
|
||||||
|
echo "Error : bashrc file could not be found for OpenFOAM-$version" 1>&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
. $foamDotFile
|
||||||
}
|
}
|
||||||
|
|
||||||
# preserve arguments (can otherwise get lost when sourcing the foamDotFile)
|
|
||||||
args="$*"
|
|
||||||
. $foamDotFile
|
|
||||||
|
|
||||||
# execute
|
[ "$#" -ge 1 ] || usage "no application specified"
|
||||||
exec $args
|
|
||||||
|
sourceRc
|
||||||
|
exec "$@"
|
||||||
|
|
||||||
#------------------------------------------------------------------------------
|
#------------------------------------------------------------------------------
|
||||||
|
|||||||
675
src/OpenFOAM/containers/Lists/Distribution/Distribution.C
Normal file
675
src/OpenFOAM/containers/Lists/Distribution/Distribution.C
Normal file
@ -0,0 +1,675 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2009-2011 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
#include "Distribution.H"
|
||||||
|
#include "OFstream.H"
|
||||||
|
#include "ListOps.H"
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Distribution<Type>::Distribution()
|
||||||
|
:
|
||||||
|
List< List<scalar> >(pTraits<Type>::nComponents),
|
||||||
|
binWidth_(pTraits<Type>::one),
|
||||||
|
listStarts_(pTraits<Type>::nComponents, 0)
|
||||||
|
{}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Distribution<Type>::Distribution(const Type& binWidth)
|
||||||
|
:
|
||||||
|
List< List<scalar> >(pTraits<Type>::nComponents),
|
||||||
|
binWidth_(binWidth),
|
||||||
|
listStarts_(pTraits<Type>::nComponents, 0)
|
||||||
|
{}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Distribution<Type>::Distribution(const Distribution<Type>& d)
|
||||||
|
:
|
||||||
|
List< List<scalar> >(static_cast< const List< List<scalar> >& >(d)),
|
||||||
|
binWidth_(d.binWidth()),
|
||||||
|
listStarts_(d.listStarts())
|
||||||
|
{}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Distribution<Type>::~Distribution()
|
||||||
|
{}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::scalar Foam::Distribution<Type>::totalWeight(direction cmpt) const
|
||||||
|
{
|
||||||
|
const List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
scalar sumOfWeights = 0.0;
|
||||||
|
|
||||||
|
forAll(cmptDistribution, i)
|
||||||
|
{
|
||||||
|
sumOfWeights += cmptDistribution[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
return sumOfWeights;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::List<Foam::label> Foam::Distribution<Type>::keys(direction cmpt) const
|
||||||
|
{
|
||||||
|
List<label> keys = identity((*this)[cmpt].size());
|
||||||
|
|
||||||
|
forAll(keys, k)
|
||||||
|
{
|
||||||
|
keys[k] += listStarts_[cmpt];
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::label Foam::Distribution<Type>::index
|
||||||
|
(
|
||||||
|
direction cmpt,
|
||||||
|
label n
|
||||||
|
)
|
||||||
|
{
|
||||||
|
List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
if (cmptDistribution.empty())
|
||||||
|
{
|
||||||
|
// Initialise this list with this value
|
||||||
|
|
||||||
|
cmptDistribution.setSize(2, 0.0);
|
||||||
|
|
||||||
|
listStarts_[cmpt] = n;
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
label listIndex = -1;
|
||||||
|
|
||||||
|
label& listStart = listStarts_[cmpt];
|
||||||
|
|
||||||
|
label testIndex = n - listStart;
|
||||||
|
|
||||||
|
if (testIndex < 0)
|
||||||
|
{
|
||||||
|
// Underflow of this List, storage increase and remapping
|
||||||
|
// required
|
||||||
|
|
||||||
|
List<scalar> newCmptDistribution(2*cmptDistribution.size(), 0.0);
|
||||||
|
|
||||||
|
label sOld = cmptDistribution.size();
|
||||||
|
|
||||||
|
forAll(cmptDistribution, i)
|
||||||
|
{
|
||||||
|
newCmptDistribution[i + sOld] = cmptDistribution[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
cmptDistribution = newCmptDistribution;
|
||||||
|
|
||||||
|
listStart -= sOld;
|
||||||
|
|
||||||
|
// Recursively call this function in case another remap is required.
|
||||||
|
listIndex = index(cmpt, n);
|
||||||
|
}
|
||||||
|
else if (testIndex > cmptDistribution.size() - 1)
|
||||||
|
{
|
||||||
|
// Overflow of this List, storage increase required
|
||||||
|
|
||||||
|
cmptDistribution.setSize(2*cmptDistribution.size(), 0.0);
|
||||||
|
|
||||||
|
// Recursively call this function in case another storage
|
||||||
|
// alteration is required.
|
||||||
|
listIndex = index(cmpt, n);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
listIndex = n - listStart;
|
||||||
|
}
|
||||||
|
|
||||||
|
return listIndex;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Pair<Foam::label> Foam::Distribution<Type>::validLimits
|
||||||
|
(
|
||||||
|
direction cmpt
|
||||||
|
) const
|
||||||
|
{
|
||||||
|
const List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
// limits.first(): lower bound, i.e. the first non-zero entry
|
||||||
|
// limits.second(): upper bound, i.e. the last non-zero entry
|
||||||
|
Pair<label> limits(-1, -1);
|
||||||
|
|
||||||
|
forAll(cmptDistribution, i)
|
||||||
|
{
|
||||||
|
if (cmptDistribution[i] > 0.0)
|
||||||
|
{
|
||||||
|
if (limits.first() == -1)
|
||||||
|
{
|
||||||
|
limits.first() = i;
|
||||||
|
limits.second() = i;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
limits.second() = i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return limits;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Type Foam::Distribution<Type>::mean() const
|
||||||
|
{
|
||||||
|
Type meanValue(pTraits<Type>::zero);
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
scalar totalCmptWeight = totalWeight(cmpt);
|
||||||
|
|
||||||
|
List<label> theKeys = keys(cmpt);
|
||||||
|
|
||||||
|
forAll(theKeys, k)
|
||||||
|
{
|
||||||
|
label key = theKeys[k];
|
||||||
|
|
||||||
|
setComponent(meanValue, cmpt) +=
|
||||||
|
(0.5 + scalar(key))
|
||||||
|
*component(binWidth_, cmpt)
|
||||||
|
*cmptDistribution[k]
|
||||||
|
/totalCmptWeight;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return meanValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Type Foam::Distribution<Type>::median() const
|
||||||
|
{
|
||||||
|
Type medianValue(pTraits<Type>::zero);
|
||||||
|
|
||||||
|
List< List < Pair<scalar> > > normDistribution = normalised();
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
List< Pair<scalar> >& normDist = normDistribution[cmpt];
|
||||||
|
|
||||||
|
if (normDist.size())
|
||||||
|
{
|
||||||
|
if (normDist.size() == 1)
|
||||||
|
{
|
||||||
|
setComponent(medianValue, cmpt) = normDist[0].first();
|
||||||
|
}
|
||||||
|
else if
|
||||||
|
(
|
||||||
|
normDist.size() > 1
|
||||||
|
&& normDist[0].second()*component(binWidth_, cmpt) > 0.5
|
||||||
|
)
|
||||||
|
{
|
||||||
|
scalar xk =
|
||||||
|
normDist[0].first()
|
||||||
|
+ 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
scalar xkm1 =
|
||||||
|
normDist[0].first()
|
||||||
|
- 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
scalar Sk = (normDist[0].second())*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
setComponent(medianValue, cmpt) = 0.5*(xk - xkm1)/(Sk) + xkm1;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
label previousNonZeroIndex = 0;
|
||||||
|
|
||||||
|
scalar cumulative = 0.0;
|
||||||
|
|
||||||
|
forAll(normDist, nD)
|
||||||
|
{
|
||||||
|
if
|
||||||
|
(
|
||||||
|
cumulative
|
||||||
|
+ (normDist[nD].second()*component(binWidth_, cmpt))
|
||||||
|
> 0.5
|
||||||
|
)
|
||||||
|
{
|
||||||
|
scalar xk =
|
||||||
|
normDist[nD].first()
|
||||||
|
+ 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
scalar xkm1 =
|
||||||
|
normDist[previousNonZeroIndex].first()
|
||||||
|
+ 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
scalar Sk =
|
||||||
|
cumulative
|
||||||
|
+ (normDist[nD].second()*component(binWidth_, cmpt));
|
||||||
|
|
||||||
|
scalar Skm1 = cumulative;
|
||||||
|
|
||||||
|
setComponent(medianValue, cmpt) =
|
||||||
|
(0.5 - Skm1)*(xk - xkm1)/(Sk - Skm1) + xkm1;
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else if (mag(normDist[nD].second()) > VSMALL)
|
||||||
|
{
|
||||||
|
cumulative +=
|
||||||
|
normDist[nD].second()*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
previousNonZeroIndex = nD;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return medianValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
void Foam::Distribution<Type>::add
|
||||||
|
(
|
||||||
|
const Type& valueToAdd,
|
||||||
|
const Type& weight
|
||||||
|
)
|
||||||
|
{
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
label n =
|
||||||
|
label(component(valueToAdd, cmpt)/component(binWidth_, cmpt))
|
||||||
|
- label(neg(component(valueToAdd, cmpt)/component(binWidth_, cmpt)));
|
||||||
|
|
||||||
|
label listIndex = index(cmpt, n);
|
||||||
|
|
||||||
|
cmptDistribution[listIndex] += component(weight, cmpt);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::List< Foam::List< Foam::Pair<Foam::scalar> > >Foam::
|
||||||
|
Distribution<Type>::normalised() const
|
||||||
|
{
|
||||||
|
List< List < Pair<scalar> > > normDistribution(pTraits<Type>::nComponents);
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
if (cmptDistribution.empty())
|
||||||
|
{
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
scalar totalCmptWeight = totalWeight(cmpt);
|
||||||
|
|
||||||
|
List<label> cmptKeys = keys(cmpt);
|
||||||
|
|
||||||
|
List< Pair<scalar> >& normDist = normDistribution[cmpt];
|
||||||
|
|
||||||
|
Pair<label> limits = validLimits(cmpt);
|
||||||
|
|
||||||
|
normDist.setSize(limits.second() - limits.first() + 1);
|
||||||
|
|
||||||
|
for
|
||||||
|
(
|
||||||
|
label k = limits.first(), i = 0;
|
||||||
|
k <= limits.second();
|
||||||
|
k++, i++
|
||||||
|
)
|
||||||
|
{
|
||||||
|
label key = cmptKeys[k];
|
||||||
|
|
||||||
|
normDist[i].first() =
|
||||||
|
(0.5 + scalar(key))*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
normDist[i].second() =
|
||||||
|
cmptDistribution[k]
|
||||||
|
/totalCmptWeight
|
||||||
|
/component(binWidth_, cmpt);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return normDistribution;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::List< Foam::List< Foam::Pair<Foam::scalar> > >Foam::
|
||||||
|
Distribution<Type>::raw() const
|
||||||
|
{
|
||||||
|
List< List < Pair<scalar> > > rawDistribution(pTraits<Type>::nComponents);
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List<scalar>& cmptDistribution = (*this)[cmpt];
|
||||||
|
|
||||||
|
if (cmptDistribution.empty())
|
||||||
|
{
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
List<label> cmptKeys = keys(cmpt);
|
||||||
|
|
||||||
|
List< Pair<scalar> >& rawDist = rawDistribution[cmpt];
|
||||||
|
|
||||||
|
Pair<label> limits = validLimits(cmpt);
|
||||||
|
|
||||||
|
rawDist.setSize(limits.second() - limits.first() + 1);
|
||||||
|
|
||||||
|
for
|
||||||
|
(
|
||||||
|
label k = limits.first(), i = 0;
|
||||||
|
k <= limits.second();
|
||||||
|
k++, i++
|
||||||
|
)
|
||||||
|
{
|
||||||
|
label key = cmptKeys[k];
|
||||||
|
|
||||||
|
rawDist[i].first() = (0.5 + scalar(key))*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
rawDist[i].second() = cmptDistribution[k];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return rawDistribution;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::List< Foam::List< Foam::Pair<Foam::scalar> > >Foam::
|
||||||
|
Distribution<Type>::cumulativeNormalised() const
|
||||||
|
{
|
||||||
|
List< List< Pair<scalar> > > normalisedDistribution = normalised();
|
||||||
|
|
||||||
|
List< List < Pair<scalar> > > cumulativeNormalisedDistribution =
|
||||||
|
normalisedDistribution;
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List< Pair<scalar> >& normalisedCmpt =
|
||||||
|
normalisedDistribution[cmpt];
|
||||||
|
|
||||||
|
List< Pair<scalar> >& cumNormalisedCmpt =
|
||||||
|
cumulativeNormalisedDistribution[cmpt];
|
||||||
|
|
||||||
|
scalar sum = 0.0;
|
||||||
|
|
||||||
|
forAll(normalisedCmpt, i)
|
||||||
|
{
|
||||||
|
cumNormalisedCmpt[i].first() =
|
||||||
|
normalisedCmpt[i].first()
|
||||||
|
+ 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
cumNormalisedCmpt[i].second() =
|
||||||
|
normalisedCmpt[i].second()*component(binWidth_, cmpt) + sum;
|
||||||
|
|
||||||
|
sum = cumNormalisedCmpt[i].second();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return cumulativeNormalisedDistribution;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::List< Foam::List< Foam::Pair<Foam::scalar> > >Foam::
|
||||||
|
Distribution<Type>::cumulativeRaw() const
|
||||||
|
{
|
||||||
|
List< List< Pair<scalar> > > rawDistribution = raw();
|
||||||
|
|
||||||
|
List< List < Pair<scalar> > > cumulativeRawDistribution = rawDistribution;
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List< Pair<scalar> >& rawCmpt = rawDistribution[cmpt];
|
||||||
|
|
||||||
|
List< Pair<scalar> >& cumRawCmpt = cumulativeRawDistribution[cmpt];
|
||||||
|
|
||||||
|
scalar sum = 0.0;
|
||||||
|
|
||||||
|
forAll(rawCmpt, i)
|
||||||
|
{
|
||||||
|
cumRawCmpt[i].first() =
|
||||||
|
rawCmpt[i].first()
|
||||||
|
+ 0.5*component(binWidth_, cmpt);
|
||||||
|
|
||||||
|
cumRawCmpt[i].second() = rawCmpt[i].second() + sum;
|
||||||
|
|
||||||
|
sum = cumRawCmpt[i].second();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return cumulativeRawDistribution;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
void Foam::Distribution<Type>::clear()
|
||||||
|
{
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
(*this)[cmpt].clear();
|
||||||
|
|
||||||
|
listStarts_[cmpt] = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
void Foam::Distribution<Type>::write(const fileName& filePrefix) const
|
||||||
|
{
|
||||||
|
List< List< Pair<scalar> > > rawDistribution = raw();
|
||||||
|
|
||||||
|
List< List < Pair<scalar> > > normDistribution = normalised();
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List< Pair<scalar> >& rawPairs = rawDistribution[cmpt];
|
||||||
|
|
||||||
|
const List< Pair<scalar> >& normPairs = normDistribution[cmpt];
|
||||||
|
|
||||||
|
OFstream os(filePrefix + '_' + pTraits<Type>::componentNames[cmpt]);
|
||||||
|
|
||||||
|
os << "# key normalised raw" << endl;
|
||||||
|
|
||||||
|
forAll(normPairs, i)
|
||||||
|
{
|
||||||
|
os << normPairs[i].first()
|
||||||
|
<< ' ' << normPairs[i].second()
|
||||||
|
<< ' ' << rawPairs[i].second()
|
||||||
|
<< nl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
List< List< Pair<scalar> > > rawCumDist = cumulativeRaw();
|
||||||
|
|
||||||
|
List< List < Pair<scalar> > > normCumDist = cumulativeNormalised();
|
||||||
|
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
const List< Pair<scalar> >& rawPairs = rawCumDist[cmpt];
|
||||||
|
|
||||||
|
const List< Pair<scalar> >& normPairs = normCumDist[cmpt];
|
||||||
|
|
||||||
|
OFstream os
|
||||||
|
(
|
||||||
|
filePrefix + "_cumulative_" + pTraits<Type>::componentNames[cmpt]
|
||||||
|
);
|
||||||
|
|
||||||
|
os << "# key normalised raw" << endl;
|
||||||
|
|
||||||
|
forAll(normPairs, i)
|
||||||
|
{
|
||||||
|
os << normPairs[i].first()
|
||||||
|
<< ' ' << normPairs[i].second()
|
||||||
|
<< ' ' << rawPairs[i].second()
|
||||||
|
<< nl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
void Foam::Distribution<Type>::operator=
|
||||||
|
(
|
||||||
|
const Distribution<Type>& rhs
|
||||||
|
)
|
||||||
|
{
|
||||||
|
// Check for assignment to self
|
||||||
|
if (this == &rhs)
|
||||||
|
{
|
||||||
|
FatalErrorIn
|
||||||
|
(
|
||||||
|
"Foam::Distribution<Type>::operator="
|
||||||
|
"(const Foam::Distribution<Type>&)"
|
||||||
|
) << "Attempted assignment to self"
|
||||||
|
<< abort(FatalError);
|
||||||
|
}
|
||||||
|
|
||||||
|
List< List<scalar> >::operator=(rhs);
|
||||||
|
|
||||||
|
binWidth_ = rhs.binWidth();
|
||||||
|
|
||||||
|
listStarts_ = rhs.listStarts();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * Friend Operators * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template <class Type>
|
||||||
|
Foam::Istream& Foam::operator>>
|
||||||
|
(
|
||||||
|
Istream& is,
|
||||||
|
Distribution<Type>& d
|
||||||
|
)
|
||||||
|
{
|
||||||
|
is >> static_cast<List< List<scalar> >&>(d)
|
||||||
|
>> d.binWidth_
|
||||||
|
>> d.listStarts_;
|
||||||
|
|
||||||
|
// Check state of Istream
|
||||||
|
is.check("Istream& operator>>(Istream&, Distribution<Type>&)");
|
||||||
|
|
||||||
|
return is;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Foam::Ostream& Foam::operator<<
|
||||||
|
(
|
||||||
|
Ostream& os,
|
||||||
|
const Distribution<Type>& d
|
||||||
|
)
|
||||||
|
{
|
||||||
|
os << static_cast<const List< List<scalar> >& >(d)
|
||||||
|
<< d.binWidth_ << token::SPACE
|
||||||
|
<< d.listStarts_;
|
||||||
|
|
||||||
|
// Check state of Ostream
|
||||||
|
os.check("Ostream& operator<<(Ostream&, " "const Distribution&)");
|
||||||
|
|
||||||
|
return os;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * Global Operators * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template <class Type>
|
||||||
|
Foam::Distribution<Type> Foam::operator+
|
||||||
|
(
|
||||||
|
const Distribution<Type>& d1,
|
||||||
|
const Distribution<Type>& d2
|
||||||
|
)
|
||||||
|
{
|
||||||
|
// The coarsest binWidth is the sensible choice
|
||||||
|
Distribution<Type> d(max(d1.binWidth(), d2.binWidth()));
|
||||||
|
|
||||||
|
List< List< List < Pair<scalar> > > > rawDists(2);
|
||||||
|
|
||||||
|
rawDists[0] = d1.raw();
|
||||||
|
rawDists[1] = d2.raw();
|
||||||
|
|
||||||
|
forAll(rawDists, rDI)
|
||||||
|
{
|
||||||
|
for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
|
||||||
|
{
|
||||||
|
List<scalar>& cmptDistribution = d[cmpt];
|
||||||
|
|
||||||
|
const List < Pair<scalar> >& cmptRaw = rawDists[rDI][cmpt];
|
||||||
|
|
||||||
|
forAll(cmptRaw, rI)
|
||||||
|
{
|
||||||
|
scalar valueToAdd = cmptRaw[rI].first();
|
||||||
|
scalar cmptWeight = cmptRaw[rI].second();
|
||||||
|
|
||||||
|
label n =
|
||||||
|
label
|
||||||
|
(
|
||||||
|
component(valueToAdd, cmpt)
|
||||||
|
/component(d.binWidth(), cmpt)
|
||||||
|
)
|
||||||
|
- label
|
||||||
|
(
|
||||||
|
neg(component(valueToAdd, cmpt)
|
||||||
|
/component(d.binWidth(), cmpt))
|
||||||
|
);
|
||||||
|
|
||||||
|
label listIndex = d.index(cmpt, n);
|
||||||
|
|
||||||
|
cmptDistribution[listIndex] += cmptWeight;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Distribution<Type>(d);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
207
src/OpenFOAM/containers/Lists/Distribution/Distribution.H
Normal file
207
src/OpenFOAM/containers/Lists/Distribution/Distribution.H
Normal file
@ -0,0 +1,207 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2009-2011 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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 "List.H"
|
||||||
|
#include "Pair.H"
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
namespace Foam
|
||||||
|
{
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
class Distribution;
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Istream& operator>>(Istream&, Distribution<Type>&);
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Ostream& operator<<(Ostream&, const Distribution<Type>&);
|
||||||
|
|
||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
Class Distribution Declaration
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
class Distribution
|
||||||
|
:
|
||||||
|
public List< List<scalar> >
|
||||||
|
{
|
||||||
|
// Private data
|
||||||
|
|
||||||
|
//- Width of the bin for each component
|
||||||
|
Type binWidth_;
|
||||||
|
|
||||||
|
//- The start bin index of each component
|
||||||
|
List<label> listStarts_;
|
||||||
|
|
||||||
|
|
||||||
|
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 as copy
|
||||||
|
Distribution(const Distribution& d);
|
||||||
|
|
||||||
|
|
||||||
|
//- Destructor
|
||||||
|
~Distribution();
|
||||||
|
|
||||||
|
// Member Functions
|
||||||
|
|
||||||
|
//- Sum the total weight added to the component in the
|
||||||
|
// argument
|
||||||
|
scalar totalWeight(direction cmpt) const;
|
||||||
|
|
||||||
|
List<label> keys(direction cmpt) const;
|
||||||
|
|
||||||
|
//- Return the appropriate List index for the given bin index.
|
||||||
|
// Resizes the List if required
|
||||||
|
label index(direction cmpt, label n);
|
||||||
|
|
||||||
|
//- Returns the indices of the first and last non-zero entries
|
||||||
|
Pair<label> validLimits(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() const;
|
||||||
|
|
||||||
|
//- Add a value to the distribution, optionally specifying a weight
|
||||||
|
void add
|
||||||
|
(
|
||||||
|
const Type& valueToAdd,
|
||||||
|
const Type& weight = pTraits<Type>::one
|
||||||
|
);
|
||||||
|
|
||||||
|
//- Return the normalised distribution (probability density)
|
||||||
|
// and bins
|
||||||
|
List< List<Pair<scalar> > > normalised() const;
|
||||||
|
|
||||||
|
//- Return the distribution of the total bin weights
|
||||||
|
List< List < Pair<scalar> > > raw() const;
|
||||||
|
|
||||||
|
//- Return the cumulative normalised distribution and
|
||||||
|
// integration locations (at end of bins)
|
||||||
|
List< List<Pair<scalar> > > cumulativeNormalised() const;
|
||||||
|
|
||||||
|
//- Return the cumulative total bin weights and integration
|
||||||
|
// locations (at end of bins)
|
||||||
|
List< List<Pair<scalar> > > cumulativeRaw() const;
|
||||||
|
|
||||||
|
//- Resets the Distribution by clearing the stored lists.
|
||||||
|
// Leaves the same number of them and the same binWidth.
|
||||||
|
void clear();
|
||||||
|
|
||||||
|
|
||||||
|
// Access
|
||||||
|
|
||||||
|
//- Return the bin width
|
||||||
|
inline const Type& binWidth() const;
|
||||||
|
|
||||||
|
//- Return the List start bin indices
|
||||||
|
inline const List<label>& listStarts() const;
|
||||||
|
|
||||||
|
// Write
|
||||||
|
|
||||||
|
//- Write the distribution to file: key normalised raw.
|
||||||
|
// Produces a separate file for each component.
|
||||||
|
void write(const fileName& filePrefix) const;
|
||||||
|
|
||||||
|
|
||||||
|
// Member Operators
|
||||||
|
|
||||||
|
void operator=(const Distribution<Type>&);
|
||||||
|
|
||||||
|
// IOstream Operators
|
||||||
|
|
||||||
|
friend Istream& operator>> <Type>
|
||||||
|
(
|
||||||
|
Istream&,
|
||||||
|
Distribution<Type>&
|
||||||
|
);
|
||||||
|
|
||||||
|
friend Ostream& operator<< <Type>
|
||||||
|
(
|
||||||
|
Ostream&,
|
||||||
|
const Distribution<Type>&
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * Global Operators * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
Distribution<Type> operator+
|
||||||
|
(
|
||||||
|
const Distribution<Type>&,
|
||||||
|
const Distribution<Type>&
|
||||||
|
);
|
||||||
|
|
||||||
|
|
||||||
|
} // End namespace Foam
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
#include "DistributionI.H"
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
#ifdef NoRepository
|
||||||
|
# include "Distribution.C"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
46
src/OpenFOAM/containers/Lists/Distribution/DistributionI.H
Normal file
46
src/OpenFOAM/containers/Lists/Distribution/DistributionI.H
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
/*---------------------------------------------------------------------------*\
|
||||||
|
========= |
|
||||||
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
|
\\ / O peration |
|
||||||
|
\\ / A nd | Copyright (C) 2009-2011 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
inline const Type& Foam::Distribution<Type>::binWidth() const
|
||||||
|
{
|
||||||
|
return binWidth_;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
template<class Type>
|
||||||
|
inline const
|
||||||
|
Foam::List<Foam::label>& Foam::Distribution<Type>::listStarts() const
|
||||||
|
{
|
||||||
|
return listStarts_;
|
||||||
|
}
|
||||||
|
|
||||||
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
|
|
||||||
|
// ************************************************************************* //
|
||||||
Loading…
Reference in New Issue
Block a user