ListBoxFactory< T > Class Template Reference

#include <ListBoxFactory.H>

Inheritance diagram for ListBoxFactory< T >:

[legend]

List of all members.

---

Detailed Description

template<class T>
class ListBoxFactory< T >

Factory class to produce one or more instances of ListBox on the same level. The mesh and ProblemDomain will be the same for all instances created by the factory. This is needed for LevelData construction.

Public Member Functions
	ListBoxFactory ()
	Weak constructor.
	ListBoxFactory (const RealVect &a_meshSpacing, const RealVect &a_origin)
	Constructor. Use these parameters for all manufactured ListBox instances.
	ListBoxFactory (const Real &a_meshSpacing)
void	define (const RealVect &a_meshSpacing, const RealVect &a_origin)
	Use these parameters for all manufactured ListBox instances.
virtual ListBox< T > *	create (const Box &a_box, int a_numComps, const DataIndex &a_datInd) const
	Factory function. Note that both a_numComps and a_dit are ignored.
virtual	~ListBoxFactory ()
	Destructor.
RealVect	meshSpacing () const
	Retrieve the cell size.
RealVect	origin () const
	Retrieve the origin.
Private Attributes
RealVect	m_mesh_spacing
	cell size in physical coordinates
RealVect	m_origin
	location in physical space of the lower corner of the 0 cell

---

Constructor & Destructor Documentation

template<class T>

ListBoxFactory< T >::ListBoxFactory

(

)

[inline]

Weak constructor.

template<class T>

ListBoxFactory< T >::ListBoxFactory	(	const RealVect &	a_meshSpacing,
		const RealVect &	a_origin
	)			[inline]

Constructor. Use these parameters for all manufactured ListBox instances.

References ListBoxFactory< T >::define().

template<class T>

ListBoxFactory< T >::ListBoxFactory

(

const Real &

a_meshSpacing

)

[inline]

Alternative constructor that assumes the mesh spacing is the same in all directions and that the domain offset is zero.

References ListBoxFactory< T >::define(), RealVect::Unit, and RealVect::Zero.

template<class T>

ListBoxFactory< T >::~ListBoxFactory

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<class T>

void ListBoxFactory< T >::define	(	const RealVect &	a_meshSpacing,
		const RealVect &	a_origin
	)			[inline]

Use these parameters for all manufactured ListBox instances.

References ListBoxFactory< T >::m_mesh_spacing, and ListBoxFactory< T >::m_origin.

Referenced by ParticleData< P >::define(), and ListBoxFactory< T >::ListBoxFactory().

template<class T>

ListBox< T > * ListBoxFactory< T >::create	(	const Box &	a_box,
		int	a_numComps,
		const DataIndex &	a_datInd
	)			const [inline, virtual]

Factory function. Note that both a_numComps and a_dit are ignored.

Implements DataFactory< ListBox< T > >.

References ListBoxFactory< T >::m_mesh_spacing, and ListBoxFactory< T >::m_origin.

Referenced by ParticleData< P >::allocateVector().

template<class T>

RealVect ListBoxFactory< T >::meshSpacing

(

)

const [inline]

Retrieve the cell size.

References ListBoxFactory< T >::m_mesh_spacing.

template<class T>

RealVect ListBoxFactory< T >::origin

(

)

const [inline]

Retrieve the origin.

References ListBoxFactory< T >::m_origin.

---

Member Data Documentation

template<class T>

RealVect ListBoxFactory< T >::m_mesh_spacing [private]

cell size in physical coordinates

Referenced by ListBoxFactory< T >::create(), ListBoxFactory< T >::define(), and ListBoxFactory< T >::meshSpacing().

template<class T>

RealVect ListBoxFactory< T >::m_origin [private]

location in physical space of the lower corner of the 0 cell

Referenced by ListBoxFactory< T >::create(), ListBoxFactory< T >::define(), and ListBoxFactory< T >::origin().

---

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

• ListBoxFactory.H
• ListBoxFactoryI.H