Class to manage coarse-to-fine spatial interpolation to all fine cells within a single particular coarse cell. More...

#include <FourthOrderMappedCFInterpStencil.H>

Public Member Functions
	FourthOrderMappedCFInterpStencil ()
	Default constructor. More...

	FourthOrderMappedCFInterpStencil (const IntVect &a_bdryOffset, int a_degree=3, Interval a_fixedDims=Interval())
	Full constructor. More...

	~FourthOrderMappedCFInterpStencil ()
	Destructor. More...

void	define (const IntVect &a_bdryOffset, int a_degree=3, Interval a_fixedDims=Interval())
	Actual constructor. More...

const Vector< int > &	indices () const

const Vector< int > &	indicesFull () const

const Vector< IntVect > &	cells () const

const Vector< Real > &	avgPowers () const

Protected Attributes
int	m_degree
	max degree of polynomials More...

Interval	m_fixedDims
	dimensions that are fixed, not interpolated More...

int	m_nInterpDims
	number of dimensions that are interpolated: SpaceDim - m_fixedDims.size() More...

IntVect	m_bdryOffset
	displacement from domain boundary in each dimension, in range -(a_degree-1):(a_degree-1) More...

int	m_stencilSize
	number of coarse cells in the stencil More...

int	m_numNonzeroPowers
	number of nonzero powers More...

Vector< IntVect >	m_stencilCells
	length m_stencilSize, lists stencil cells More...

Vector< int >	m_indices
	length m_stencilSize*(SpaceDim-m_fixedDims.size()), lists indices of stencil cells, grouped by cell More...

Vector< int >	m_indicesFull
	length m_stencilSize*SpaceDim, lists indices of stencil cells, grouped by cell More...

Vector< Real >	m_avgPowers
	length m_stencilSize*m_numNonzeroPowers, lists averages of <(x-x0)^p>j for stencil cells j, grouped by cell More...

bool	m_defined
	whether define() has been called More...

Private Member Functions
void	operator= (const FourthOrderMappedCFInterpStencil &a_input)

	FourthOrderMappedCFInterpStencil (const FourthOrderMappedCFInterpStencil &a_input)

Detailed Description

Class to manage coarse-to-fine spatial interpolation to all fine cells within a single particular coarse cell.

Constructor & Destructor Documentation

◆ FourthOrderMappedCFInterpStencil() [1/3]

FourthOrderMappedCFInterpStencil::FourthOrderMappedCFInterpStencil ( )

Default constructor.

Object requires define() to be called before all other functions.

◆ FourthOrderMappedCFInterpStencil() [2/3]

FourthOrderMappedCFInterpStencil::FourthOrderMappedCFInterpStencil	(	const IntVect &	a_bdryOffset,
		int	a_degree = `3`,
		Interval	a_fixedDims = `Interval()`
	)

inline

Full constructor.

Parameters

a_bdryOffset	in range -(a_degree-1):(a_degree-1), specifies displacement to boundary in each dimension
a_degree	max degree of polynomials
a_fixedDims	dimensions that are fixed, not interpolated

References define(), and ~FourthOrderMappedCFInterpStencil().

◆ ~FourthOrderMappedCFInterpStencil()

FourthOrderMappedCFInterpStencil::~FourthOrderMappedCFInterpStencil ( )

Destructor.

Destroys all objects created by define(). Passed in data references of define() are left alone.

Referenced by FourthOrderMappedCFInterpStencil().

◆ FourthOrderMappedCFInterpStencil() [3/3]

FourthOrderMappedCFInterpStencil::FourthOrderMappedCFInterpStencil ( const FourthOrderMappedCFInterpStencil & a_input )

private

Member Function Documentation

◆ define()

void FourthOrderMappedCFInterpStencil::define	(	const IntVect &	a_bdryOffset,
		int	a_degree = `3`,
		Interval	a_fixedDims = `Interval()`
	)

Actual constructor.

Set up object.

Parameters

a_bdryOffset	in range -(a_degree-1):(a_degree-1), specifies displacement to boundary in each dimension
a_degree	max degree of polynomials
a_fixedDims	dimensions that are fixed, not interpolated

Referenced by FourthOrderMappedCFInterpStencil().

◆ indices()

const Vector<int>& FourthOrderMappedCFInterpStencil::indices ( ) const

inline

References m_indices.

◆ indicesFull()

const Vector<int>& FourthOrderMappedCFInterpStencil::indicesFull ( ) const

inline

References m_indicesFull.

◆ cells()

const Vector<IntVect>& FourthOrderMappedCFInterpStencil::cells ( ) const

inline

References m_stencilCells.

◆ avgPowers()

const Vector<Real>& FourthOrderMappedCFInterpStencil::avgPowers ( ) const

inline

References m_avgPowers.

◆ operator=()

void FourthOrderMappedCFInterpStencil::operator= ( const FourthOrderMappedCFInterpStencil & a_input )

private

Member Data Documentation

◆ m_degree

int FourthOrderMappedCFInterpStencil::m_degree

protected

max degree of polynomials

◆ m_fixedDims

Interval FourthOrderMappedCFInterpStencil::m_fixedDims

protected

dimensions that are fixed, not interpolated

◆ m_nInterpDims

int FourthOrderMappedCFInterpStencil::m_nInterpDims

protected

number of dimensions that are interpolated: SpaceDim - m_fixedDims.size()

◆ m_bdryOffset

IntVect FourthOrderMappedCFInterpStencil::m_bdryOffset

protected

displacement from domain boundary in each dimension, in range -(a_degree-1):(a_degree-1)

◆ m_stencilSize

int FourthOrderMappedCFInterpStencil::m_stencilSize

protected

number of coarse cells in the stencil

◆ m_numNonzeroPowers

int FourthOrderMappedCFInterpStencil::m_numNonzeroPowers

protected

number of nonzero powers

◆ m_stencilCells

Vector<IntVect> FourthOrderMappedCFInterpStencil::m_stencilCells

protected

length m_stencilSize, lists stencil cells

Referenced by cells().

◆ m_indices

Vector<int> FourthOrderMappedCFInterpStencil::m_indices

protected

length m_stencilSize*(SpaceDim-m_fixedDims.size()), lists indices of stencil cells, grouped by cell

Referenced by indices().

◆ m_indicesFull

Vector<int> FourthOrderMappedCFInterpStencil::m_indicesFull

protected

length m_stencilSize*SpaceDim, lists indices of stencil cells, grouped by cell

Referenced by indicesFull().

◆ m_avgPowers

Vector<Real> FourthOrderMappedCFInterpStencil::m_avgPowers

protected

length m_stencilSize*m_numNonzeroPowers, lists averages of <(x-x0)^p>j for stencil cells j, grouped by cell

Referenced by avgPowers().

◆ m_defined

bool FourthOrderMappedCFInterpStencil::m_defined

protected

whether define() has been called

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

FourthOrderMappedCFInterpStencil.H

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FourthOrderMappedCFInterpStencil() [1/3]

◆ FourthOrderMappedCFInterpStencil() [2/3]

◆ ~FourthOrderMappedCFInterpStencil()

◆ FourthOrderMappedCFInterpStencil() [3/3]

Member Function Documentation

◆ define()

◆ indices()

◆ indicesFull()

◆ cells()

◆ avgPowers()

◆ operator=()

Member Data Documentation

◆ m_degree

◆ m_fixedDims

◆ m_nInterpDims

◆ m_bdryOffset

◆ m_stencilSize

◆ m_numNonzeroPowers

◆ m_stencilCells

◆ m_indices

◆ m_indicesFull

◆ m_avgPowers

◆ m_defined