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

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

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

[legend]List of all members.

Public Types
typedef FaceOverlap< DIM >	Overlap
Public Member Functions
	FaceGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts)
	Construct the face geometry object given an AMR index space box and ghost cell width.
virtual	~FaceGeometry ()
	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 face-centered index space between the source box geometry and the destination box geometry.
const hier::Box< DIM > &	getBox () const
	Return the box for this face centered box geometry object.
const hier::IntVector< DIM > &	getGhosts () const
	Return the ghost cell width for this face centered box geometry object.
Static Public Member Functions
static hier::Box< DIM >	toFaceBox (const hier::Box< DIM > &box, int face_normal)
	Convert an AMR index box space box into an face geometry box. An face geometry box extends the given AMR index box space box by one in upper dimension for the face normal coordinate direction.

---

Detailed Description

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

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

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

See also:

hier::BoxGeometry

pdat::FaceOverlap

---

Member Typedef Documentation

template<int DIM>

typedef FaceOverlap<DIM> SAMRAI::pdat::FaceGeometry< DIM >::Overlap

The BoxOverlap implemenation for this geometry.

---

Constructor & Destructor Documentation

template<int DIM>

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

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

template<int DIM>

SAMRAI::pdat::FaceGeometry< DIM >::~FaceGeometry

(

)

[virtual]

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

hier::Box< DIM > SAMRAI::pdat::FaceGeometry< DIM >::toFaceBox	(	const hier::Box< DIM > &	box,
		int	face_normal
	)			[static]

Convert an AMR index box space box into an face geometry box. An face geometry box extends the given AMR index box space box by one in upper dimension for the face normal coordinate direction.

Recall that box indices are cyclically shifted such that the face normal direction is the first coordinate index. See SideData header file.

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::FaceGeometry< 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 face-centered index space between the source box geometry and the destination box geometry.

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

template<int DIM>

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

(

)

const [inline]

Return the box for this face centered box geometry object.

template<int DIM>

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

(

)

const [inline]

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

---

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

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

---