SAMRAI::pdat::NodeGeometry< DIM > Class Template Reference

#include <source/patchdata/boxgeometry/NodeGeometry.h>

Inheritance diagram for SAMRAI::pdat::NodeGeometry< DIM >:

[legend]List of all members.

Public Types
typedef NodeOverlap< DIM >	Overlap
Public Member Functions
	NodeGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts)
	Construct the node geometry object given an AMR index space box and ghost cell width.
virtual	~NodeGeometry ()
	The virtual destructor does nothing interesting.
virtual tbox::Pointer< hier::BoxOverlap< DIM > >	calculateOverlap (const hier::BoxGeometry< DIM > &dst_geometry, const hier::BoxGeometry< DIM > &src_geometry, const hier::Box< DIM > &src_mask, const bool overwrite_interior, const hier::IntVector< DIM > &src_offset, const bool retry) const
	Compute the overlap in node-centered index space between the source box geometry and the destination box geometry.
void	computeDestinationBoxes (hier::BoxList< DIM > &dst_boxes, const NodeGeometry< DIM > &src_geometry, const hier::Box< DIM > &src_mask, const bool overwrite_interior, const hier::IntVector< DIM > &src_offset) const
	Compute the node-centered destination boxes that represent the overlap between the source box geometry and the destination box geometry.
const hier::Box< DIM > &	getBox () const
	Return the box for this node centered box geometry object.
const hier::IntVector< DIM > &	getGhosts () const
	Return the ghost cell width for this node centered box geometry object.
Static Public Member Functions
static hier::Box< DIM >	toNodeBox (const hier::Box< DIM > &box)
	Convert an AMR index box space box into a node geometry box. A node geometry box is extends the given AMR index box space box by one in upper dimension for each coordinate direction.

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::NodeGeometry< DIM >

Class NodeGeometry<DIM> manages the mapping between the AMR index space and the node-centered geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between node- centered box geometries for communication operations.

See header file for NodeData<DIM> class for a more detailed description of the data layout.

See also:

hier::BoxGeometry

pdat::NodeOverlap

---

Member Typedef Documentation

template<int DIM>

typedef NodeOverlap<DIM> SAMRAI::pdat::NodeGeometry< DIM >::Overlap

The BoxOverlap implemenation for this geometry.

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::NodeGeometry< DIM >::NodeGeometry	(	const hier::Box< DIM > &	box,
		const hier::IntVector< DIM > &	ghosts
	)

Construct the node geometry object given an AMR index space box and ghost cell width.

template<int DIM>

SAMRAI::pdat::NodeGeometry< DIM >::~NodeGeometry

(

)

[virtual]

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

hier::Box< DIM > SAMRAI::pdat::NodeGeometry< DIM >::toNodeBox

(

const hier::Box< DIM > &

box

)

[inline, static]

Convert an AMR index box space box into a node geometry box. A node geometry box is extends the given AMR index box space box by one in upper dimension for each coordinate direction.

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::NodeGeometry< DIM >::calculateOverlap	(	const hier::BoxGeometry< DIM > &	dst_geometry,
		const hier::BoxGeometry< DIM > &	src_geometry,
		const hier::Box< DIM > &	src_mask,
		const bool	overwrite_interior,
		const hier::IntVector< DIM > &	src_offset,
		const bool	retry
	)			const [virtual]

Compute the overlap in node-centered index space between the source box geometry and the destination box geometry.

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

template<int DIM>

void SAMRAI::pdat::NodeGeometry< DIM >::computeDestinationBoxes	(	hier::BoxList< DIM > &	dst_boxes,
		const NodeGeometry< DIM > &	src_geometry,
		const hier::Box< DIM > &	src_mask,
		const bool	overwrite_interior,
		const hier::IntVector< DIM > &	src_offset
	)			const

Compute the node-centered destination boxes that represent the overlap between the source box geometry and the destination box geometry.

template<int DIM>

const hier::Box< DIM > & SAMRAI::pdat::NodeGeometry< DIM >::getBox

(

)

const [inline]

Return the box for this node centered box geometry object.

template<int DIM>

const hier::IntVector< DIM > & SAMRAI::pdat::NodeGeometry< DIM >::getGhosts

(

)

const [inline]

Return the ghost cell width for this node centered box geometry object.

---

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

• source/patchdata/boxgeometry/NodeGeometry.h
• source/patchdata/boxgeometry/NodeGeometry.C
• source/patchdata/boxgeometry/NodeGeometry.I

---