plb::util::ValueTracer< T > Class Template Reference

Check time-convergence of a scalar. More...

#include <benchmarkUtil.h>

Collaboration diagram for plb::util::ValueTracer< T >:

[legend]

List of all members.

Public Member Functions
	ValueTracer (T u, T L, T epsilon)
	The only constructor.
void	resetScale (T u, T L)
	Change values of u and L to update characteristic scales of the system.
void	resetValues ()
	reinitializes the values
plint	getDeltaT () const
	Get characteristic time scale.
void	takeValue (T val, bool doPrint=false)
	Feed the object with a new measured scalar.
bool	hasConverged () const
	Test for convergence, with respect to stdDev.
bool	hasConvergedMinMax () const
	Test for convergence, with respect to difference between min and max value;.
T	computeAverage () const
T	computeStdDev (T average) const
void	setEpsilon (T epsilon_)

---

Detailed Description

template<typename T>
class plb::util::ValueTracer< T >

Check time-convergence of a scalar.

This class is useful, for example to check convergence of the velocity field for the simulation of a stationary flow. Convergence is claimed when the standard deviation of the monitored value is smaller than epsilon times the average. The statistics are taken over a macroscopic time scale of the system.

---

Constructor & Destructor Documentation

template<typename T >

plb::util::ValueTracer< T >::ValueTracer	(	T	u,
		T	L,
		T	epsilon
	)			[inline]

The only constructor.

Parameters:

	u	The characteristic velocity of the system, for computation of the characteristic time scale.
	L	The characteristic length of the system, for computation of the characteristic time scale.
	_epsilon	Precision of the convergence.

---

Member Function Documentation

template<typename T >

T plb::util::ValueTracer< T >::computeAverage

(

)

const [inline]

Referenced by plb::util::ValueTracer< T >::hasConverged(), plb::util::ValueTracer< T >::hasConvergedMinMax(), and plb::util::ValueTracer< T >::takeValue().

template<typename T >

T plb::util::ValueTracer< T >::computeStdDev

(

T

average

)

const [inline]

Referenced by plb::util::ValueTracer< T >::hasConverged(), and plb::util::ValueTracer< T >::takeValue().

template<typename T >

plint plb::util::ValueTracer< T >::getDeltaT

(

)

const [inline]

Get characteristic time scale.

template<typename T >

bool plb::util::ValueTracer< T >::hasConverged

(

)

const [inline]

Test for convergence, with respect to stdDev.

References plb::util::ValueTracer< T >::computeAverage(), plb::util::ValueTracer< T >::computeStdDev(), and plb::pcout.

template<typename T >

bool plb::util::ValueTracer< T >::hasConvergedMinMax

(

)

const [inline]

Test for convergence, with respect to difference between min and max value;.

References plb::util::ValueTracer< T >::computeAverage().

template<typename T >

void plb::util::ValueTracer< T >::resetScale	(	T	u,
		T	L
	)			[inline]

Change values of u and L to update characteristic scales of the system.

template<typename T >

void plb::util::ValueTracer< T >::resetValues

(

)

[inline]

reinitializes the values

template<typename T >

void plb::util::ValueTracer< T >::setEpsilon

(

T

epsilon_

)

[inline]

template<typename T >

void plb::util::ValueTracer< T >::takeValue	(	T	val,
		bool	doPrint = false
	)			[inline]

Feed the object with a new measured scalar.

References plb::util::ValueTracer< T >::computeAverage(), plb::util::ValueTracer< T >::computeStdDev(), and plb::pcout.

---

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

• benchmarkUtil.h
• benchmarkUtil.hh