ThunderEgg::GMG::Level< D > Class Template Reference

Represents a level in geometric multi-grid. More...

#include <Level.h>

Public Member Functions
	Level ()
	Create a Level object.
void	setRestrictor (const Restrictor< D > &restrictor)
	Set the restriction operator for restricting from this level to the coarser level. More...
const Restrictor< D > &	getRestrictor () const
	Get the restriction operator for this level. More...
void	setInterpolator (const Interpolator< D > &interpolator)
	Set the interpolation operator for interpolating from this level to the finer level. More...
const Interpolator< D > &	getInterpolator () const
	Get the interpolation operator for this level. More...
void	setOperator (const Operator< D > &op)
	Set the operator (matrix) for this level. More...
const Operator< D > &	getOperator () const
	Get the operator for this level. More...
void	setSmoother (const Smoother< D > &smoother)
	Set the smoother for this level. More...
const Smoother< D > &	getSmoother () const
	Get smoother operator for this level. More...
void	setCoarser (std::shared_ptr< const Level > coarser)
	Set pointer to the coarser level. More...
const Level &	getCoarser () const
	get reference to the coarser level. More...
bool	finest () const
	Check if this level is the finest level. More...
bool	coarsest () const
	Check if this level is the coarsest level. More...

Detailed Description

template<int D>
class ThunderEgg::GMG::Level< D >

Represents a level in geometric multi-grid.

Member Function Documentation

coarsest()

template<int D>

bool ThunderEgg::GMG::Level< D >::coarsest ( ) const

inline

Check if this level is the coarsest level.

Returns

whether or not this level is the coarsest level.

finest()

template<int D>

bool ThunderEgg::GMG::Level< D >::finest ( ) const

inline

Check if this level is the finest level.

Returns

whether or not this level is the finest level.

getCoarser()

template<int D>

const Level& ThunderEgg::GMG::Level< D >::getCoarser ( ) const

inline

get reference to the coarser level.

Returns

reference to the coarser level.

getInterpolator()

template<int D>

const Interpolator<D>& ThunderEgg::GMG::Level< D >::getInterpolator ( ) const

inline

Get the interpolation operator for this level.

Returns

Reference to the interpolator.

getOperator()

template<int D>

const Operator<D>& ThunderEgg::GMG::Level< D >::getOperator ( ) const

inline

Get the operator for this level.

Returns

Pointer to the operator.

getRestrictor()

template<int D>

const Restrictor<D>& ThunderEgg::GMG::Level< D >::getRestrictor ( ) const

inline

Get the restriction operator for this level.

Returns

Reference to the restrictor

getSmoother()

template<int D>

const Smoother<D>& ThunderEgg::GMG::Level< D >::getSmoother ( ) const

inline

Get smoother operator for this level.

Returns

Pointer to the smoother operator.

setCoarser()

template<int D>

void ThunderEgg::GMG::Level< D >::setCoarser ( std::shared_ptr< const Level< D > >  coarser )

inline

Set pointer to the coarser level.

Parameters

coarser

the pointer to the coarser level.

setInterpolator()

template<int D>

void ThunderEgg::GMG::Level< D >::setInterpolator ( const Interpolator< D > &  interpolator )

inline

Set the interpolation operator for interpolating from this level to the finer level.

Parameters

interpolator

the interpolation operator.

setOperator()

template<int D>

void ThunderEgg::GMG::Level< D >::setOperator ( const Operator< D > &  op )

inline

Set the operator (matrix) for this level.

Parameters

op	the operator

setRestrictor()

template<int D>

void ThunderEgg::GMG::Level< D >::setRestrictor ( const Restrictor< D > &  restrictor )

inline

Set the restriction operator for restricting from this level to the coarser level.

Parameters

restrictor

the restriction operator.

setSmoother()

template<int D>

void ThunderEgg::GMG::Level< D >::setSmoother ( const Smoother< D > &  smoother )

inline

Set the smoother for this level.

Parameters

smoother

the smoother

---

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

• src/ThunderEgg/GMG/Level.h