#include <IVSFAB.H>

Public Member Functions
	IVSFAB ()

	IVSFAB (const IntVectSet &a_region, const int &a_nvarin)

	~IVSFAB ()

void	define (const IntVectSet &a_region, const int &a_nvarin)

void	setVal (const T &value)

void	copy (const Box &a_fromBox, const Interval &a_destInterval, const Box &a_toBox, const IVSFAB< T > &a_src, const Interval &a_srcInterval)

int	size (const Box &R, const Interval &comps) const

void	linearOut (void *buf, const Box &R, const Interval &comps) const

void	linearIn (void *buf, const Box &R, const Interval &comps)

void	clear ()

bool	isDefined () const

int	numIvs () const

int	nComp () const

const IntVectSet &	getIVS () const

T &	operator() (const IntVect &a_iv, const int &varlocin)

const T &	operator() (const IntVect &a_iv, const int &varlocin) const

const T *	dataPtr (const int &a_comp) const

T *	dataPtr (const int &a_comp)

	IVSFAB (const Box &a_region, int a_nVar)
	invalid but necessary for leveldata to compile More...

const int *	loVect () const

const int *	hiVect () const

template<>
int	size (const Box &a_region, const Interval &a_comps) const

template<>
void	linearOut (void *a_buf, const Box &a_region, const Interval &a_comps) const

template<>
void	linearIn (void *a_buf, const Box &a_region, const Interval &a_comps)

Static Public Member Functions
static int	preAllocatable ()

static void	setVerbose (bool a_verbose)

Protected Member Functions
int	getIndex (const IntVect &a_iv, const int &a_comp) const

Protected Attributes
T *	m_dataPtr

int	m_nComp

int	m_nIvs

IntVect	m_loVect

IntVect	m_hiVect

BaseFab< int >	m_ivmap

IntVectSet	m_ivs

bool	m_isDefined

Static Protected Attributes
static bool	s_verbose = false

Private Member Functions
void	setDefaultValues ()

IVSFAB< T > &	operator= (const IVSFAB< T > &)

	IVSFAB (const IVSFAB< T > &)

Detailed Description

template<class T>
class IVSFAB< T >

IVSFAB is a templated data holder defined at the Ivs of an irregular domain.

Constructor & Destructor Documentation

◆ IVSFAB() [1/4]

template<class T >

IVSFAB< T >::IVSFAB ( )

inline

Default constructor. Constructs an uninitialized IVFAB. You must subsequently call { define} before using this IVFAB.

◆ IVSFAB() [2/4]

template<class T >

IVSFAB< T >::IVSFAB	(	const IntVectSet &	a_region,
		const int &	a_nvarin
	)

inline

◆ ~IVSFAB()

template<class T >

IVSFAB< T >::~IVSFAB ( )

inline

◆ IVSFAB() [3/4]

template<class T>

IVSFAB< T >::IVSFAB	(	const Box &	a_region,
		int	a_nVar
	)

inline

invalid but necessary for leveldata to compile

References MayDay::Error(), IVSFAB< T >::getIndex(), IVSFAB< T >::hiVect(), IVSFAB< T >::loVect(), IVSFAB< T >::setDefaultValues(), and IVSFAB< T >::setVerbose().

◆ IVSFAB() [4/4]

template<class T >

IVSFAB< T >::IVSFAB ( const IVSFAB< T > & a_input )

inlineprivate

References MayDay::Error().

Member Function Documentation

◆ define()

template<class T >

void IVSFAB< T >::define	(	const IntVectSet &	a_region,
		const int &	a_nvarin
	)

inline

References CH_assert, CH_SPACEDIM, IntVectSet::isEmpty(), IntVectSet::minBox(), IVSIterator::ok(), IVSIterator::reset(), IntVect::Unit, and IntVect::Zero.

◆ setVal()

template<class T >

void IVSFAB< T >::setVal ( const T & value )

inline

Set a value at every data location.

References CH_assert.

◆ copy()

template<class T >

void IVSFAB< T >::copy	(	const Box &	a_fromBox,
		const Interval &	a_destInterval,
		const Box &	a_toBox,
		const IVSFAB< T > &	a_src,
		const Interval &	a_srcInterval
	)

inline

References Interval::begin(), CH_assert, Interval::end(), IVSFAB< T >::isDefined(), IntVectSet::isEmpty(), IVSFAB< T >::m_ivs, IVSFAB< T >::m_nComp, IVSIterator::ok(), and Interval::size().

◆ preAllocatable()

template<class T>

static int IVSFAB< T >::preAllocatable ( )

inlinestatic

This stuff required by LevelData in parallel:

References IVSFAB< T >::clear(), IVSFAB< T >::dataPtr(), IVSFAB< T >::getIVS(), IVSFAB< T >::isDefined(), IVSFAB< T >::linearIn(), IVSFAB< T >::linearOut(), IVSFAB< T >::nComp(), IVSFAB< T >::numIvs(), IVSFAB< T >::operator()(), and IVSFAB< T >::size().

◆ size() [1/2]

template<class T >

int IVSFAB< T >::size	(	const Box &	R,
		const Interval &	comps
	)		const

inline

References Interval::begin(), CH_assert, Interval::end(), and Box::numPts().

Referenced by IVSFAB< T >::preAllocatable().

◆ linearOut() [1/2]

template<class T >

void IVSFAB< T >::linearOut	(	void *	buf,
		const Box &	R,
		const Interval &	comps
	)		const

inline

References Interval::begin(), CH_assert, Interval::end(), IntVectSet::numPts(), and IVSIterator::ok().

Referenced by IVSFAB< T >::preAllocatable().

◆ linearIn() [1/2]

template<class T >

void IVSFAB< T >::linearIn	(	void *	buf,
		const Box &	R,
		const Interval &	comps
	)

inline

References Interval::begin(), CH_assert, Interval::end(), IntVectSet::numPts(), and IVSIterator::ok().

Referenced by IVSFAB< T >::preAllocatable().

◆ clear()

template<class T >

void IVSFAB< T >::clear ( )

inline

Remove all data from this IVSFAB. You must call { define} again in order to use it.

Referenced by IVSFAB< T >::preAllocatable().

◆ isDefined()

template<class T >

bool IVSFAB< T >::isDefined ( ) const

inline

Tells whether this IVSFAB has been defined, either with a constructor or with { define}. It must be initialized in order to access its data.

Referenced by IVSFAB< T >::copy(), and IVSFAB< T >::preAllocatable().

◆ numIvs()

template<class T >

int IVSFAB< T >::numIvs ( ) const

inline

Return the number of Ivs in this IVSFAB.

Referenced by IVSFAB< T >::preAllocatable().

◆ nComp()

template<class T >

int IVSFAB< T >::nComp ( ) const

inline

Return the number of data components of this IVSFAB.

Referenced by IVSFAB< T >::preAllocatable().

◆ getIVS()

template<class T >

const IntVectSet & IVSFAB< T >::getIVS ( ) const

inline

Return the irregular domain of the IVSFAB.

Referenced by IVSFAB< T >::preAllocatable().

◆ operator()() [1/2]

template<class T >

T & IVSFAB< T >::operator()	(	const IntVect &	a_iv,
		const int &	varlocin
	)

inline

Indexing operator. Return a reference to the contents of this IVFAB, at the specified Iv and data component. The first component is zero, the last is {nvar-1}. The returned object is a modifiable lvalue.

References CH_assert.

Referenced by IVSFAB< T >::preAllocatable().

◆ operator()() [2/2]

template<class T >

const T & IVSFAB< T >::operator()	(	const IntVect &	a_iv,
		const int &	varlocin
	)		const

inline

References CH_assert.

◆ dataPtr() [1/2]

template<class T >

const T * IVSFAB< T >::dataPtr ( const int & a_comp ) const

inline

Return a const pointer to the internal data storage of this IVFAB. \

References CH_assert.

Referenced by IVSFAB< T >::preAllocatable().

◆ dataPtr() [2/2]

template<class T >

T * IVSFAB< T >::dataPtr ( const int & a_comp )

inline

Return a pointer to the internal data storage of this IVFAB.

References CH_assert.

◆ loVect()

template<class T >

const int * IVSFAB< T >::loVect ( ) const

inline

Return a fake "lower left corner of the domain" for use with Fortran.

Referenced by IVSFAB< T >::IVSFAB().

◆ hiVect()

template<class T >

const int * IVSFAB< T >::hiVect ( ) const

inline

Return a fake "upper right corner of the domain" for use with Fortran.

Referenced by IVSFAB< T >::IVSFAB().

◆ setVerbose()

template<class T >

void IVSFAB< T >::setVerbose ( bool a_verbose )

static

Referenced by IVSFAB< T >::IVSFAB().

◆ setDefaultValues()

template<class T >

void IVSFAB< T >::setDefaultValues ( )

inlineprivate

References IntVect::Unit, and IntVect::Zero.

Referenced by IVSFAB< T >::IVSFAB().

◆ getIndex()

template<class T >

int IVSFAB< T >::getIndex	(	const IntVect &	a_iv,
		const int &	a_comp
	)		const

inlineprotected

References CH_assert.

Referenced by IVSFAB< T >::IVSFAB().

◆ operator=()

template<class T >

IVSFAB< T > & IVSFAB< T >::operator= ( const IVSFAB< T > & a_input )

inlineprivate

References MayDay::Error().

◆ size() [2/2]

template<>

int IVSFAB< Real >::size	(	const Box &	a_region,
		const Interval &	a_comps
	)		const

inline

References IntVectSet::numPts(), and Interval::size().

◆ linearOut() [2/2]

template<>

void IVSFAB< Real >::linearOut	(	void *	a_buf,
		const Box &	a_region,
		const Interval &	a_comps
	)		const

inline

References Interval::begin(), CH_assert, Interval::end(), IntVectSet::numPts(), and IVSIterator::ok().

◆ linearIn() [2/2]

template<>

void IVSFAB< Real >::linearIn	(	void *	a_buf,
		const Box &	a_region,
		const Interval &	a_comps
	)

inline

References Interval::begin(), CH_assert, Interval::end(), MayDay::Error(), IntVectSet::numPts(), and IVSIterator::ok().

Member Data Documentation

◆ m_dataPtr

template<class T>

T* IVSFAB< T >::m_dataPtr

protected

◆ m_nComp

template<class T>

int IVSFAB< T >::m_nComp

protected

Referenced by IVSFAB< T >::copy().

◆ m_nIvs

template<class T>

int IVSFAB< T >::m_nIvs

protected

◆ m_loVect

template<class T>

IntVect IVSFAB< T >::m_loVect

protected

◆ m_hiVect

template<class T>

IntVect IVSFAB< T >::m_hiVect

protected

◆ m_ivmap

template<class T>

BaseFab<int> IVSFAB< T >::m_ivmap

protected

◆ m_ivs

template<class T>

IntVectSet IVSFAB< T >::m_ivs

protected

Referenced by IVSFAB< T >::copy().

◆ m_isDefined

template<class T>

bool IVSFAB< T >::m_isDefined

protected

◆ s_verbose

template<class T>

bool IVSFAB< T >::s_verbose = false

staticprotected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

template<class T> class IVSFAB< T >

Constructor & Destructor Documentation

◆ IVSFAB() [1/4]

◆ IVSFAB() [2/4]

◆ ~IVSFAB()

◆ IVSFAB() [3/4]

◆ IVSFAB() [4/4]

Member Function Documentation

◆ define()

◆ setVal()

◆ copy()

◆ preAllocatable()

◆ size() [1/2]

◆ linearOut() [1/2]

◆ linearIn() [1/2]

◆ clear()

◆ isDefined()

◆ numIvs()

◆ nComp()

◆ getIVS()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ dataPtr() [1/2]

◆ dataPtr() [2/2]

◆ loVect()

◆ hiVect()

◆ setVerbose()

◆ setDefaultValues()

◆ getIndex()

◆ operator=()

◆ size() [2/2]

◆ linearOut() [2/2]

◆ linearIn() [2/2]

Member Data Documentation

◆ m_dataPtr

◆ m_nComp

◆ m_nIvs

◆ m_loVect

◆ m_hiVect

◆ m_ivmap

◆ m_ivs

◆ m_isDefined

◆ s_verbose

template<class T>
class IVSFAB< T >