Diffpack Documentation

---

              Search  

---

StencilWeight Class Reference

data structure for a specified point in a stencil. More...

#include <StencilWeight.h>

Inheritance diagram for StencilWeight::

List of all members.

Public Methods
	StencilWeight ()
	StencilWeight (const StencilWeight &p)
	~StencilWeight ()
void	getOffset (int &offset1) const
void	getOffset (int &offset1, int &offset2) const
void	getOffset (int &offset1, int &offset2, int &offset3) const
void	getOffset (Ptv(int) &off) const
void	fill (NUMT val)
void	operator= (NUMT val)
virtual void	fill (StencilWeightFunc &f)
virtual void	operator= (StencilWeightFunc &f)
void	operator= (const StencilWeight &p)
NUMT	eval (const Ptv(int) &index, int node_dof=0) const
void	activate ()
void	deactivate ()
bool	empty () const
Protected Methods
void	setOffset (Ptv(int) &of)
Protected Attributes
NUMT	w
bool	use_wf
bool	activated_weight
StencilWeightFunc*	usrf
Ptv(int)	offset
int	off1
int	off2
int	off3
Friends
class	Stencil
Os&	operator<< (Os &os, const StencilWeight &ptd)
Is&	operator>> (Is &is, StencilWeight &ptd)

---

Detailed Description

data structure for a specified point in a stencil.

NAME: StencilWeight - data structure for a specified point in a stencil

DESCRIPTION:

This class is used from the class "Stencil" and subclasses.

---

Constructor & Destructor Documentation

StencilWeight::StencilWeight ( )

The constructor requires no parameters and will always be called from the user class "Stencil". Initially, the point will have coefficient (or weight) constant 0 and the activation flag will be set to false. The weight may be activated by setting the activation flag to true, or by filling the weight with a value or a weight function. The weight will be deactivated by calling the deactivate function or by filling the weight with 0.

StencilWeight::StencilWeight ( const StencilWeight & p )

See documentation of one of the overloaded constructor.

StencilWeight::~StencilWeight ( ) [inline]

---

Member Function Documentation

void StencilWeight::activate ( ) [inline]

set the node to be active

void StencilWeight::deactivate ( ) [inline]

deactivate the node, that is, the node is now empty

bool StencilWeight::empty ( ) const

return true if the object is empty/un-active, otherwise false

NUMT StencilWeight::eval ( const Ptv(int) & index, int node_dof = 0 ) const

return the constant value "w" or call inserted functor "wf" using the point of evaluation.

void StencilWeight::fill ( StencilWeightFunc & f ) [virtual]

See documentation of one of the overloaded functions.

void StencilWeight::fill ( NUMT val )

insert a constant or variable weight for this point. This function automatically activates the node if the value inserted is different from 0 or if the objects is filled with a variable weight function. If the value set is 0, the objects is automatically deactivated.

void StencilWeight::getOffset ( Ptv(int) & off ) const [inline]

See documentation of one of the overloaded functions.

void StencilWeight::getOffset ( int & offset1, int & offset2, int & offset3 ) const

See documentation of one of the overloaded functions.

void StencilWeight::getOffset ( int & offset1, int & offset2 ) const

See documentation of one of the overloaded functions.

void StencilWeight::getOffset ( int & offset1 ) const [inline]

get the index-offset of the point.

void StencilWeight::operator= ( const StencilWeight & p )

void StencilWeight::operator= ( StencilWeightFunc & f ) [inline, virtual]

void StencilWeight::operator= ( NUMT val ) [inline]

void StencilWeight::setOffset ( Ptv(int) & of ) [protected]

---

Friends And Related Function Documentation

class Stencil [friend]

Os & operator<< ( Os & os, const StencilWeight & ptd ) [friend]

Is & operator>> ( Is & is, StencilWeight & ptd ) [friend]

---

Member Data Documentation

bool StencilWeight::activated_weight [protected]

int StencilWeight::off1 [protected]

int StencilWeight::off2 [protected]

int StencilWeight::off3 [protected]

Ptv(int) StencilWeight::offset [protected]

bool StencilWeight::use_wf [protected]

StencilWeightFunc * StencilWeight::usrf [protected]

NUMT StencilWeight::w [protected]

---

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

• StencilWeight.h

---