Proto::MBDisjointBoxLayout Class Reference

#include <Proto_MBDisjointBoxLayout.H>

Public Types
typedef DataIndex< MBBoxPartition >	MBIndex

Public Member Functions
	MBDisjointBoxLayout ()
	MBDisjointBoxLayout (MBProblemDomain &a_domain, Point a_boxSize)
	MBDisjointBoxLayout (MBProblemDomain &a_domain, std::vector< Point > a_boxSizes)
	MBDisjointBoxLayout (MBProblemDomain &a_domain, std::vector< MBPoint > a_patches, std::vector< Point > a_boxSizes)
	MBDisjointBoxLayout (std::shared_ptr< MBBoxPartition > a_partition, std::vector< Point > a_boxSizes)
void	define (MBProblemDomain &a_domain, std::vector< Point > a_boxSizes)
void	define (MBProblemDomain &a_domain, std::vector< MBPoint > a_patches, std::vector< Point > a_boxSizes)
void	define (std::shared_ptr< MBBoxPartition > a_partition, std::vector< Point > a_boxSizes)
const MBProblemDomain &	domainPtr () const
const MBProblemDomain &	domain () const
unsigned int	procID (const MBIndex &a_index) const
unsigned int	numBlocks () const
unsigned int	numBoxes () const
unsigned int	numBoxes (unsigned int a_proc) const
unsigned int	numProcs () const
std::vector< MBPoint >	patches () const
DataIndex< BoxPartition >	blockIndex (const MBIndex &a_index) const
Box	operator[] (const MBIndex &a_index) const
MBIterator	begin () const
MBIterator	end () const
Point	point (const MBIndex &a_index) const
Box	box (const MBIndex &a_index) const
Array< double, DIM >	dx (BlockIndex a_block) const
Array< double, DIM >	dx (MBIndex a_index) const
Box	blockDomainBox (BlockIndex a_block) const
unsigned int	block (const MBIndex &a_index) const
MBPoint	patch (const MBIndex &a_index) const
DisjointBoxLayout &	getBlock (BlockIndex a_block)
const DisjointBoxLayout &	getBlock (BlockIndex a_block) const
MBIndex	find (Point a_point, BlockIndex a_block) const
const MBBoxPartition &	partition () const
const MBProblemDomain &	patchDomain () const
std::shared_ptr< MBBoxPartition >	partitionPtr () const
size_t	offset (unsigned int a_proc) const
bool	compatible (const MBDisjointBoxLayout &a_rhs) const
bool	compatible (const MBIndex &a_index) const
Point	connectivity (const MBPoint &patch_1, const MBPoint &patch_2) const
Point	connectivity (const MBIndex &i1, const MBIndex &i2) const
bool	isBlockBoundary (const MBPoint &patch_1, const MBPoint &patch_2) const
bool	isBlockBoundary (const MBIndex &patch_1, const MBIndex &patch_2) const
bool	isBlockBoundary (const MBPoint &patch, Point dir) const
bool	isBlockBoundary (const MBIndex &patch, Point dir) const
bool	isBlockBoundary (const MBPoint &patch, Point dir, BlockIndex adjBlock) const
bool	isPatchOnBlockBoundary (const MBPoint &patch) const
bool	isPatchOnBlockBoundary (const MBPoint &patch, Point dir) const
bool	isPatchInBlockBoundary (const MBPoint &patch) const
bool	isPatchInBlockBoundary (const MBPoint &patch, Point dir) const
bool	isDomainBoundary (const MBPoint &patch, Point dir) const
bool	isDomainBoundary (const MBIndex &patch, Point dir) const
bool	isPatchOnDomainBoundary (const MBPoint &patch) const
bool	isPatchOnDomainBoundary (const MBPoint &patch, Point dir) const
bool	isPatchInDomainBoundary (const MBPoint &patch) const
bool	isPatchInDomainBoundary (const MBPoint &patch, Point dir) const
bool	isRefinementBoundary (const MBPoint &patch, Point dir) const
bool	isPatchOnRefinementBoundary (const MBPoint &patch) const
bool	isInteriorBoundary (const MBPoint &patch, Point dir) const
bool	isPatchInTriplePointRegion (const MBPoint &patch) const
bool	isPatchInTriplePointRegion (const MBPoint &patch, Point dir) const
std::vector< MBIndex >	adjacentIndices (const MBPoint &patch) const
std::vector< MBIndex >	adjacentIndices (const MBPoint &patch, Point dir) const
unsigned int	size () const
unsigned int	localSize () const
std::vector< Point >	boxSizes () const
Point	boxSize (BlockIndex a_block) const
MBDisjointBoxLayout	coarsen (const Point &a_refRatio) const
MBDisjointBoxLayout	coarsen (const std::vector< Point > &a_refRatios) const
void	validateSelf (std::string methodName) const
void	validateIndex (const MBIndex &index, std::string methodName) const
void	validateBlock (const BlockIndex &block, std::string methodName) const
void	print () const
bool	defined () const

Private Attributes
bool	m_defined
MBProblemDomain	m_domain
std::vector< DisjointBoxLayout >	m_layouts
std::shared_ptr< MBBoxPartition >	m_partition

Member Typedef Documentation

MBIndex

typedef DataIndex<MBBoxPartition> Proto::MBDisjointBoxLayout::MBIndex

Constructor & Destructor Documentation

MBDisjointBoxLayout() [1/5]

Proto::MBDisjointBoxLayout::MBDisjointBoxLayout ( )

inline

References m_defined.

MBDisjointBoxLayout() [2/5]

Proto::MBDisjointBoxLayout::MBDisjointBoxLayout ( MBProblemDomain &  a_domain, Point  a_boxSize  )

inline

MBDisjointBoxLayout() [3/5]

Proto::MBDisjointBoxLayout::MBDisjointBoxLayout ( MBProblemDomain &  a_domain, std::vector< Point >  a_boxSizes  )

inline

MBDisjointBoxLayout() [4/5]

Proto::MBDisjointBoxLayout::MBDisjointBoxLayout ( MBProblemDomain &  a_domain, std::vector< MBPoint >  a_patches, std::vector< Point >  a_boxSizes  )

inline

MBDisjointBoxLayout() [5/5]

Proto::MBDisjointBoxLayout::MBDisjointBoxLayout ( std::shared_ptr< MBBoxPartition >  a_partition, std::vector< Point >  a_boxSizes  )

inline

Member Function Documentation

define() [1/3]

void Proto::MBDisjointBoxLayout::define ( MBProblemDomain &  a_domain, std::vector< Point >  a_boxSizes  )

inline

define() [2/3]

void Proto::MBDisjointBoxLayout::define ( MBProblemDomain &  a_domain, std::vector< MBPoint >  a_patches, std::vector< Point >  a_boxSizes  )

inline

define() [3/3]

void Proto::MBDisjointBoxLayout::define ( std::shared_ptr< MBBoxPartition >  a_partition, std::vector< Point >  a_boxSizes  )

inline

domainPtr()

const MBProblemDomain& Proto::MBDisjointBoxLayout::domainPtr ( ) const

inline

domain()

const MBProblemDomain & Proto::MBDisjointBoxLayout::domain ( ) const

inline

procID()

unsigned int Proto::MBDisjointBoxLayout::procID ( const MBIndex &  a_index ) const

inline

numBlocks()

unsigned int Proto::MBDisjointBoxLayout::numBlocks ( ) const

inline

numBoxes() [1/2]

unsigned int Proto::MBDisjointBoxLayout::numBoxes ( ) const

inline

numBoxes() [2/2]

unsigned int Proto::MBDisjointBoxLayout::numBoxes ( unsigned int  a_proc ) const

inline

numProcs()

unsigned int Proto::MBDisjointBoxLayout::numProcs ( ) const

inline

patches()

std::vector< MBPoint > Proto::MBDisjointBoxLayout::patches ( ) const

inline

blockIndex()

DataIndex< BoxPartition > Proto::MBDisjointBoxLayout::blockIndex ( const MBIndex &  a_index ) const

inline

operator[]()

Box Proto::MBDisjointBoxLayout::operator[] ( const MBIndex &  a_index ) const

inline

begin()

MBIterator Proto::MBDisjointBoxLayout::begin ( ) const

inline

end()

MBIterator Proto::MBDisjointBoxLayout::end ( ) const

inline

point()

Point Proto::MBDisjointBoxLayout::point ( const MBIndex &  a_index ) const

inline

box()

Box Proto::MBDisjointBoxLayout::box ( const MBIndex &  a_index ) const

inline

dx() [1/2]

Array< double, DIM > Proto::MBDisjointBoxLayout::dx ( BlockIndex  a_block ) const

inline

dx() [2/2]

Array< double, DIM > Proto::MBDisjointBoxLayout::dx ( MBIndex  a_index ) const

inline

blockDomainBox()

Box Proto::MBDisjointBoxLayout::blockDomainBox ( BlockIndex  a_block ) const

inline

References block(), Proto::ProblemDomain::box(), Proto::DisjointBoxLayout::domain(), getBlock(), and patch().

block()

unsigned int Proto::MBDisjointBoxLayout::block ( const MBIndex &  a_index ) const

inline

Referenced by blockDomainBox().

patch()

MBPoint Proto::MBDisjointBoxLayout::patch ( const MBIndex &  a_index ) const

inline

Referenced by blockDomainBox().

getBlock() [1/2]

DisjointBoxLayout & Proto::MBDisjointBoxLayout::getBlock ( BlockIndex  a_block )

inline

Referenced by blockDomainBox().

getBlock() [2/2]

const DisjointBoxLayout & Proto::MBDisjointBoxLayout::getBlock ( BlockIndex  a_block ) const

inline

find()

MBDisjointBoxLayout::MBIndex Proto::MBDisjointBoxLayout::find ( Point  a_point, BlockIndex  a_block  ) const

inline

partition()

const MBBoxPartition& Proto::MBDisjointBoxLayout::partition ( ) const

inline

References m_partition.

Referenced by patchDomain().

patchDomain()

const MBProblemDomain& Proto::MBDisjointBoxLayout::patchDomain ( ) const

inline

References Proto::MBBoxPartition::domain(), and partition().

partitionPtr()

std::shared_ptr<MBBoxPartition> Proto::MBDisjointBoxLayout::partitionPtr ( ) const

inline

References compatible(), connectivity(), isBlockBoundary(), m_partition, and offset().

offset()

size_t Proto::MBDisjointBoxLayout::offset ( unsigned int  a_proc ) const

inline

Referenced by partitionPtr().

compatible() [1/2]

bool Proto::MBDisjointBoxLayout::compatible ( const MBDisjointBoxLayout &  a_rhs ) const

inline

Referenced by partitionPtr().

compatible() [2/2]

bool Proto::MBDisjointBoxLayout::compatible ( const MBIndex &  a_index ) const

inline

connectivity() [1/2]

Point Proto::MBDisjointBoxLayout::connectivity ( const MBPoint &  patch_1, const MBPoint &  patch_2  ) const

inline

Referenced by Proto::MBBoundaryData< T, C, MEM >::define(), and partitionPtr().

connectivity() [2/2]

Point Proto::MBDisjointBoxLayout::connectivity ( const MBIndex &  i1, const MBIndex &  i2  ) const

inline

isBlockBoundary() [1/5]

bool Proto::MBDisjointBoxLayout::isBlockBoundary ( const MBPoint &  patch_1, const MBPoint &  patch_2  ) const

inline

Referenced by partitionPtr().

isBlockBoundary() [2/5]

bool Proto::MBDisjointBoxLayout::isBlockBoundary ( const MBIndex &  patch_1, const MBIndex &  patch_2  ) const

inline

isBlockBoundary() [3/5]

bool Proto::MBDisjointBoxLayout::isBlockBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isBlockBoundary() [4/5]

bool Proto::MBDisjointBoxLayout::isBlockBoundary ( const MBIndex &  patch, Point  dir  ) const

inline

isBlockBoundary() [5/5]

bool Proto::MBDisjointBoxLayout::isBlockBoundary ( const MBPoint &  patch, Point  dir, BlockIndex  adjBlock  ) const

inline

isPatchOnBlockBoundary() [1/2]

bool Proto::MBDisjointBoxLayout::isPatchOnBlockBoundary ( const MBPoint &  patch ) const

inline

isPatchOnBlockBoundary() [2/2]

bool Proto::MBDisjointBoxLayout::isPatchOnBlockBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isPatchInBlockBoundary() [1/2]

bool Proto::MBDisjointBoxLayout::isPatchInBlockBoundary ( const MBPoint &  patch ) const

inline

isPatchInBlockBoundary() [2/2]

bool Proto::MBDisjointBoxLayout::isPatchInBlockBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isDomainBoundary() [1/2]

bool Proto::MBDisjointBoxLayout::isDomainBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isDomainBoundary() [2/2]

bool Proto::MBDisjointBoxLayout::isDomainBoundary ( const MBIndex &  patch, Point  dir  ) const

inline

isPatchOnDomainBoundary() [1/2]

bool Proto::MBDisjointBoxLayout::isPatchOnDomainBoundary ( const MBPoint &  patch ) const

inline

isPatchOnDomainBoundary() [2/2]

bool Proto::MBDisjointBoxLayout::isPatchOnDomainBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isPatchInDomainBoundary() [1/2]

bool Proto::MBDisjointBoxLayout::isPatchInDomainBoundary ( const MBPoint &  patch ) const

inline

isPatchInDomainBoundary() [2/2]

bool Proto::MBDisjointBoxLayout::isPatchInDomainBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isRefinementBoundary()

bool Proto::MBDisjointBoxLayout::isRefinementBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isPatchOnRefinementBoundary()

bool Proto::MBDisjointBoxLayout::isPatchOnRefinementBoundary ( const MBPoint &  patch ) const

inline

isInteriorBoundary()

bool Proto::MBDisjointBoxLayout::isInteriorBoundary ( const MBPoint &  patch, Point  dir  ) const

inline

isPatchInTriplePointRegion() [1/2]

bool Proto::MBDisjointBoxLayout::isPatchInTriplePointRegion ( const MBPoint &  patch ) const

inline

isPatchInTriplePointRegion() [2/2]

bool Proto::MBDisjointBoxLayout::isPatchInTriplePointRegion ( const MBPoint &  patch, Point  dir  ) const

inline

adjacentIndices() [1/2]

std::vector< MBIndex > Proto::MBDisjointBoxLayout::adjacentIndices ( const MBPoint &  patch ) const

inline

adjacentIndices() [2/2]

std::vector< MBIndex > Proto::MBDisjointBoxLayout::adjacentIndices ( const MBPoint &  patch, Point  dir  ) const

inline

size()

unsigned int Proto::MBDisjointBoxLayout::size ( ) const

inline

localSize()

unsigned int Proto::MBDisjointBoxLayout::localSize ( ) const

inline

boxSizes()

std::vector< Point > Proto::MBDisjointBoxLayout::boxSizes ( ) const

inline

boxSize()

Point Proto::MBDisjointBoxLayout::boxSize ( BlockIndex  a_block ) const

inline

coarsen() [1/2]

MBDisjointBoxLayout Proto::MBDisjointBoxLayout::coarsen

(

const Point &

a_refRatio

)

const

coarsen() [2/2]

MBDisjointBoxLayout Proto::MBDisjointBoxLayout::coarsen

(

const std::vector< Point > &

a_refRatios

)

const

validateSelf()

void Proto::MBDisjointBoxLayout::validateSelf

(

std::string

methodName

)

const

validateIndex()

void Proto::MBDisjointBoxLayout::validateIndex	(	const MBIndex &	index,
		std::string	methodName
	)		const

validateBlock()

void Proto::MBDisjointBoxLayout::validateBlock	(	const BlockIndex &	block,
		std::string	methodName
	)		const

print()

void Proto::MBDisjointBoxLayout::print ( ) const

inline

defined()

bool Proto::MBDisjointBoxLayout::defined ( ) const

inline

References m_defined.

Member Data Documentation

m_defined

bool Proto::MBDisjointBoxLayout::m_defined

private

Referenced by defined(), and MBDisjointBoxLayout().

m_domain

MBProblemDomain Proto::MBDisjointBoxLayout::m_domain

private

m_layouts

std::vector<DisjointBoxLayout> Proto::MBDisjointBoxLayout::m_layouts

private

m_partition

std::shared_ptr<MBBoxPartition> Proto::MBDisjointBoxLayout::m_partition

private

Referenced by partition(), and partitionPtr().

---

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

• Proto_MBDisjointBoxLayout.H