distribution Class Reference

Accumulating histogram of values. Specified bin resolution automatic generation of bins. More...

Inheritance diagram for distribution:

Collaboration diagram for distribution:

Public Member Functions
	TypeName ("distribution")
	distribution ()
	distribution (const scalar binWidth)
	distribution (const distribution &)
virtual	~distribution ()
label	totalEntries () const
scalar	approxTotalEntries () const
scalar	mean () const
scalar	median ()
void	add (const scalar valueToAdd)
void	add (const label valueToAdd)
void	insertMissingKeys ()
List< Pair< scalar > >	normalised ()
List< Pair< scalar > >	normalisedMinusMean ()
List< Pair< scalar > >	normalisedShifted (scalar shiftValue)
List< Pair< scalar > >	raw ()
scalar	binWidth () const
void	operator= (const distribution &)
Public Member Functions inherited from Map< label >
	Map ()
	Map (const label size)
	Map (Istream &is)
	Map (const this_type &map)
	Map (this_type &&map)
	Map (std::initializer_list< std::pair< label, T >> map)
void	operator= (const this_type &rhs)
void	operator= (this_type &&rhs)
void	operator= (const this_type &rhs)
void	operator= (std::initializer_list< std::pair< Key, T >> rhs)
void	operator= (this_type &&rhs)

Static Public Member Functions
static void	write (const fileName &file, const List< Pair< scalar >> &pairs)

Friends
Ostream &	operator<< (Ostream &, const distribution &)

Additional Inherited Members
Public Types inherited from Map< label >
typedef Map< T >	this_type
typedef HashTable< T, label, Hash< label > >	parent_type
using	iterator = typename parent_type::iterator
using	const_iterator = typename parent_type::const_iterator

Detailed Description

Accumulating histogram of values. Specified bin resolution automatic generation of bins.

Source files

• distribution.H
• distributionI.H
• distribution.C

Definition at line 57 of file distribution.H.

Constructor & Destructor Documentation

distribution() [1/3]

distribution

(

)

Definition at line 51 of file distribution.C.

distribution() [2/3]

distribution

(

const scalar

binWidth

)

Definition at line 58 of file distribution.C.

distribution() [3/3]

distribution

(

const distribution &

d

)

Definition at line 65 of file distribution.C.

~distribution()

~distribution ( )

virtual

Definition at line 74 of file distribution.C.

Member Function Documentation

TypeName()

TypeName

(

"distribution"

)

write()

void write ( const fileName &  file, const List< Pair< scalar >> &  pairs  )

static

Definition at line 35 of file distribution.C.

References forAll, Foam::nl, and os().

Here is the call graph for this function:

totalEntries()

Foam::label totalEntries

(

)

const

Definition at line 80 of file distribution.C.

References Foam::endl(), forAllConstIters(), and WarningInFunction.

Here is the call graph for this function:

approxTotalEntries()

Foam::scalar approxTotalEntries

(

)

const

Definition at line 108 of file distribution.C.

References forAllConstIters().

Here is the call graph for this function:

mean()

Foam::scalar mean

(

)

const

Definition at line 121 of file distribution.C.

References forAll, k, and Foam::glTF::key().

Here is the call graph for this function:

median()

Foam::scalar median

(

)

Definition at line 144 of file distribution.C.

References forAll, and Foam::normalised().

Here is the call graph for this function:

add() [1/2]

void add

(

const scalar

valueToAdd

)

Definition at line 208 of file distribution.C.

References Foam::abort(), stdFoam::begin(), stdFoam::end(), Foam::FatalError, FatalErrorInFunction, Foam::ListOps::find(), insert(), n, and Foam::neg().

Here is the call graph for this function:

add() [2/2]

void add

(

const label

valueToAdd

)

Definition at line 238 of file distribution.C.

References Foam::add().

Here is the call graph for this function:

insertMissingKeys()

void insertMissingKeys

(

)

Definition at line 244 of file distribution.C.

References insert(), and k.

Here is the call graph for this function:

normalised()

Foam::List< Foam::Pair< Foam::scalar > > normalised

(

)

Definition at line 259 of file distribution.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, k, and Foam::glTF::key().

Here is the call graph for this function:

normalisedMinusMean()

Foam::List< Foam::Pair< Foam::scalar > > normalisedMinusMean

(

)

Definition at line 286 of file distribution.C.

normalisedShifted()

Foam::List< Foam::Pair< Foam::scalar > > normalisedShifted

(

scalar

shiftValue

)

Definition at line 293 of file distribution.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, Foam::nl, Foam::normalised(), and Foam::sign().

Here is the call graph for this function:

raw()

Foam::List< Foam::Pair< Foam::scalar > > raw

(

)

Definition at line 404 of file distribution.C.

References forAll, k, and Foam::glTF::key().

Here is the call graph for this function:

binWidth()

Foam::scalar binWidth ( ) const

inline

Definition at line 23 of file distributionI.H.

Referenced by distribution::operator=().

Here is the caller graph for this function:

operator=()

void operator=

(

const distribution &

rhs

)

Definition at line 426 of file distribution.C.

References distribution::binWidth(), and Map::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

Ostream& operator<< ( Ostream &  , const distribution &    )

friend

---

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