SAMRAI::hier::PatchLevelFactory< DIM > Class Template Reference

#include <PatchLevelFactory.h>

Inheritance diagram for SAMRAI::hier::PatchLevelFactory< DIM >:

Public Member Functions
	PatchLevelFactory ()
virtual	~PatchLevelFactory ()
virtual tbox::Pointer< PatchLevel< DIM > >	allocate (const BoxArray< DIM > &boxes, const ProcessorMapping &mapping, const IntVector< DIM > &ratio_to_level_zero, const tbox::Pointer< GridGeometry< DIM > > grid_geometry, const tbox::Pointer< PatchDescriptor< DIM > > descriptor, tbox::Pointer< PatchFactory< DIM > > factory=NULL, const bool defer_boundary_box_creation=false) const
virtual tbox::Pointer< PatchLevel< DIM > >	allocate (tbox::Pointer< tbox::Database > database, const tbox::Pointer< GridGeometry< DIM > > grid_geometry, const tbox::Pointer< PatchDescriptor< DIM > > descriptor, tbox::Pointer< PatchFactory< DIM > > factory=NULL, const ComponentSelector component_selector=ComponentSelector(false), const bool defer_boundary_box_creation=false) const

Private Member Functions
	PatchLevelFactory (const PatchLevelFactory< DIM > &)
void	operator= (const PatchLevelFactory< DIM > &)

Detailed Description

template<int DIM>
class SAMRAI::hier::PatchLevelFactory< DIM >

Class PatchLevelFactory<DIM> is a factory object used to create new patch levels. New types of patch level objects can be introduced into SAMRAI by deriving from PatchLevelFactory<DIM> and re-defining allocate.

See also

hier::PatchLevel

Constructor & Destructor Documentation

PatchLevelFactory() [1/2]

template<int DIM>

SAMRAI::hier::PatchLevelFactory< DIM >::PatchLevelFactory

(

)

Construct a patch level factory object.

~PatchLevelFactory()

template<int DIM>

virtual SAMRAI::hier::PatchLevelFactory< DIM >::~PatchLevelFactory ( )

virtual

Virtual destructor for patch level factory objects.

PatchLevelFactory() [2/2]

template<int DIM>

SAMRAI::hier::PatchLevelFactory< DIM >::PatchLevelFactory ( const PatchLevelFactory< DIM > &  )

private

Member Function Documentation

allocate() [1/2]

template<int DIM>

virtual tbox::Pointer< PatchLevel<DIM> > SAMRAI::hier::PatchLevelFactory< DIM >::allocate ( const BoxArray< DIM > &  boxes, const ProcessorMapping &  mapping, const IntVector< DIM > &  ratio_to_level_zero, const tbox::Pointer< GridGeometry< DIM > >  grid_geometry, const tbox::Pointer< PatchDescriptor< DIM > >  descriptor, tbox::Pointer< PatchFactory< DIM > >  factory = NULL, const bool  defer_boundary_box_creation = false  ) const

virtual

Allocate a patch level with the specified boxes and processor mappings. Redefine this function to change the method for creating patch levels.

allocate() [2/2]

template<int DIM>

virtual tbox::Pointer< PatchLevel<DIM> > SAMRAI::hier::PatchLevelFactory< DIM >::allocate ( tbox::Pointer< tbox::Database >  database, const tbox::Pointer< GridGeometry< DIM > >  grid_geometry, const tbox::Pointer< PatchDescriptor< DIM > >  descriptor, tbox::Pointer< PatchFactory< DIM > >  factory = NULL, const ComponentSelector  component_selector = ComponentSelector(false), const bool  defer_boundary_box_creation = false  ) const

virtual

Allocate a patch level using the data from the database to initialize it. The component_selector argument is used to specify which patch data components to allocate and read in from the database. By default, the component_selector has all its bits set to false so that no patch data components are allocated and read from the database.

Redefine this function to change the method for creating patch levels from a database.

operator=()

template<int DIM>

void SAMRAI::hier::PatchLevelFactory< DIM >::operator= ( const PatchLevelFactory< DIM > &  )

private

---

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

• /samrai/include/PatchLevelFactory.h