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

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

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

[legend]List of all members.

Public Member Functions
	SkeletonGridGeometry (const string &object_name, tbox::Pointer< tbox::Database > input_db, bool register_for_restart=true)
	SkeletonGridGeometry (const string &object_name, const hier::BoxArray< DIM > &level_domain, bool register_for_restart=true)
virtual	~SkeletonGridGeometry ()
tbox::Pointer< hier::GridGeometry< DIM > >	makeRefinedGridGeometry (const string &fine_geom_name, const hier::IntVector< DIM > &refine_ratio, bool register_for_restart) const
tbox::Pointer< hier::GridGeometry< DIM > >	makeCoarsenedGridGeometry (const 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
void	printClassData (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:

 * Input: 
 *    Required keyword assignment: domain_boxes  
 *    Optional keyword assignments: using_original_location_indices
 * 
 * A sample input file entry might look like:
 *
 *    domain_boxes = [(0,0) , (50,50)], [(20,25), (39, 17)]
 *    use_original_location_indices = TRUE
 *
 * 

The optional keyword use_original_location_indices is 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.

See also:

xfer::Geometry

hier::GridGeometry

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::geom::SkeletonGridGeometry< DIM >::SkeletonGridGeometry (  const 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 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 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 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]

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

template<int DIM> void SAMRAI::geom::SkeletonGridGeometry< DIM >::printClassData (  ostream &  os  )  const [virtual]

Print class data representation. Reimplemented from SAMRAI::xfer::Geometry< DIM >.

template<int DIM> void SAMRAI::geom::SkeletonGridGeometry< DIM >::putToDatabase (  tbox::Pointer< tbox::Database >  db  )  [virtual]

Writes the state of the SkeletonGridGeometry object to the database. When assertion checking is active, db cannot be a null database pointer.

---

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

• source/geometry/skeleton/grid_geom/SkeletonGridGeometry.h
• source/geometry/skeleton/grid_geom/SkeletonGridGeometry.C

---