SAMRAI::hier::MBUtilities< DIM > Class Template Reference

Class MBUtilities contains utility functions related to multiblock functionality. More...

#include <source/hierarchy/multiblock/MBUtilities.h>

List of all members.

Public Member Functions
	MBUtilities ()
virtual	~MBUtilities ()
Static Public Member Functions
static void	translateAndCopyData (hier::Patch< DIM > &dst_patch, const int dst_id, const hier::Patch< DIM > &src_patch, const int src_id, const hier::IntVector< DIM > &shift, const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier rotate)
	Copy patch data from src to dst using the shift and rotate arguments.
static void	translateAndFillData (hier::Patch< DIM > &dst_patch, const int dst_id, const hier::Patch< DIM > &src_patch, const int src_id, const hier::IntVector< DIM > &shift, const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier rotate)
	Fill patch data from src to dst using the shift and rotate arguments.
static void	rotateIndex (int *index, const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier rotation)
	rotate an index from one index space to another

---

Detailed Description

template<int DIM>
class SAMRAI::hier::MBUtilities< DIM >

Class MBUtilities contains utility functions related to multiblock functionality.

See also:

hier::MultiblockPatchHierarchy

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::hier::MBUtilities< DIM >::MBUtilities

(

)

Constructor

template<int DIM>

SAMRAI::hier::MBUtilities< DIM >::~MBUtilities

(

)

[virtual]

Virtual destructor does nothing

---

Member Function Documentation

template<int DIM>

void SAMRAI::hier::MBUtilities< DIM >::translateAndCopyData	(	hier::Patch< DIM > &	dst_patch,
		const int	dst_id,
		const hier::Patch< DIM > &	src_patch,
		const int	src_id,
		const hier::IntVector< DIM > &	shift,
		const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier	rotate
	)			[static]

Copy patch data from src to dst using the shift and rotate arguments.

Parameters:

	dst_patch	destination data
	dst_id	destination id
	src_patch	source data
	src_id	source id
	shift	the shift needed after rotation
	rotate	identifier of the rotation between index spaces

template<int DIM>

void SAMRAI::hier::MBUtilities< DIM >::translateAndFillData	(	hier::Patch< DIM > &	dst_patch,
		const int	dst_id,
		const hier::Patch< DIM > &	src_patch,
		const int	src_id,
		const hier::IntVector< DIM > &	shift,
		const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier	rotate
	)			[static]

Fill patch data from src to dst using the shift and rotate arguments.

This is an empty virtual function that allows for a user-defined implementation of the filling of destination patch data.

Parameters:

	dst_patch	destination data
	dst_id	destination id
	src_patch	source data
	src_id	source id
	shift	the shift needed after rotation
	rotate	identifier of the rotation between index spaces

template<int DIM>

void SAMRAI::hier::MBUtilities< DIM >::rotateIndex	(	int *	index,
		const typename MultiblockPatchHierarchy< DIM >::RotationIdentifier	rotation
	)			[static]

rotate an index from one index space to another

The parameter index is an int pointer with points to an array of int data, length DIM. It signifies an ijk location in an index space. According to the rotation number, the location will be rotated around the origin, with the new values overwriting the original values in the array pointed to by index.

Parameters:

	index	array identifying a point in index space
	rotation	identifier of the rotation that will be applied to index

---

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

• source/hierarchy/multiblock/MBUtilities.h
• source/hierarchy/multiblock/MBUtilities.C

---