plb::MultiGridStatSubscriber3D Class Reference

Handles statistics subscriptions for the MultiGridLattice3D. More...

#include <multiGrid3D.h>

Collaboration diagram for plb::MultiGridStatSubscriber3D:

[legend]

List of all members.

Public Member Functions
	MultiGridStatSubscriber3D (MultiGrid3D *multiGrid_)
	MultiGridStatSubscriber3D (MultiGridStatSubscriber3D const &rhs)
void	swap (MultiGridStatSubscriber3D &rhs)
MultiGridStatSubscriber3D &	operator= (MultiGridStatSubscriber3D const &rhs)
	Copy.
plint	subscribeAverage (plint dimDx, plint dimDt)
	Subscribe a new observable for which the average value is computed.
plint	subscribeSum (plint dimDx, plint dimDt)
	Subscribe a new observable for which the sum is computed.
plint	subscribeMax (plint dimDx, plint dimDt)
	Subscribe a new observable for which the maximum is computed.
plint	subscribeIntSum (plint dimDx, plint dimDt)
	Subscribe a new integer observable for which the sum is computed.
void	initialize ()
	Initialize the default subscriptions (rho, uSqr, et max uSqr).
std::vector< int > const &	getDimensionsX () const
	Retrieve the dimensions of dx and dt for all the components.
std::vector< int > const &	getDimensionsT () const

---

Detailed Description

Handles statistics subscriptions for the MultiGridLattice3D.

This class will provide the same functionalities as the MultiStatSubscriber3D, but each subscription comes with two parameters which will allow the rescaling of quantities among grids of different resolution.

---

Constructor & Destructor Documentation

plb::MultiGridStatSubscriber3D::MultiGridStatSubscriber3D

(

MultiGrid3D *

multiGrid_

)

plb::MultiGridStatSubscriber3D::MultiGridStatSubscriber3D

(

MultiGridStatSubscriber3D const &

rhs

)

---

Member Function Documentation

std::vector< int > const & plb::MultiGridStatSubscriber3D::getDimensionsT

(

)

const

Referenced by plb::MultiGrid3D::reduceStatistics().

std::vector< int > const & plb::MultiGridStatSubscriber3D::getDimensionsX

(

)

const

Retrieve the dimensions of dx and dt for all the components.

Referenced by plb::MultiGrid3D::reduceStatistics().

void plb::MultiGridStatSubscriber3D::initialize

(

)

Initialize the default subscriptions (rho, uSqr, et max uSqr).

initialize everything ONCE all the multi grid matrices have been created

This is necessary because the multiBlockLattice3D creates automatically the 3 statistics. It is not included in the constructor cause the multiBlockLattice3D might not be allocated.

References plb::MultiGrid3D::getInternalStatistics(), plb::BlockStatistics::subscribeAverage(), and plb::BlockStatistics::subscribeMax().

Referenced by plb::MultiGridLattice3D< T, Descriptor >::MultiGridLattice3D().

MultiGridStatSubscriber3D & plb::MultiGridStatSubscriber3D::operator=

(

MultiGridStatSubscriber3D const &

rhs

)

Copy.

plint plb::MultiGridStatSubscriber3D::subscribeAverage	(	plint	dimDx,
		plint	dimDt
	)

Subscribe a new observable for which the average value is computed.

References plb::MultiGrid3D::getComponent(), plb::MultiGrid3D::getInternalStatistics(), plb::MultiGrid3D::getNumLevels(), plb::MultiBlock3D::internalStatSubscription(), plb::BlockStatistics::subscribeAverage(), and plb::StatSubscriber::subscribeAverage().

plint plb::MultiGridStatSubscriber3D::subscribeIntSum	(	plint	dimDx,
		plint	dimDt
	)

Subscribe a new integer observable for which the sum is computed.

References plb::MultiGrid3D::getComponent(), plb::MultiGrid3D::getInternalStatistics(), plb::MultiGrid3D::getNumLevels(), plb::MultiBlock3D::internalStatSubscription(), plb::BlockStatistics::subscribeIntSum(), and plb::StatSubscriber::subscribeIntSum().

plint plb::MultiGridStatSubscriber3D::subscribeMax	(	plint	dimDx,
		plint	dimDt
	)

Subscribe a new observable for which the maximum is computed.

References plb::MultiGrid3D::getComponent(), plb::MultiGrid3D::getInternalStatistics(), plb::MultiGrid3D::getNumLevels(), plb::MultiBlock3D::internalStatSubscription(), plb::BlockStatistics::subscribeMax(), and plb::StatSubscriber::subscribeMax().

plint plb::MultiGridStatSubscriber3D::subscribeSum	(	plint	dimDx,
		plint	dimDt
	)

Subscribe a new observable for which the sum is computed.

References plb::MultiGrid3D::getComponent(), plb::MultiGrid3D::getInternalStatistics(), plb::MultiGrid3D::getNumLevels(), plb::MultiBlock3D::internalStatSubscription(), plb::BlockStatistics::subscribeSum(), and plb::StatSubscriber::subscribeSum().

void plb::MultiGridStatSubscriber3D::swap

(

MultiGridStatSubscriber3D &

rhs

)

In order to swap two MultiGridStatsSubscriber3D, we need to swap all the scale information (dx and dt) and the internal statistics of each block. The reference to each block does not change.

Referenced by plb::MultiGrid3D::swap().

---

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

• multiGrid3D.h
• multiGrid3D.cpp