$treeview $search $mathjax
Palabos  Version 1.1
$projectbrief
$projectbrief
$searchbox

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

Propose successive test values of a scalar (e.g. Re) to check stability of a system. More...

#include <benchmarkUtil.h>

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

List of all members.

Public Member Functions

 BisectStepper (T _iniVal, T _step=0.)
 The only constructor.
getVal (bool stable, bool doPrint=false)
 Get new value, and indicate if the previous value yielded a stable system or not.
bool hasConverged (T epsilon) const
 Test for convergence.

Detailed Description

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

Propose successive test values of a scalar (e.g. Re) to check stability of a system.

At first, the stability limit is explored by constant increments/decrements of the scalar, and then, by successive bisection.


Constructor & Destructor Documentation

template<typename T >
plb::util::BisectStepper< T >::BisectStepper ( _iniVal,
_step = 0. 
) [inline]

The only constructor.

Parameters:
_iniVal Initial guess for the stability limit.
_step Step size at which the value is initially incremented/decremented.

Member Function Documentation

template<typename T >
T plb::util::BisectStepper< T >::getVal ( bool  stable,
bool  doPrint = false 
) [inline]

Get new value, and indicate if the previous value yielded a stable system or not.

References plb::pcout.

template<typename T >
bool plb::util::BisectStepper< T >::hasConverged ( epsilon  )  const [inline]

Test for convergence.


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