operator implementation of the DD Schur complement solver More...

#include <schur_precond.h>

Inheritance diagram for ug::SchurPrecond< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type

typedef IPreconditioner< TAlgebra >	base_type
	Base type.

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::vector_type	vector_type

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

Public Member Functions
virtual SmartPtr< ILinearIterator< vector_type > >	clone ()
	clone

virtual std::string	config_string () const

size_t	num_global_skeleton ()

size_t	num_local_skeleton ()

	SchurPrecond ()
	constructor

	SchurPrecond (const SchurPrecond< TAlgebra > &parent)

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

void	set_dirichlet_solver (SmartPtr< ILinearOperatorInverse< vector_type > > dirichletSolver)
	sets the Dirichlet solver (forward to Schur complement)

void	set_schur_complement_operator (SmartPtr< SchurComplementOperator< algebra_type > > scop)

void	set_skeleton_solver (SmartPtr< ISchurComplementInverse< algebra_type > > skeletonSolver)
	sets the coarse problem solver

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 >
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	~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	~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 Member Functions
virtual const char *	name () const
	name of solver

virtual bool	postprocess ()
	cleans the operator

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

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

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

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)

Protected Attributes
SmartPtr< vector_type >	m_aux_rhs [2]

SmartPtr< vector_type >	m_aux_sol [2]

size_t	m_myMasterSkeleton

size_t	m_myTotalSkeleton

SmartPtr< MatrixOperator< matrix_type, vector_type > >	m_pA

SmartPtr< ILinearOperatorInverse< vector_type > >	m_spDirichletSolver
	Solver Dirichlet problems \(A_{II}\) (also used in Schur complement)

SmartPtr< SchurComplementOperator< algebra_type > >	m_spSchurComplementOp
	Local Schur complement for each subdomain.

SmartPtr< ISchurComplementInverse< TAlgebra > >	m_spSkeletonSolver
	Solver for coarse (skeleton) problem.

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.

Private Member Functions
bool	check_requirements ()

bool	create_and_init_local_schur_complement (SmartPtr< MatrixOperator< matrix_type, vector_type > > A, std::vector< schur_slice_desc_type > &skeletonMark)

void	create_aux_vectors (const vector_type &d)

void	get_skeleton_slicing (SmartPtr< MatrixOperator< matrix_type, vector_type > > A, std::vector< schur_slice_desc_type > &skeletonMark)

void	init_skeleton_solver ()

void	schur_solve_skeleton (vector_type &u_skeleton, const vector_type &f_skeleton)

void	schur_solver_backward (vector_type &u_inner, vector_type &f_inner, vector_type &u_skeleton)

void	schur_solver_forward (vector_type &u_inner, vector_type &f_inner)

Detailed Description

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

operator implementation of the DD Schur complement solver

This operator implements a Schur complement solver

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::SchurPrecond< TAlgebra >::algebra_type

◆ base_type

template<typename TAlgebra >

typedef IPreconditioner<TAlgebra> ug::SchurPrecond< TAlgebra >::base_type

Base type.

◆ matrix_type

template<typename TAlgebra >

typedef TAlgebra::matrix_type ug::SchurPrecond< TAlgebra >::matrix_type

◆ vector_type

template<typename TAlgebra >

typedef TAlgebra::vector_type ug::SchurPrecond< TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ SchurPrecond() [1/2]

template<typename TAlgebra >

ug::SchurPrecond< TAlgebra >::SchurPrecond ( )

constructor

References ug::SchurPrecond< TAlgebra >::m_aux_rhs, ug::SchurPrecond< TAlgebra >::m_aux_sol, and SPNULL.

◆ SchurPrecond() [2/2]

template<typename TAlgebra >

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

inline

References ug::SchurPrecond< TAlgebra >::m_spDirichletSolver, ug::SchurPrecond< TAlgebra >::m_spSchurComplementOp, and ug::SchurPrecond< TAlgebra >::m_spSkeletonSolver.

Member Function Documentation

◆ check_requirements()

template<typename TAlgebra >

bool ug::SchurPrecond< TAlgebra >::check_requirements ( )

private

References UG_LOG.

◆ clone()

template<typename TAlgebra >

virtual SmartPtr< ILinearIterator< vector_type > > ug::SchurPrecond< TAlgebra >::clone ( )

inlinevirtual

clone

Implements ug::ILinearIterator< TAlgebra::vector_type >.

References make_sp().

◆ config_string()

template<typename TAlgebra >

virtual std::string ug::SchurPrecond< TAlgebra >::config_string ( ) const

inlinevirtual

Reimplemented from ug::ILinearIterator< TAlgebra::vector_type >.

References ug::ILinearOperatorInverse< X, Y >::config_string(), ug::ConfigShift(), ug::SchurPrecond< TAlgebra >::m_spDirichletSolver, ug::SchurPrecond< TAlgebra >::m_spSkeletonSolver, ug::SchurPrecond< TAlgebra >::name(), and SmartPtr< T, FreePolicy >::valid().

◆ create_and_init_local_schur_complement()

template<typename TAlgebra >

bool ug::SchurPrecond< TAlgebra >::create_and_init_local_schur_complement	(	SmartPtr< MatrixOperator< matrix_type, vector_type > >	A,
		std::vector< schur_slice_desc_type > &	skeletonMark
	)

private

References make_sp(), SCHUR_PROFILE_BEGIN, ug::SchurDebug, UG_ASSERT, UG_CATCH_THROW, and UG_DLOG.

◆ create_aux_vectors()

template<typename TAlgebra >

void ug::SchurPrecond< TAlgebra >::create_aux_vectors ( const vector_type & d )

private

References make_sp(), ug::PST_ADDITIVE, ug::PST_CONSISTENT, ug::SchurDebug, ug::SD_INNER, ug::SD_SKELETON, and UG_DLOG.

◆ get_skeleton_slicing()

template<typename TAlgebra >

void ug::SchurPrecond< TAlgebra >::get_skeleton_slicing	(	SmartPtr< MatrixOperator< matrix_type, vector_type > >	A,
		std::vector< schur_slice_desc_type > &	skeletonMark
	)

private

References ug::MarkAllFromLayout(), ug::SD_INNER, and ug::SD_SKELETON.

◆ init_skeleton_solver()

template<typename TAlgebra >

void ug::SchurPrecond< TAlgebra >::init_skeleton_solver ( )

private

References SCHUR_PROFILE_BEGIN, UG_CATCH_THROW, and UG_THROW.

◆ name()

template<typename TAlgebra >

virtual const char * ug::SchurPrecond< TAlgebra >::name ( ) const

inlineprotectedvirtual

name of solver

Implements ug::IPreconditioner< TAlgebra >.

Referenced by ug::SchurPrecond< TAlgebra >::config_string().

◆ num_global_skeleton()

template<typename TAlgebra >

size_t ug::SchurPrecond< TAlgebra >::num_global_skeleton ( )

inline

returns the size of the skeleton problem note that this is the global size, i.e. without counting slaves

References ug::MatrixOperator< M, X, Y >::get_matrix(), ug::SchurPrecond< TAlgebra >::m_myMasterSkeleton, ug::SchurPrecond< TAlgebra >::m_pA, and PCL_RO_SUM.

◆ num_local_skeleton()

template<typename TAlgebra >

size_t ug::SchurPrecond< TAlgebra >::num_local_skeleton ( )

inline

returns the local skeleton size. note that the sum over these is bigger than num_global_skeleton, since this function includes also slaves

References ug::SchurPrecond< TAlgebra >::m_myTotalSkeleton.

◆ postprocess()

template<typename TAlgebra >

bool ug::SchurPrecond< TAlgebra >::postprocess ( )

protectedvirtual

cleans the operator

Implements ug::IPreconditioner< TAlgebra >.

References SPNULL.

◆ preprocess()

template<typename TAlgebra >

bool ug::SchurPrecond< TAlgebra >::preprocess ( SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp )

protectedvirtual

initializes the preconditioner

This method is used to initialize the preconditioner. Usually, here are performed computationally expensive operations, that should only be computed once for an underlying matrix (e.g. LU factorization), while the preconditioner will by applied (using 'step'-method) several times.

Parameters

[in] mat underlying matrix (i.e. L in L*u = f)