Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

StencilCollection Class Reference

collection of stencils. More...

#include <StencilCollection.h>

Inheritance diagram for StencilCollection::

Public Methods
	StencilCollection ()
	StencilCollection (int nsd, int nstencils, int ndofs)
	~StencilCollection ()
void	redim (int nsd, int nstencils, int ndofs)
const VecSimplest(Handle(Stencil))&	operator() (int node_dof) const
VecSimplest(Handle(Stencil))&	operator() (int node_dof)
const Stencil&	getStencil (int stencil_no, int node_dof=1) const
Stencil&	getStencil (int stencil_no, int node_dof=1)
int	getNoStencils ()
int	getNoNodeDofs ()
void	insert (Stencil &stencil, int stencil_no, int node_dof, bool allocate=true)
void	print (Os os)
bool	ok () const
Protected Attributes
VecSimplest(VecSimplest(Handle(Stencil)))	stencils
Handle(Stencil_prm)	spm

Detailed Description

collection of stencils.

NAME: StencilCollection - collection of stencils

DESCRIPTION:

The class gives a simplified interface to a vector of stencils.

Constructor & Destructor Documentation

StencilCollection::StencilCollection ( ) [inline]

A specialized constructor takes the number of stencils and the number of degrees of freedom. An empty constructor is also offered, and this requires a call to the redim function taking the number of stencils and the number of degrees of freedom. (The number of stencils is same for all degrees of freedom.)

StencilCollection::StencilCollection ( int nsd,

int nstencils,

int ndofs )

StencilCollection::~StencilCollection ( )

Member Function Documentation

int StencilCollection::getNoNodeDofs ( ) [inline]

int StencilCollection::getNoStencils ( ) [inline]

returns the number of stencils for each degree of freedom.

Stencil & StencilCollection::getStencil ( int stencil_no,

int node_dof = 1 )

See documentation of one of the overloaded functions.

const Stencil & StencilCollection::getStencil ( int stencil_no,

int node_dof = 1 ) const

returns the stencil in entry number 'stencil_no' for the given degree of freedom.

void StencilCollection::insert ( Stencil & stencil,

int stencil_no,

int node_dof,

bool allocate = true )

inserts the given stencil in the entry corresponding to the given stencil number for the given node dof. Note that if the supplied stencil's own node_dof number has not been initialized, the node_dof number will be automatically set to the node dof that this stencil belongs to in the collection. In order to avoid confusion when automatically setting this value, the function will by default make a copy of the stencil for attachment in the collection instead of attaching the supplied stencil directly. One may set the allocation flag to false, leading to a direct attachment of the stencils, but this feature should only be used with great caution as the automatic initialization of the stencil's node dof value may cause problems.

bool StencilCollection::ok ( ) const

VecSimplest(Handle(Stencil)) & StencilCollection::operator() ( int node_dof )

const VecSimplest(Handle(Stencil)) & StencilCollection::operator() ( int node_dof ) const

void StencilCollection::print ( Os os )

void StencilCollection::redim ( int nsd,

int nstencils,

int ndofs )

Member Data Documentation

Handle(Stencil_prm) StencilCollection::spm [protected]

VecSimplest(VecSimplest(Handle(Stencil))) StencilCollection::stencils [protected]

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

StencilCollection.h