A preconditioner for the multi-grid context which is aware of the grid level it operates on. More...

#include <level_preconditioner_interface.h>

Inheritance diagram for ug::ILevelPreconditioner< TAlgebra >:

Public Member Functions
virtual void	grid_level_has_changed ()
	response to change in grid level

	ILevelPreconditioner ()
	constructor

	ILevelPreconditioner (const GridLevel &gl)
	constructor with grid level

	ILevelPreconditioner (const ILevelPreconditioner< TAlgebra > &parent)
	clone constructor

void	set_grid_level (const GridLevel &gl)
	set the grid level

Public Member Functions inherited from ug::IPreconditioner< TAlgebra >
virtual bool	apply (vector_type &c, const vector_type &d)
	compute new correction c = B*d

virtual bool	apply_update_defect (vector_type &c, vector_type &d)
	compute new correction c = Bd and update defect d:= d - Lc

SmartPtr< MatrixOperator< matrix_type, vector_type > >	approx_operator ()
	underlying matrix based operator used for the preconditioner

SmartPtr< MatrixOperator< matrix_type, vector_type > >	defect_operator ()
	underlying matrix based operator for calculation of defect

virtual bool	init (SmartPtr< ILinearOperator< vector_type > > J, const vector_type &u)
	implements the ILinearIterator-interface for matrix based preconditioner

bool	init (SmartPtr< ILinearOperator< vector_type > > L)
	implements the ILinearIterator-interface for matrix based preconditioner

bool	init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op)
	initializes the preconditioner for a matrix based operator

	IPreconditioner ()
	default constructor

	IPreconditioner (const IPreconditioner< TAlgebra > &parent)
	clone constructor

	IPreconditioner (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
	constructor setting debug writer

virtual void	set_approximation (SmartPtr< MatrixOperator< matrix_type, vector_type > > approx)

virtual	~IPreconditioner ()
	virtual destructor

Public Member Functions inherited from ug::ILinearIterator< TAlgebra::vector_type >
virtual SmartPtr< ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > >	clone ()=0
	clone

virtual std::string	config_string () const

SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > >	damping ()
	returns the scaling

	ILinearIterator ()
	constructor

	ILinearIterator (const ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > &parent)
	copy constructor

virtual bool	init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > J, const TAlgebra::vector_type &u)=0
	initialize for operator J(u) and linearization point u

virtual bool	init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > L)=0
	initialize for linear operator L

void	set_damp (number factor)
	sets the damping to a constant factor

void	set_damp (SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > spScaling)
	sets a scaling for the correction

virtual bool	supports_parallel () const=0
	returns if parallel solving is supported

virtual	~ILinearIterator ()
	virtual destructor

Public Member Functions inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	debug_writer ()
	returns the debug writer

ConstSmartPtr< IDebugWriter< algebra_type > >	debug_writer () const

bool	debug_writer_valid () const
	returns true if the debug writer is set

	DebugWritingObject ()

	DebugWritingObject (const DebugWritingObject< algebra_type > &parent)
	clone constructor

	DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)

virtual void	set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
	set debug writer

virtual	~DebugWritingObject ()
	virtual destructor

Public Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
virtual void	set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)
	set debug writer

SmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer ()
	returns the debug writer

ConstSmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer () const

bool	vector_debug_writer_valid () const
	returns true if the debug writer is set

	VectorDebugWritingObject ()

	VectorDebugWritingObject (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)

void	write_debug (const vector_type &vec, const char *filename)
	writing debug output for a vector (if debug writer set)

virtual	~VectorDebugWritingObject ()
	virtual destructor

Protected Attributes
GridLevel	m_gl

Protected Attributes inherited from ug::IPreconditioner< TAlgebra >
bool	m_bInit
	init flag indicating if init has been called

bool	m_bOtherApproxOperator

SmartPtr< MatrixOperator< matrix_type, vector_type > >	m_spApproxOperator
	underlying matrix based operator used for the preconditioner

SmartPtr< ILinearOperator< vector_type > >	m_spDefectOperator
	underlying matrix based operator for calculation of defect

Protected Attributes inherited from ug::ILinearIterator< TAlgebra::vector_type >
SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > >	m_spDamping
	the scaling

Protected Attributes inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	m_spDebugWriter
	Debug Writer.

Protected Attributes inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
SmartPtr< IVectorDebugWriter< vector_type > >	m_spVectorDebugWriter
	Debug Writer.

Additional Inherited Members
Public Types inherited from ug::IPreconditioner< TAlgebra >
typedef TAlgebra	algebra_type
	Algebra type.

typedef MatrixOperator< matrix_type, vector_type >	matrix_operator_type
	Matrix Operator type.

typedef TAlgebra::matrix_type	matrix_type
	Matrix type.

typedef TAlgebra::vector_type	vector_type
	Vector type.

Public Types inherited from ug::ILinearIterator< TAlgebra::vector_type >
typedef TAlgebra::vector_type	codomain_function_type
	Range space.

typedef TAlgebra::vector_type	domain_function_type
	Domain space.

Public Types inherited from ug::DebugWritingObject< TAlgebra >
typedef TAlgebra	algebra_type
	type of algebra

typedef TAlgebra::matrix_type	matrix_type
	type of matrix

typedef TAlgebra::vector_type	vector_type
	type of vector

Public Types inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
typedef TAlgebra::vector_type	vector_type
	type of vector

Protected Member Functions inherited from ug::IPreconditioner< TAlgebra >
virtual const char *	name () const =0
	returns the name of iterator

virtual bool	postprocess ()=0
	cleans the operator

virtual bool	preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)=0
	initializes the preconditioner

virtual bool	step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)=0
	computes a new correction c = B*d

Protected Member Functions inherited from ug::DebugWritingObject< TAlgebra >
void	enter_debug_writer_section (const char *secDir)
	enters a debugging section

void	enter_debug_writer_section (std::string secDir)
	enters a debugging section

void	leave_debug_writer_section ()
	leaves a debugging section

void	write_debug (const matrix_type &mat, const char *filename)
	write debug output for a matrix (if debug writer set)

void	write_debug (const matrix_type &mat, std::string name)
	write debug output for a matrix (if debug writer set)

Protected Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
void	enter_vector_debug_writer_section (const char *secDir)
	enters a debugging section

void	enter_vector_debug_writer_section (std::string secDir)
	enters a debugging section

void	leave_vector_debug_writer_section ()
	leaves a debugging section

void	print_debugger_message (const char *msg)
	prints a debugger message (listing all the sections)

void	print_debugger_message (std::string msg)
	prints a debugger message (listing all the sections)

virtual void	write_debug (const vector_type &vec, std::string name)
	writing debug output for a vector (if debug writer set)

Detailed Description

template<typename TAlgebra>
class ug::ILevelPreconditioner< TAlgebra >

A preconditioner for the multi-grid context which is aware of the grid level it operates on.

Constructor & Destructor Documentation

◆ ILevelPreconditioner() [1/3]

template<typename TAlgebra >

ug::ILevelPreconditioner< TAlgebra >::ILevelPreconditioner ( )

inline

constructor

◆ ILevelPreconditioner() [2/3]

template<typename TAlgebra >

ug::ILevelPreconditioner< TAlgebra >::ILevelPreconditioner ( const GridLevel & gl )

inline

constructor with grid level

◆ ILevelPreconditioner() [3/3]

template<typename TAlgebra >

ug::ILevelPreconditioner< TAlgebra >::ILevelPreconditioner ( const ILevelPreconditioner< TAlgebra > & parent )

inline

clone constructor

Member Function Documentation

◆ grid_level_has_changed()

template<typename TAlgebra >

virtual void ug::ILevelPreconditioner< TAlgebra >::grid_level_has_changed ( )

inlinevirtual

response to change in grid level

Referenced by ug::ILevelPreconditioner< TAlgebra >::set_grid_level().

◆ set_grid_level()

template<typename TAlgebra >

void ug::ILevelPreconditioner< TAlgebra >::set_grid_level ( const GridLevel & gl )

inline

set the grid level

References ug::ILevelPreconditioner< TAlgebra >::grid_level_has_changed(), and ug::ILevelPreconditioner< TAlgebra >::m_gl.

Referenced by ug::AssembledMultiGridCycle< TDomain, TAlgebra >::init_level_memory().

Member Data Documentation

◆ m_gl

template<typename TAlgebra >

GridLevel ug::ILevelPreconditioner< TAlgebra >::m_gl

protected

Referenced by ug::ILevelPreconditioner< TAlgebra >::set_grid_level().

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

ugbase/lib_disc/operator/linear_operator/level_preconditioner_interface.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ILevelPreconditioner() [1/3]

◆ ILevelPreconditioner() [2/3]

◆ ILevelPreconditioner() [3/3]

Member Function Documentation

◆ grid_level_has_changed()

◆ set_grid_level()

Member Data Documentation

◆ m_gl