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

#include <source/geometry/skeleton/grid_geom/SkeletonGridGeometry.h>

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


Public Member Functions
	SkeletonGridGeometry (const std::string &object_name, tbox::Pointer< tbox::Database > input_db, bool register_for_restart=true)
	SkeletonGridGeometry (const std::string &object_name, const hier::BoxArray< DIM > &level_domain, bool register_for_restart=true)
virtual	~SkeletonGridGeometry ()
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
virtual void	printClassData (std::ostream &os) const
virtual void	putToDatabase (tbox::Pointer< tbox::Database > db)

Detailed Description

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

Class SkeletonGridGeometry is a concrete grid geometry class that contains no information about the physical domain characteristics of an AMR mesh apart from the index space. The purpose of this class is to allow an application that needs to use a special mesh to manage the physical domain within the application code. The skeleton grid geometry only manages the index space of the adaptive grid. This class sets geometry information on each patch in an AMR hierarchy. This class is derived from the xfer::Geometry<DIM> base class which is further derived from the hier::GridGeometry<DIM> base class.

An object of this class requires parameters to be read from input to create the hier::BoxArray that stores the index space in the hier::GridGeometry superclass. Also, data must be written to and read from files for restart. The input and restart data are summarized as follows:

Required input keys and data types:

domain_boxes Array of boxes representing the index space for the entire domain (on the coarsest refinement level).

Optional input keys, data types, and defaults:

periodic_dimension tbox::Array of integer values representing the directions in which the physical domain is periodic. A non-zero value indicates that the direction is periodic. A zero value indicates that the direction is not periodic. If no values are specified, then the array is initialized to all zeros (no periodic directions).

use_original_location_indices Boolean argument used to tell whether to construct BoundaryBox objects with the original location index scheme that has existed in SAMRAI v. 1.4.0 and earlier or to use a new scheme that is compatible with the hier_BoundaryLookupTable. This only makes a difference for BoundaryBox objects in 3D with codimension 2. If this keyword is omitted from input, the default value is true for dimension 3 and is irrelevant for any other dimension.

No input values can overwrite restart values.

A sample input file for a two-dimensional problem might look like:

 *
 *    domain_boxes = [(0,0) , (49,39)]
 *    periodic_dimension = 0, 1  // periodic in y only
 *    use_original_location_indices = TRUE
 *
 *

This generates a two-dimensional domain periodic in the y-direction, and having 50 cells in the x-direction and 40 cells in the y-direction.

See also:: xfer::Geometry
hier::GridGeometry

Constructor & Destructor Documentation

template<int DIM>

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

Constructor for SkeletonGridGeometry 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::SkeletonGridGeometry< DIM >::SkeletonGridGeometry	(	const std::string &	object_name,
		const hier::BoxArray< DIM > &	level_domain,
		bool	register_for_restart = `true`
	)

Constructor for SkeletonGridGeometry 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::SkeletonGridGeometry< DIM >::~SkeletonGridGeometry ( ) [virtual]

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

Member Function Documentation

template<int DIM>

tbox::Pointer< hier::GridGeometry< DIM > > SAMRAI::geom::SkeletonGridGeometry< 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::SkeletonGridGeometry< 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::SkeletonGridGeometry< 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]`