distribution Class Reference

#include <molecularMeasurements/distribution.H>

---

Detailed Description

Source files

• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distributionI.H
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.C

Definition at line 50 of file distribution.H.

Inheritance diagram for distribution:

Collaboration diagram for distribution:

List of all members.

Public Member Functions
	distribution ()
	Construct null.
	distribution (const scalar binWidth)
	Construct from binWidth.
	distribution (const distribution &)
	Construct as copy.
	~distribution ()
label	totalEntries () const
scalar	approxTotalEntries () const
scalar	mean () const
scalar	median ()
void	add (const scalar valueToAdd)
	Add a value to the appropriate bin of the distribution.
void	add (const label valueToAdd)
void	insertMissingKeys ()
List< Pair< scalar > >	normalised ()
List< Pair< scalar > >	normalisedMinusMean ()
List< Pair< scalar > >	normalisedShifted (const scalar shiftValue)
List< Pair< scalar > >	raw ()
scalar	binWidth () const
void	operator= (const distribution &)
Friends
Ostream &	operator<< (Ostream &, const distribution &)

---

Constructor & Destructor Documentation

distribution

(

)

Construct null.

Definition at line 33 of file distribution.C.

distribution

(

const scalar

binWidth  )

Construct from binWidth.

Definition at line 40 of file distribution.C.

distribution

(

const distribution &

d  )

Construct as copy.

Definition at line 47 of file distribution.C.

~distribution

(

)

Definition at line 56 of file distribution.C.

---

Member Function Documentation

label totalEntries

(

)

const

Definition at line 62 of file distribution.C.

References Foam::endl(), forAllConstIter, and WarningIn.

scalar approxTotalEntries

(

)

const

Definition at line 90 of file distribution.C.

References forAllConstIter.

Referenced by distribution::mean(), and distribution::normalised().

scalar mean

(

)

const

Definition at line 103 of file distribution.C.

References distribution::approxTotalEntries(), forAll, k(), and HashTable< label, label, Hash< label > >::toc().

Referenced by distribution::normalisedMinusMean().

scalar median

(

)

Definition at line 126 of file distribution.C.

References forAll, distribution::normalised(), and List< T >::size().

void add

(

const scalar

valueToAdd  )

Add a value to the appropriate bin of the distribution.

Definition at line 190 of file distribution.C.

References Foam::abort(), HashTable< label, label, Hash< label > >::begin(), HashTable< label, label, Hash< label > >::end(), Foam::FatalError, FatalErrorIn, HashTable< label, label, Hash< label > >::find(), HashTable< label, label, Hash< label > >::insert(), and Foam::neg().

Referenced by distribution::add().

void add

(

const label

valueToAdd  )

Definition at line 220 of file distribution.C.

References distribution::add().

void insertMissingKeys

(

)

Definition at line 226 of file distribution.C.

References HashTable< label, label, Hash< label > >::begin(), HashTable< label, label, Hash< label > >::end(), HashTable< label, label, Hash< label > >::find(), HashTable< label, label, Hash< label > >::insert(), k(), List< T >::size(), Foam::sort(), and HashTable< label, label, Hash< label > >::toc().

Referenced by distribution::normalised(), and distribution::raw().

List< Pair< scalar > > normalised

(

)

Definition at line 249 of file distribution.C.

References distribution::approxTotalEntries(), forAll, distribution::insertMissingKeys(), k(), HashTable< label, label, Hash< label > >::size(), Foam::sort(), and HashTable< label, label, Hash< label > >::toc().

Referenced by distribution::median(), and distribution::normalisedShifted().

List< Pair< scalar > > normalisedMinusMean

(

)

Definition at line 274 of file distribution.C.

References distribution::mean(), and distribution::normalisedShifted().

List< Pair< scalar > > normalisedShifted

(

const scalar

shiftValue  )

Definition at line 280 of file distribution.C.

References forAll, distribution::normalised(), Foam::sign(), and List< T >::size().

Referenced by distribution::normalisedMinusMean().

List< Pair< scalar > > raw

(

)

Definition at line 383 of file distribution.C.

References forAll, distribution::insertMissingKeys(), k(), HashTable< label, label, Hash< label > >::size(), Foam::sort(), and HashTable< label, label, Hash< label > >::toc().

Foam::scalar binWidth

(

)

const [inline]

Definition at line 28 of file distributionI.H.

Referenced by distribution::operator=().

void operator=

(

const distribution &

rhs  )

Definition at line 408 of file distribution.C.

References Foam::abort(), distribution::binWidth(), Foam::FatalError, and FatalErrorIn.

---

Friends And Related Function Documentation

Ostream& operator<<	(	Ostream &	os,
		const distribution &	d
	)		[friend]

Definition at line 426 of file distribution.C.

---

The documentation for this class was generated from the following files:

• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.C
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distributionI.H