QUESO::UniformOneDGrid< T > Class Template Reference

Class for accommodating uniform one-dimensional grids. More...

#include <UniformOneDGrid.h>

Inheritance diagram for QUESO::UniformOneDGrid< T >:

Public Member Functions
Constructor/Destructor methods
	UniformOneDGrid (const BaseEnvironment &env, const char *prefix, unsigned int size, T minPosition, T maxPosition)
	Default constructor. More...
	~UniformOneDGrid ()
	Destructor. More...
Accessor methods
T	operator[] (unsigned int i) const
	Returns the position of the i-th point in the grid. More...
Mathematical methods
unsigned int	size () const
	Grid size; the amount of points that defines the grid. More...
unsigned int	findIntervalId (const T &paramValue) const
	Finds the ID of an interval. See template specialization. More...
Public Member Functions inherited from QUESO::BaseOneDGrid< T >
	BaseOneDGrid (const BaseEnvironment &env, const char *prefix)
	Default constructor. More...
virtual	~BaseOneDGrid ()
	Virtual destructor. More...
void	print (std::ostream &ofsvar) const
	Prints the values of the grid points. More...

Protected Attributes
unsigned int	m_size
T	m_minPosition
T	m_maxPosition
Protected Attributes inherited from QUESO::BaseOneDGrid< T >
const BaseEnvironment &	m_env
std::string	m_prefix

Detailed Description

template<class T>
class QUESO::UniformOneDGrid< T >

Class for accommodating uniform one-dimensional grids.

Definition at line 41 of file UniformOneDGrid.h.

Constructor & Destructor Documentation

template<class T >

QUESO::UniformOneDGrid< T >::UniformOneDGrid	(	const BaseEnvironment &	env,
		const char *	prefix,
		unsigned int	size,
		T	minPosition,
		T	maxPosition
	)

Default constructor.

Constructs a uniform 1D grid between minPosition and maxPosition, with size points.

Definition at line 31 of file UniformOneDGrid.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseOneDGrid< T >::m_env, QUESO::BaseOneDGrid< T >::m_prefix, and QUESO::BaseEnvironment::subDisplayFile().

  :
  BaseOneDGrid<T>(env,prefix),
  m_size       (size),
  m_minPosition(minPosition),
  m_maxPosition(maxPosition)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering UniformOneDGrid<T>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Leaving UniformOneDGrid<T>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }
}

template<class T >

QUESO::UniformOneDGrid< T >::~UniformOneDGrid

(

)

Destructor.

Definition at line 57 of file UniformOneDGrid.C.

{
}

Member Function Documentation

template<class T >

unsigned int QUESO::UniformOneDGrid< T >::findIntervalId ( const T &  paramValue ) const

virtual

Finds the ID of an interval. See template specialization.

This function finds to which interval the parameter value belongs to.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 81 of file UniformOneDGrid.C.

{
  queso_require_msg(!((paramValue < m_minPosition) || (m_maxPosition < paramValue)), "paramValue is out of domain");

  T ratio = (paramValue - m_minPosition)/(m_maxPosition - m_minPosition);
  unsigned int i = (unsigned int) (ratio*(m_size-1.));
  if ((i > 0                  ) &&
      ((*this)[i] > paramValue)) {
    i--;
  }

  return i;
}

template<class T >

T QUESO::UniformOneDGrid< T >::operator[] ( unsigned int  i ) const

virtual

Returns the position of the i-th point in the grid.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 70 of file UniformOneDGrid.C.

{
  queso_require_less_msg(i, m_size, "too large i");

  T ratio = ((T) i)/(((T)m_size)-1.); // IMPORTANT: Yes, '-1.'
  T position = (1.-ratio)*m_minPosition + ratio*m_maxPosition;
  return position;
}

template<class T >

unsigned int QUESO::UniformOneDGrid< T >::size ( ) const

virtual

Grid size; the amount of points that defines the grid.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 63 of file UniformOneDGrid.C.

{
  return m_size;
}

Member Data Documentation

template<class T>

T QUESO::UniformOneDGrid< T >::m_maxPosition

protected

Definition at line 78 of file UniformOneDGrid.h.

template<class T>

T QUESO::UniformOneDGrid< T >::m_minPosition

protected

Definition at line 77 of file UniformOneDGrid.h.

template<class T>

unsigned int QUESO::UniformOneDGrid< T >::m_size

protected

Definition at line 76 of file UniformOneDGrid.h.

---

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

• src/misc/inc/UniformOneDGrid.h
• src/misc/src/UniformOneDGrid.C