CFIVS Class Reference

#include <CFIVS.H>

Collaboration diagram for CFIVS:

[legend]

List of all members.

---

Detailed Description

Internal Chombo class to get fine intvectset at CF interface.

Class to get fine intvectset at cf interface for one side of a given fine-level Box. This class should be considered internal to AMRSolver and should not be considered part of the Chombo API.

Public Member Functions
	CFIVS ()
	Null constructor.
	~CFIVS ()
	Destructor.
	CFIVS (const Box &a_domain, const Box &a_boxIn, const DisjointBoxLayout &a_fineBoxes, int a_direction, Side::LoHiSide a_hiorlo)
	Deprecated constructor (The ProblemDomain class has replaced the Box domain).
	CFIVS (const ProblemDomain &a_domain, const Box &a_boxIn, const DisjointBoxLayout &a_fineBoxes, int a_direction, Side::LoHiSide a_hiorlo)
	Full constructor.
void	define (const Box &a_domain, const Box &a_boxIn, const DisjointBoxLayout &a_fineBoxes, int a_direction, Side::LoHiSide a_hiorlo)
	Deprecated define function.
void	define (const ProblemDomain &a_domain, const Box &a_boxIn, const DisjointBoxLayout &a_fineBoxes, int a_direction, Side::LoHiSide a_hiorlo)
	Full define function.
void	define (const ProblemDomain &a_domain, const Box &a_boxIn, const Vector< Box > &a_periodicfineBoxes, int a_direction, Side::LoHiSide a_hiorlo)
	is the face on the hi or lo side of the box?
bool	isDefined () const
	Returns "true" if the object has been defined.
bool	isPacked () const
	Returns "true" if this CF IntVectSet can be represented as a simple Box.
const Box &	packedBox () const
	Returns packed box for when isPacked() is true.
const IntVectSet &	getFineIVS () const
	Get fine intvects which need to be interpolated.
void	coarsen (int a_ref)
Static Public Attributes
static long long	m_packCount
static long long	m_sparseCount
Protected Member Functions
void	setDefaultValues ()
Protected Attributes
IntVectSet	m_fiinterpIVS
bool	m_packed
Box	m_packedBox
bool	m_isDefined

---

Constructor & Destructor Documentation

CFIVS::CFIVS

(

)

Null constructor.

CFIVS::~CFIVS

(

)

Destructor.

CFIVS::CFIVS	(	const Box &	a_domain,
		const Box &	a_boxIn,
		const DisjointBoxLayout &	a_fineBoxes,
		int	a_direction,
		Side::LoHiSide	a_hiorlo
	)

Deprecated constructor (The ProblemDomain class has replaced the Box domain).

Replaces Box domain with a ProblemDomain and calls define fn.

CFIVS::CFIVS	(	const ProblemDomain &	a_domain,
		const Box &	a_boxIn,
		const DisjointBoxLayout &	a_fineBoxes,
		int	a_direction,
		Side::LoHiSide	a_hiorlo
	)

Full constructor.

Calls corresponding define function.

---

Member Function Documentation

void CFIVS::define	(	const Box &	a_domain,
		const Box &	a_boxIn,
		const DisjointBoxLayout &	a_fineBoxes,
		int	a_direction,
		Side::LoHiSide	a_hiorlo
	)

Deprecated define function.

Replaces Box domain with a ProblemDomain and calls define fn.

void CFIVS::define	(	const ProblemDomain &	a_domain,
		const Box &	a_boxIn,
		const DisjointBoxLayout &	a_fineBoxes,
		int	a_direction,
		Side::LoHiSide	a_hiorlo
	)

Full define function.

Parameters:

a_boxIn	Problem domain at the fine level
a_fineBoxes	fine-level grid box
a_direction	fine-level grids
a_hiorlo	direction of the face of interest

void CFIVS::define	(	const ProblemDomain &	a_domain,
		const Box &	a_boxIn,
		const Vector< Box > &	a_periodicfineBoxes,
		int	a_direction,
		Side::LoHiSide	a_hiorlo
	)

is the face on the hi or lo side of the box?

faster define function. Requires the use of CFStencil::buildPeriodicVector static function.

bool CFIVS::isDefined

(

)

const

Returns "true" if the object has been defined.

bool CFIVS::isPacked

(

)

const [inline]

Returns "true" if this CF IntVectSet can be represented as a simple Box.

Returns 'true' if this coarse-fine IntVectSet can be represented as just a Box, ie. a user can perform a dense computation instead of a pointwise calculation using IVSIterator.

References m_packed.

const Box & CFIVS::packedBox

(

)

const [inline]

Returns packed box for when isPacked() is true.

if isPacked() returns 'true', then the box returned by this function is a suitable substitute for this IntVectSet

References m_packedBox.

const IntVectSet& CFIVS::getFineIVS

(

)

const

Get fine intvects which need to be interpolated.

This will be empty if isEmpty() returns true

void CFIVS::coarsen

(

int

a_ref

)

void CFIVS::setDefaultValues

(

)

[protected]

---

Member Data Documentation

long long CFIVS::m_packCount [static]

long long CFIVS::m_sparseCount [static]

IntVectSet CFIVS::m_fiinterpIVS [protected]

Fine intvects which need to be interpolated

bool CFIVS::m_packed [protected]

Can the coarse-fine IntVectSet be represented as a Box?

Referenced by isPacked().

Box CFIVS::m_packedBox [protected]

If m_packed is true, the Box with which the coarse-fine IntVectSet can be represented

Referenced by packedBox().

bool CFIVS::m_isDefined [protected]

Has this object been defined?

---

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

• CFIVS.H