SAMRAI::geom::BlockGridGeometry< DIM > Class Template Reference

#include <source/geometry/multiblock/grid_geom/BlockGridGeometry.h>

Inheritance diagram for SAMRAI::geom::BlockGridGeometry< DIM >:

[legend]List of all members.

Public Member Functions
	BlockGridGeometry (const std::string &object_name, tbox::Pointer< tbox::Database > input_db, const int block_number, bool register_for_restart=true)
	BlockGridGeometry (const std::string &object_name, const hier::BoxArray< DIM > &level_domain, bool register_for_restart=true)
virtual	~BlockGridGeometry ()
tbox::Pointer< hier::GridGeometry< DIM > >	makeRefinedGridGeometry (const std::string &fine_geom_name, const hier::IntVector< DIM > &refine_ratio, bool register_for_restart) const
tbox::Pointer< hier::GridGeometry< DIM > >	makeCoarsenedGridGeometry (const std::string &coarse_geom_name, const hier::IntVector< DIM > &coarsen_ratio, bool register_for_restart) const
void	setGeometryDataOnPatch (hier::Patch< DIM > &patch, const hier::IntVector< DIM > &ratio_to_level_zero, const tbox::Array< tbox::Array< bool > > &touches_regular_bdry, const tbox::Array< tbox::Array< bool > > &touches_periodic_bdry) const
int	getBlockNumber () const
virtual void	printClassData (std::ostream &os) const
virtual void	putToDatabase (tbox::Pointer< tbox::Database > db)

template<int DIM>
class SAMRAI::geom::BlockGridGeometry< DIM >

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::geom::BlockGridGeometry< DIM >::BlockGridGeometry	(	const std::string &	object_name,
		tbox::Pointer< tbox::Database >	input_db,
		const int	block_number,
		bool	register_for_restart = true
	)

Constructor for BlockGridGeometry initializes data members based on parameters read from the specified input and restart databases. The constructor also registers this object for restart using the specified object name, when the boolean argument is true. Whether object will write its state to restart files during program execution is determined by this argument. Note that it has a default state of true.

Errors: passing in a null database pointer or an empty string will result in an unrecoverable assertion.

template<int DIM>

SAMRAI::geom::BlockGridGeometry< DIM >::BlockGridGeometry	(	const std::string &	object_name,
		const hier::BoxArray< DIM > &	level_domain,
		bool	register_for_restart = true
	)

Constructor for BlockGridGeometry sets index space domain based on arguments. The constructor also registers this object for restart using the specified object name, when the boolean argument is true. Whether object will write its state to restart files during program execution is determined by this argument. Note that it has a default state of true.

Errors: passing in an empty string, or null data pointers will result in an unrecoverable assertion.

template<int DIM>

SAMRAI::geom::BlockGridGeometry< DIM >::~BlockGridGeometry

(

)

[virtual]

Destructor for BlockGridGeometry unregisters the object with the restart manager if previously registered.

---

Member Function Documentation

template<int DIM>

tbox::Pointer< hier::GridGeometry< DIM > > SAMRAI::geom::BlockGridGeometry< DIM >::makeRefinedGridGeometry	(	const std::string &	fine_geom_name,
		const hier::IntVector< DIM > &	refine_ratio,
		bool	register_for_restart
	)			const [virtual]

Create and return a pointer to a refined version of this Cartesian grid geometry object. This function is pure virtual in the hier_GridGeometry base class.

Implements SAMRAI::hier::GridGeometry< DIM >.

template<int DIM>

tbox::Pointer< hier::GridGeometry< DIM > > SAMRAI::geom::BlockGridGeometry< DIM >::makeCoarsenedGridGeometry	(	const std::string &	coarse_geom_name,
		const hier::IntVector< DIM > &	coarsen_ratio,
		bool	register_for_restart
	)			const [virtual]

Create and return a pointer to a coarsened version of this Cartesian grid geometry object. This function is pure virtual in the hier_GridGeometry base class.

Implements SAMRAI::hier::GridGeometry< DIM >.

template<int DIM>

void SAMRAI::geom::BlockGridGeometry< DIM >::setGeometryDataOnPatch	(	hier::Patch< DIM > &	patch,
		const hier::IntVector< DIM > &	ratio_to_level_zero,
		const tbox::Array< tbox::Array< bool > > &	touches_regular_bdry,
		const tbox::Array< tbox::Array< bool > > &	touches_periodic_bdry
	)			const [virtual]

Implements SAMRAI::hier::GridGeometry< DIM >.

template<int DIM>

int SAMRAI::geom::BlockGridGeometry< DIM >::getBlockNumber

(

)

const [inline]

template<int DIM>

void SAMRAI::geom::BlockGridGeometry< DIM >::printClassData

(

std::ostream &

os

)

const [virtual]

Print class data representation.

Reimplemented from SAMRAI::xfer::Geometry< DIM >.

template<int DIM>

void SAMRAI::geom::BlockGridGeometry< DIM >::putToDatabase

(

tbox::Pointer< tbox::Database >

db

)

[virtual]

Writes the state of the BlockGridGeometry object to the database.

When assertion checking is active, db cannot be a null database pointer.

Implements SAMRAI::tbox::Serializable.

---

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

• source/geometry/multiblock/grid_geom/BlockGridGeometry.h
• source/geometry/multiblock/grid_geom/BlockGridGeometry.C

---