Stencil Class Reference

#include <Stencil.h>

Public Types
enum	predefinedStencils {   identity, displacex, inversedisplacex, dplusx,   dminusx, dzerox, dnullx, dplusxdminusx }
enum	displayWhat { text =1, structure, both }

Public Member Functions
	Stencil ()
	Stencil (RealArray weights_, IntegerArray offsets_)
	Stencil (const Stencil &)
	Stencil (const predefinedStencils &choice)
	~Stencil ()
Stencil &	operator= (const Stencil &)
Stencil	operator() (const Stencil &) const
Stencil	operator* (Real d) const
Stencil	operator+ (const Stencil &) const
Stencil	operator- (const Stencil &) const
Stencil	operator- () const
Stencil	operator/ (Real d) const
void	operator+= (const Stencil &)
void	operator-= (const Stencil &)
void	operator*= (Real d)
void	operator/= (Real d)
void	addWeight (Real d, const Point &offset)
void	display (const aString &str="", displayWhat what=text, ostream &os=cout) const
void	displayText (const aString &str="", ostream &os=cout) const
void	displayStructure (const aString &str="", ostream &os=cout, int legend=FALSE) const
Stencil	rotate (int axis=axis3, int steps=1) const
RealMappedGridFunction &	applyStencil (const RealMappedGridFunction &sourceGF, RealMappedGridFunction &targetGF, const Index &I1, const Index &I2, const Index &I3, const Index &N) const
RealArray &	applyStencil (const RealArray &sourceGF, RealArray &targetGF, const Index &I1, const Index &I2, const Index &I3, const Index &N) const
void	makeCoefficients (CoefficientMatrix &coeff, const Index &I1, const Index &I2, const Index &I3, const int iE=0, const int iC=0) const
void	makeCoefficients (CoefficientMatrix &coeff, const Index &I1, const Index &I2, const Index &I3, const Index &C) const
void	conformOffsets (IntegerArray newOffsets)
IntegerArray	getWidth () const
int	offsetExist (const Point &p) const
int	offsetExist (const Point &p, int &i) const
Real	checkOrder (MappedGridOperators::derivativeTypes) const
void	removeZeros ()
void	test ()

Friends
ostream &	operator<< (ostream &os, const Stencil &s)

Member Enumeration Documentation

enum Stencil::displayWhat

Enumerator
text
structure
both

enum Stencil::predefinedStencils

Enumerator
identity
displacex
inversedisplacex
dplusx
dminusx
dzerox
dnullx
dplusxdminusx

Constructor & Destructor Documentation

Stencil::Stencil

(

)

Stencil::Stencil	(	RealArray	weights_,
		IntegerArray	offsets_
	)

References axis1, and axis2.

Stencil::Stencil

(

const Stencil &

s

)

Stencil::Stencil

(

const predefinedStencils &

choice

)

References displacex, dminusx, dnullx, dplusx, dplusxdminusx, dzerox, identity, inversedisplacex, and s.

Stencil::~Stencil

(

)

Member Function Documentation

void Stencil::addWeight	(	Real	d,
		const Point &	offset
	)

References End, nullIndex, and Start.

Referenced by conformOffsets(), operator()(), operator+(), operator+=(), operator-(), operator-=(), rotate(), and test().

RealMappedGridFunction & Stencil::applyStencil	(	const RealMappedGridFunction &	sourceGF,
		RealMappedGridFunction &	targetGF,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		const Index &	N
	)		const

References debug.

Referenced by checkOrder().

RealArray & Stencil::applyStencil	(	const RealArray &	sourceGF,
		RealArray &	targetGF,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		const Index &	N
	)		const

References debug.

Real Stencil::checkOrder

(

MappedGridOperators::derivativeTypes

type

)

const

NOTE: Remains: Treat other dims than x

References abs(), applyStencil(), axis1, debug, MappedGrid::dimension(), display(), getIndex(), MappedGrid::gridIndexRange(), MappedGrid::gridSpacing(), log(), max(), nullIndex, Mapping::setGridDimensions(), SQR, MappedGrid::update(), OGTrigFunction::x(), MappedGridOperators::xDerivative, OGTrigFunction::xx(), and MappedGridOperators::xxDerivative.

Referenced by test().

void Stencil::conformOffsets

(

IntegerArray

newOffsets

)

References addWeight(), axis1, nullIndex, and offsetExist().

void Stencil::display	(	const aString &	str = "",
		displayWhat	what = text,
		ostream &	os = cout
	)		const

References debug.

Referenced by checkOrder(), operator<<(), and test().

void Stencil::displayStructure	(	const aString &	str = "",
		ostream &	os = cout,
		int	legend = FALSE
	)		const

References axis1, axis2, axis3, End, and Start.

Referenced by test().

void Stencil::displayText	(	const aString &	str = "",
		ostream &	os = cout
	)		const

IntegerArray Stencil::getWidth

(

)

const

void Stencil::makeCoefficients	(	CoefficientMatrix &	coeff,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		const int	iE = 0,
		const int	iC = 0
	)		const

References assert, axis2, axis3, debug, End, NULL, S, SQR, and Start.

void Stencil::makeCoefficients	(	CoefficientMatrix &	coeff,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		const Index &	C
	)		const

References C, and debug.

int Stencil::offsetExist

(

const Point &

p

)

const

Referenced by conformOffsets().

int Stencil::offsetExist	(	const Point &	p,
		int &	i
	)		const

Stencil Stencil::operator()

(

const Stencil &

s

)

const

References addWeight(), debug, nullIndex, and s.

Stencil Stencil::operator*

(

Real

d

)

const

void Stencil::operator*=

(

Real

d

)

Stencil Stencil::operator+

(

const Stencil &

s

)

const

References addWeight(), and nullIndex.

void Stencil::operator+=

(

const Stencil &

s

)

References addWeight(), and nullIndex.

Stencil Stencil::operator-

(

const Stencil &

s

)

const

References addWeight(), and nullIndex.

Stencil Stencil::operator-

(

)

const

void Stencil::operator-=

(

const Stencil &

s

)

References addWeight(), and nullIndex.

Stencil Stencil::operator/

(

Real

d

)

const

void Stencil::operator/=

(

Real

d

)

Stencil & Stencil::operator=

(

const Stencil &

s

)

void Stencil::removeZeros

(

)

Stencil Stencil::rotate	(	int	axis = axis3,
		int	steps = 1
	)		const

References addWeight(), debug, nullIndex, and x.

Referenced by test().

void Stencil::test

(

)

References addWeight(), axis1, axis2, checkOrder(), displacex, display(), displayStructure(), dminusx, dnullx, dplusx, dplusxdminusx, dzerox, identity, inversedisplacex, nullIndex, q, rotate(), S, S1, S2, doubleMappedGridFunction::setIsACoefficientMatrix(), SQR, TRUE, MappedGridOperators::xDerivative, and MappedGridOperators::xxDerivative.

Friends And Related Function Documentation

ostream& operator<< ( ostream &  os, const Stencil &  s  )

friend

---

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

• Stencil.h
• Stencil.C