Nonlinear Jacobi-method. More...

#include <nl_jacobi.h>

Inheritance diagram for ug::NLJacobiSolver< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type
	Algebra type.

typedef TAlgebra::matrix_type	matrix_type
	Matrix type.

typedef TAlgebra::vector_type	vector_type
	Vector type.

Public Types inherited from ug::IOperatorInverse< 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 bool	apply (vector_type &u)
	apply Operator, i.e. op^{-1}(0) = u

virtual std::string	config_string () const
	returns information about configuration parameters

virtual bool	init (SmartPtr< IOperator< vector_type > > op)
	This operator inverts the Operator op: Y -> X.

	NLJacobiSolver ()
	default constructor

	NLJacobiSolver (SmartPtr< IConvergenceCheck< vector_type > > spConvCheck)
	constructor

virtual bool	prepare (vector_type &u)
	prepare Operator

void	set_convergence_check (SmartPtr< IConvergenceCheck< vector_type > > spConvCheck)

void	set_damp (number damp)

Public Member Functions inherited from ug::IOperatorInverse< TAlgebra::vector_type >
virtual bool	init (SmartPtr< IOperator< TAlgebra::vector_type, TAlgebra::vector_type > > N)=0
	initializes the operator for the inversion of the operator N: Y -> X

virtual	~IOperatorInverse ()
	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 Types
typedef DebugWritingObject< TAlgebra >	base_writer_type

Private Member Functions

void	write_debug (const vector_type &vec, const char *filename)

void	write_debug (const matrix_type &mat, const char *filename)

Private Attributes
number	m_damp
	damping factor

int	m_dgbCall
	call counter

SmartPtr< IAssemble< TAlgebra > >	m_spAss

SmartPtr< AssembledOperator< algebra_type > >	m_spAssOp

SmartPtr< IConvergenceCheck< vector_type > >	m_spConvCheck

SmartPtr< AssembledLinearOperator< algebra_type > >	m_spJ

Additional Inherited Members
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 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.

Detailed Description

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

Nonlinear Jacobi-method.

Let L(u) denote a nonlinear functional of n components (l_1,...,l_n). Then the basic step of the nonlinear Jacobi method is to solve the i-th equation

l_i(u_1^{k},...,u_{i-1}^{k},u_i,u_{i+1}^{k},...,u_{n}^{k}) = 0

for u_i and to set u_i^{k+1} = u_i. Here k denotes the iteration-index. Thus, in order to obtain u^{k+1} from u^k, we solve successively the n dimensional nonlinear equations for i = 1,...,n. Here this is done by a scalar newton step for every i. But every other scalar nonlinear method could be applied as well.

Using a damped version of the nonlinear jacobi method results in the following update of the variables

u_i^{k+1} = u_i^k + damp * (u_i -u_i^k).

References:

J. M. Ortega and W. C. Rheinbolt. Iterative Solution of nonlinear equations in several variables.(1970)

Template Parameters

TAlgebra Algebra type

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::NLJacobiSolver< TAlgebra >::algebra_type

Algebra type.

◆ base_writer_type

template<typename TAlgebra >

typedef DebugWritingObject<TAlgebra> ug::NLJacobiSolver< TAlgebra >::base_writer_type

protected

◆ matrix_type

template<typename TAlgebra >

typedef TAlgebra::matrix_type ug::NLJacobiSolver< TAlgebra >::matrix_type

Matrix type.

◆ vector_type

template<typename TAlgebra >

typedef TAlgebra::vector_type ug::NLJacobiSolver< TAlgebra >::vector_type

Vector type.

Constructor & Destructor Documentation

◆ NLJacobiSolver() [1/2]

template<typename TAlgebra >

ug::NLJacobiSolver< TAlgebra >::NLJacobiSolver ( )

default constructor

◆ NLJacobiSolver() [2/2]

template<typename TAlgebra >

ug::NLJacobiSolver< TAlgebra >::NLJacobiSolver ( SmartPtr< IConvergenceCheck< vector_type > > spConvCheck )

constructor

Member Function Documentation

◆ apply()

template<typename TAlgebra >

bool ug::NLJacobiSolver< TAlgebra >::apply ( vector_type & u )

virtual

apply Operator, i.e. op^{-1}(0) = u

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

References ug::InverseMatMult(), make_sp(), name, NL_JACOBI_PROFILE_BEGIN, NL_JACOBI_PROFILE_END, and UG_CATCH_THROW.

◆ config_string()

template<typename TAlgebra >

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

inlinevirtual

returns information about configuration parameters

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

References ug::ConfigShift(), ug::NLJacobiSolver< TAlgebra >::m_damp, and ug::NLJacobiSolver< TAlgebra >::m_spConvCheck.

◆ init()

template<typename TAlgebra >

bool ug::NLJacobiSolver< TAlgebra >::init ( SmartPtr< IOperator< vector_type > > op )

virtual

This operator inverts the Operator op: Y -> X.

References NL_JACOBI_PROFILE_BEGIN, and UG_THROW.

◆ prepare()

template<typename TAlgebra >

bool ug::NLJacobiSolver< TAlgebra >::prepare ( vector_type & u )

virtual

prepare Operator

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

◆ set_convergence_check()

template<typename TAlgebra >

void ug::NLJacobiSolver< TAlgebra >::set_convergence_check ( SmartPtr< IConvergenceCheck< vector_type > > spConvCheck )

◆ set_damp()

template<typename TAlgebra >

void ug::NLJacobiSolver< TAlgebra >::set_damp ( number damp )

inline

References ug::NLJacobiSolver< TAlgebra >::m_damp.

◆ write_debug() [1/2]

template<typename TAlgebra >

void ug::NLJacobiSolver< TAlgebra >::write_debug	(	const matrix_type &	mat,
		const char *	filename
	)

private

help functions for debug output

References name.

◆ write_debug() [2/2]

template<typename TAlgebra >

void ug::NLJacobiSolver< TAlgebra >::write_debug	(	const vector_type &	vec,
		const char *	filename
	)

private

help functions for debug output

References name.

Member Data Documentation

◆ m_damp

template<typename TAlgebra >

number ug::NLJacobiSolver< TAlgebra >::m_damp

private

damping factor

Referenced by ug::NLJacobiSolver< TAlgebra >::config_string(), and ug::NLJacobiSolver< TAlgebra >::set_damp().

◆ m_dgbCall

template<typename TAlgebra >

int ug::NLJacobiSolver< TAlgebra >::m_dgbCall

private

call counter

◆ m_spAss

template<typename TAlgebra >

SmartPtr<IAssemble<TAlgebra> > ug::NLJacobiSolver< TAlgebra >::m_spAss

private

◆ m_spAssOp

template<typename TAlgebra >

SmartPtr<AssembledOperator<algebra_type> > ug::NLJacobiSolver< TAlgebra >::m_spAssOp

private

◆ m_spConvCheck

template<typename TAlgebra >

SmartPtr<IConvergenceCheck<vector_type> > ug::NLJacobiSolver< TAlgebra >::m_spConvCheck

private

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

◆ m_spJ

template<typename TAlgebra >

SmartPtr<AssembledLinearOperator<algebra_type> > ug::NLJacobiSolver< TAlgebra >::m_spJ

private

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

ugbase/lib_disc/operator/non_linear_operator/nl_jacobi/nl_jacobi.h
ugbase/lib_disc/operator/non_linear_operator/nl_jacobi/nl_jacobi_impl.h

Public Types

Public Member Functions

Protected Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ algebra_type

◆ base_writer_type

◆ matrix_type

◆ vector_type

Constructor & Destructor Documentation

◆ NLJacobiSolver() [1/2]

◆ NLJacobiSolver() [2/2]

Member Function Documentation

◆ apply()

◆ config_string()

◆ init()

◆ prepare()

◆ set_convergence_check()

◆ set_damp()

◆ write_debug() [1/2]

◆ write_debug() [2/2]

Member Data Documentation

◆ m_damp

◆ m_dgbCall

◆ m_spAss

◆ m_spAssOp

◆ m_spConvCheck

◆ m_spJ