Chombo + EB + MF  3.2
Public Member Functions | Private Attributes | List of all members
ListBoxFactory< T > Class Template Reference

#include <ListBoxFactory.H>

Inheritance diagram for ListBoxFactory< T >:
Inheritance graph
[legend]

Public Member Functions

 ListBoxFactory ()
 Weak constructor. More...
 
 ListBoxFactory (const RealVect &a_meshSpacing, const RealVect &a_origin)
 Constructor. Use these parameters for all manufactured ListBox instances. More...
 
 ListBoxFactory (const Real &a_meshSpacing)
 
void define (const RealVect &a_meshSpacing, const RealVect &a_origin)
 Use these parameters for all manufactured ListBox instances. More...
 
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. More...
 
virtual ~ListBoxFactory ()
 Destructor. More...
 
RealVect meshSpacing () const
 Retrieve the cell size. More...
 
RealVect origin () const
 Retrieve the origin. More...
 
- Public Member Functions inherited from DataFactory< ListBox< T > >
virtual ~DataFactory ()
 
virtual bool callDelete () const
 
virtual bool threadSafe () const
 

Private Attributes

RealVect m_mesh_spacing
 cell size in physical coordinates More...
 
RealVect m_origin
 location in physical space of the lower corner of the 0 cell More...
 

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.

Constructor & Destructor Documentation

◆ ListBoxFactory() [1/3]

template<class T >
ListBoxFactory< T >::ListBoxFactory ( )

Weak constructor.

◆ ListBoxFactory() [2/3]

template<class T >
ListBoxFactory< T >::ListBoxFactory ( const RealVect a_meshSpacing,
const RealVect a_origin 
)

Constructor. Use these parameters for all manufactured ListBox instances.

◆ ListBoxFactory() [3/3]

template<class T >
ListBoxFactory< T >::ListBoxFactory ( const Real a_meshSpacing)

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

◆ ~ListBoxFactory()

template<class T >
ListBoxFactory< T >::~ListBoxFactory ( )
virtual

Destructor.

Member Function Documentation

◆ define()

template<class T >
void ListBoxFactory< T >::define ( const RealVect a_meshSpacing,
const RealVect a_origin 
)

Use these parameters for all manufactured ListBox instances.

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

◆ create()

template<class T >
ListBox< T > * ListBoxFactory< T >::create ( const Box a_box,
int  a_numComps,
const DataIndex a_datInd 
) const
virtual

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

Implements DataFactory< ListBox< T > >.

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

◆ meshSpacing()

template<class T >
RealVect ListBoxFactory< T >::meshSpacing ( ) const

Retrieve the cell size.

◆ origin()

template<class T >
RealVect ListBoxFactory< T >::origin ( ) const

Retrieve the origin.

Member Data Documentation

◆ m_mesh_spacing

template<class T>
RealVect ListBoxFactory< T >::m_mesh_spacing
private

cell size in physical coordinates

◆ m_origin

template<class T>
RealVect ListBoxFactory< T >::m_origin
private

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


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