QUESO::BaseOneDGrid< T > Class Template Reference

Base class for accommodating one-dimensional grids. More...

#include <OneDGrid.h>

Inheritance diagram for QUESO::BaseOneDGrid< T >:

Public Member Functions
Constructor/Destructor methods
	BaseOneDGrid (const BaseEnvironment &env, const char *prefix)
	Default constructor. More...
virtual	~BaseOneDGrid ()
	Virtual destructor. More...
Accessor methods
virtual T	operator[] (unsigned int i) const =0
	Returns the position of the i-th point in the grid. See template specialization. More...
Mathematical methods
virtual unsigned int	size () const =0
	Grid size; the amount of points which defines the grid. See template specialization. More...
virtual unsigned int	findIntervalId (const T &paramValue) const =0
	Finds the ID of an interval. See template specialization. More...

Protected Attributes
const BaseEnvironment &	m_env
std::string	m_prefix

I/O methods
void	print (std::ostream &ofsvar) const
	Prints the values of the grid points. More...
std::ostream &	operator<< (std::ostream &os, const BaseOneDGrid< T > &obj)

Detailed Description

template<class T>
class QUESO::BaseOneDGrid< T >

Base class for accommodating one-dimensional grids.

Definition at line 46 of file OneDGrid.h.

Constructor & Destructor Documentation

template<class T >

QUESO::BaseOneDGrid< T >::BaseOneDGrid	(	const BaseEnvironment &	env,
		const char *	prefix
	)

Default constructor.

Definition at line 30 of file OneDGrid.C.

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

  :
  m_env   (env),
  m_prefix((std::string)(prefix)+"grid")
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering BaseOneDGrid<T>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }

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

template<class T >

QUESO::BaseOneDGrid< T >::~BaseOneDGrid ( )

virtual

Virtual destructor.

Definition at line 51 of file OneDGrid.C.

{
}

Member Function Documentation

template<class T>

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

pure virtual

Finds the ID of an interval. See template specialization.

Implemented in QUESO::StdOneDGrid< T >, and QUESO::UniformOneDGrid< T >.

template<class T>

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

pure virtual

Returns the position of the i-th point in the grid. See template specialization.

Implemented in QUESO::StdOneDGrid< T >, and QUESO::UniformOneDGrid< T >.

template<class T >

void QUESO::BaseOneDGrid< T >::print

(

std::ostream &

ofsvar

)

const

Prints the values of the grid points.

Definition at line 57 of file OneDGrid.C.

References QUESO::size.

{
  // Print values *of* grid points
  os << m_prefix << "_sub" << m_env.subIdString() << " = zeros(" << this->size()
     << ","                                                      << 1
     << ");"
     << std::endl;
  os << m_prefix << "_sub" << m_env.subIdString() << " = [";
  for (unsigned int j = 0; j < this->size(); ++j) {
    os << (*this)[j] << " ";
  }
  os << "];"
     << std::endl;

  return;
}

template<class T>

virtual unsigned int QUESO::BaseOneDGrid< T >::size ( ) const

pure virtual

Grid size; the amount of points which defines the grid. See template specialization.

Implemented in QUESO::StdOneDGrid< T >, and QUESO::UniformOneDGrid< T >.

Friends And Related Function Documentation

template<class T>

std::ostream& operator<< ( std::ostream &  os, const BaseOneDGrid< T > &  obj  )

friend

Definition at line 73 of file OneDGrid.h.

  {
    obj.print(os);
    return os;
  }

Member Data Documentation

template<class T>

const BaseEnvironment& QUESO::BaseOneDGrid< T >::m_env

protected

Definition at line 82 of file OneDGrid.h.

Referenced by QUESO::BaseOneDGrid< T >::BaseOneDGrid(), QUESO::StdOneDGrid< T >::StdOneDGrid(), and QUESO::UniformOneDGrid< T >::UniformOneDGrid().

template<class T>

std::string QUESO::BaseOneDGrid< T >::m_prefix

protected

Definition at line 83 of file OneDGrid.h.

Referenced by QUESO::BaseOneDGrid< T >::BaseOneDGrid(), QUESO::StdOneDGrid< T >::StdOneDGrid(), and QUESO::UniformOneDGrid< T >::UniformOneDGrid().

---

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

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