TensorFineStencilSet Class Reference

Class to encapsulate fine-level tangential gradient stencil computation. More...

#include <TensorFineStencilSet.H>

Public Member Functions
	TensorFineStencilSet ()
	constructors, destructors, defines More...
	TensorFineStencilSet (const IntVectSet &a_fineIVS, const ProblemDomain &a_domain, int a_normalDir)
	full constructor – defines stencil IntVectSets More...
	~TensorFineStencilSet ()
	destructor More...
void	define (const IntVectSet &a_fineIVS, const ProblemDomain &a_domain, int a_dir)
	define function More...
const IntVectSet &	getCenteredStencilSet (int a_tanDir) const
	accessor More...
const IntVectSet &	getForwardStencilSet (int a_tanDir) const
	accessor More...
const IntVectSet &	getBackwardStencilSet (int a_tanDir) const
	accessor More...
bool	isDefined () const
	has this object been defined? More...
bool	isEmpty () const
	does this contain any non-empty IntVectSets? More...

Protected Attributes
bool	m_isDefined
bool	m_isEmpty
int	m_normalDir
int	m_tangentialDirections [SpaceDim-1]
IntVectSet	m_centeredSet [SpaceDim-1]
	cells which will use centered diffs More...
IntVectSet	m_forwardSet [SpaceDim-1]
IntVectSet	m_backwardSet [SpaceDim-1]
	cells which will use backward diffs More...

Detailed Description

Class to encapsulate fine-level tangential gradient stencil computation.

This is a helper class which essentially wraps three IntVectSets which define which type of stencil to use in computing fine-level tangential gradients. This is only relevant in the presence of a physical boundary (since the only place where the fine-level stencil is shifted is at a physical boundary; in a periodic world, all differences are centered.)

Constructor & Destructor Documentation

TensorFineStencilSet() [1/2]

TensorFineStencilSet::TensorFineStencilSet

(

)

constructors, destructors, defines

default constructor – leaves class in undefined state

TensorFineStencilSet() [2/2]

TensorFineStencilSet::TensorFineStencilSet	(	const IntVectSet &	a_fineIVS,
		const ProblemDomain &	a_domain,
		int	a_normalDir
	)

full constructor – defines stencil IntVectSets

~TensorFineStencilSet()

TensorFineStencilSet::~TensorFineStencilSet

(

)

destructor

Member Function Documentation

define()

void TensorFineStencilSet::define	(	const IntVectSet &	a_fineIVS,
		const ProblemDomain &	a_domain,
		int	a_dir
	)

define function

getCenteredStencilSet()

const IntVectSet& TensorFineStencilSet::getCenteredStencilSet

(

int

a_tanDir

)

const

accessor

accessor – returns cells where fine-level tangential gradient in a_tanDir direction will use a centered-difference stencil. If a_tanDir is normal to the face (i.e, isn't a tangential direction after all), will return an empty IntVectSet.

getForwardStencilSet()

const IntVectSet& TensorFineStencilSet::getForwardStencilSet

(

int

a_tanDir

)

const

accessor

accessor – returns cells where fine-level tangential gradient in a_tanDir will use a forward-difference stencil. If a_tanDir is normal to the face (i.e. it isn't a tangential direction after all), will return an empty IntVectSet.

getBackwardStencilSet()

const IntVectSet& TensorFineStencilSet::getBackwardStencilSet

(

int

a_tanDir

)

const

accessor

accessor – returns cells where fine-level tangential gradient in a_tanDir will use a backward-difference stencil. If a_tanDir is normal to the face, will return an empty IntVectSet.

isDefined()

bool TensorFineStencilSet::isDefined

(

)

const

has this object been defined?

isEmpty()

bool TensorFineStencilSet::isEmpty

(

)

const

does this contain any non-empty IntVectSets?

Member Data Documentation

m_isDefined

bool TensorFineStencilSet::m_isDefined

protected

m_isEmpty

bool TensorFineStencilSet::m_isEmpty

protected

m_normalDir

int TensorFineStencilSet::m_normalDir

protected

m_tangentialDirections

int TensorFineStencilSet::m_tangentialDirections[SpaceDim-1]

protected

m_centeredSet

IntVectSet TensorFineStencilSet::m_centeredSet[SpaceDim-1]

protected

cells which will use centered diffs

m_forwardSet

IntVectSet TensorFineStencilSet::m_forwardSet[SpaceDim-1]

protected

m_backwardSet

IntVectSet TensorFineStencilSet::m_backwardSet[SpaceDim-1]

protected

cells which will use backward diffs

---

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

• TensorFineStencilSet.H