plb::MaskedBoxScalarAverageFunctional3D< T > Class Template Reference

#include <dataAnalysisFunctional3D.h>

Inheritance diagram for plb::MaskedBoxScalarAverageFunctional3D< T >:

[legend]

Collaboration diagram for plb::MaskedBoxScalarAverageFunctional3D< T >:

[legend]

List of all members.

Public Member Functions
	MaskedBoxScalarAverageFunctional3D (int flag_)
virtual void	process (Box3D domain, ScalarField3D< T > &scalarField, ScalarField3D< int > &mask)
virtual MaskedBoxScalarAverageFunctional3D < T > *	clone () const
virtual void	getTypeOfModification (std::vector< modif::ModifT > &modified) const
T	getAverageScalar () const

---

Detailed Description

template<typename T>
class plb::MaskedBoxScalarAverageFunctional3D< T >

Attention: No matter what the type of T is (even if it is an integer type), the average is computed in double-precision floating point numbers, and converted to T at the end (and rounded, if T is an integer).

---

Constructor & Destructor Documentation

template<typename T >

plb::MaskedBoxScalarAverageFunctional3D< T >::MaskedBoxScalarAverageFunctional3D

(

int

flag_

)

[inline]

---

Member Function Documentation

template<typename T >

MaskedBoxScalarAverageFunctional3D< T > * plb::MaskedBoxScalarAverageFunctional3D< T >::clone

(

)

const [inline, virtual]

Implements plb::ReductiveBoxProcessingFunctional3D.

template<typename T >

T plb::MaskedBoxScalarAverageFunctional3D< T >::getAverageScalar

(

)

const [inline]

References plb::BlockStatistics::getAverage(), plb::PlainReductiveBoxProcessingFunctional3D::getStatistics(), and plb::util::roundToInt().

Referenced by plb::computeAverage().

template<typename T>

virtual void plb::MaskedBoxScalarAverageFunctional3D< T >::getTypeOfModification

(

std::vector< modif::ModifT > &

modified

)

const [inline, virtual]

Implements plb::ReductiveBoxProcessingFunctional3D.

References plb::modif::nothing.

template<typename T >

void plb::MaskedBoxScalarAverageFunctional3D< T >::process	(	Box3D	domain,
		ScalarField3D< T > &	scalarField,
		ScalarField3D< int > &	mask
	)			[inline, virtual]

Implements plb::ReductiveBoxProcessingFunctional3D_SS< T, int >.

References plb::computeRelativeDisplacement(), plb::BlockStatistics::gatherAverage(), plb::ScalarField3D< T >::get(), plb::PlainReductiveBoxProcessingFunctional3D::getStatistics(), plb::BlockStatistics::incrementStats(), plb::Dot3D::x, plb::Box3D::x0, plb::Box3D::x1, plb::Dot3D::y, plb::Box3D::y0, plb::Box3D::y1, plb::Dot3D::z, plb::Box3D::z0, and plb::Box3D::z1.

---

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

• dataAnalysisFunctional3D.h
• dataAnalysisFunctional3D.hh