linear solver using the CG algorithm More...

#include <dune/fem/solver/cginverseoperator.hh>

Inheritance diagram for Dune::Fem::ConjugateGradientSolver< Operator >:

Public Types
typedef Operator	OperatorType
	type of the operators to invert More...

typedef OperatorType::DomainFieldType	DomainFieldType
	field type of the operator's domain vectors More...

typedef OperatorType::RangeFieldType	RangeFieldType
	field type of the operator's range vectors More...

typedef Dune::FieldTraits< RangeFieldType >::real_type	RealType

typedef OperatorType::DomainFunctionType	DomainFunctionType
	type of the operator's domain vectors More...

typedef OperatorType::RangeFunctionType	RangeFunctionType
	type of the operator's range vectors More...

typedef Fem::Operator< RangeFunctionType, DomainFunctionType >	PreconditionerType
	type of the preconditioner, maps from the range of the operator (the dual space) in it's domain More...

Public Member Functions
	ConjugateGradientSolver (const RealType &epsilon, unsigned int maxIterations, int errorMeasure, bool verbose)
	constructor More...

	ConjugateGradientSolver (const RealType &epsilon, unsigned int maxIterations, bool verbose, const ParameterReader &parameter=Parameter::container())

	ConjugateGradientSolver (RealType epsilon, unsigned int maxIterations, const ParameterReader &parameter=Parameter::container())
	constructor More...

void	solve (const OperatorType &op, const RangeFunctionType &b, DomainFunctionType &x) const
	solve More...

void	solve (const OperatorType &op, const PreconditionerType &p, const RangeFunctionType &b, DomainFunctionType &x) const
	solve More...

unsigned int	iterations () const
	number of iterations needed for last solve More...

void	setMaxIterations (unsigned int maxIterations)

double	averageCommTime () const
	return average communication time during last solve More...

Protected Attributes
const RealType	epsilon_

unsigned int	maxIterations_

int	errorMeasure_

const bool	verbose_

double	averageCommTime_

unsigned int	realCount_

Detailed Description

template<class Operator>
class Dune::Fem::ConjugateGradientSolver< Operator >

linear solver using the CG algorithm

Parameters

Operator type of the operator to invert

Member Typedef Documentation

◆ DomainFieldType

template<class Operator >

typedef OperatorType::DomainFieldType Dune::Fem::ConjugateGradientSolver< Operator >::DomainFieldType

field type of the operator's domain vectors

◆ DomainFunctionType

template<class Operator >

typedef OperatorType::DomainFunctionType Dune::Fem::ConjugateGradientSolver< Operator >::DomainFunctionType

type of the operator's domain vectors

◆ OperatorType

template<class Operator >

typedef Operator Dune::Fem::ConjugateGradientSolver< Operator >::OperatorType

type of the operators to invert

◆ PreconditionerType

template<class Operator >

typedef Fem::Operator< RangeFunctionType, DomainFunctionType > Dune::Fem::ConjugateGradientSolver< Operator >::PreconditionerType

type of the preconditioner, maps from the range of the operator (the dual space) in it's domain

◆ RangeFieldType

template<class Operator >

typedef OperatorType::RangeFieldType Dune::Fem::ConjugateGradientSolver< Operator >::RangeFieldType

field type of the operator's range vectors

◆ RangeFunctionType

template<class Operator >

typedef OperatorType::RangeFunctionType Dune::Fem::ConjugateGradientSolver< Operator >::RangeFunctionType

type of the operator's range vectors

◆ RealType

template<class Operator >

typedef Dune::FieldTraits< RangeFieldType >::real_type Dune::Fem::ConjugateGradientSolver< Operator >::RealType

Constructor & Destructor Documentation

◆ ConjugateGradientSolver() [1/3]

template<class Operator >

Dune::Fem::ConjugateGradientSolver< Operator >::ConjugateGradientSolver	(	const RealType &	epsilon,
		unsigned int	maxIterations,
		int	errorMeasure,
		bool	verbose
	)

inline

constructor

Parameters

[in]	epsilon	tolerance
[in]	maxIterations	maximum number of CG iterations
[in]	errorMeasure	use absolute (0) or relative (1) error
[in]	verbose	verbose output

◆ ConjugateGradientSolver() [2/3]

template<class Operator >

Dune::Fem::ConjugateGradientSolver< Operator >::ConjugateGradientSolver	(	const RealType &	epsilon,
		unsigned int	maxIterations,
		bool	verbose,
		const ParameterReader &	parameter = `Parameter::container()`
	)

inline

◆ ConjugateGradientSolver() [3/3]

template<class Operator >

Dune::Fem::ConjugateGradientSolver< Operator >::ConjugateGradientSolver	(	RealType	epsilon,
		unsigned int	maxIterations,
		const ParameterReader &	parameter = `Parameter::container()`
	)

inline

constructor

Parameters

[in]	epsilon	tolerance
[in]	maxIterations	maximum number of CG iterations

Member Function Documentation

◆ averageCommTime()

template<class Operator >

double Dune::Fem::ConjugateGradientSolver< Operator >::averageCommTime ( ) const

inline

return average communication time during last solve

◆ iterations()

template<class Operator >

unsigned int Dune::Fem::ConjugateGradientSolver< Operator >::iterations ( ) const

inline

number of iterations needed for last solve

◆ setMaxIterations()

template<class Operator >

void Dune::Fem::ConjugateGradientSolver< Operator >::setMaxIterations ( unsigned int maxIterations )

inline

◆ solve() [1/2]

template<class Operator >

void Dune::Fem::ConjugateGradientSolver< Operator >::solve	(	const OperatorType &	op,
		const PreconditionerType &	p,
		const RangeFunctionType &	b,
		DomainFunctionType &	x
	)		const

inline

solve

Note: The CG algorithm also works for positive semidefinite operators. In this case, $x \cdot v = b \cdot v$ for all in the operator's kernel.

Parameters

[in]	op	linear operator to invert (must be symmetic and positive definite)
[in]	p	(lef) preconditioning operator
[in]	b	right hand side
	x	solution (must be initialized to a start value)

◆ solve() [2/2]

template<class Operator >

void Dune::Fem::ConjugateGradientSolver< Operator >::solve	(	const OperatorType &	op,
		const RangeFunctionType &	b,
		DomainFunctionType &	x
	)		const

inline

solve

Note: The CG algorithm also works for positive semidefinite operators. In this case, $x \cdot v = b \cdot v$ for all in the operator's kernel.

Parameters

[in]	op	linear operator to invert (must be symmetic and positive definite)
[in]	b	right hand side
	x	solution (must be initialized to a start value)

Member Data Documentation

◆ averageCommTime_

template<class Operator >

double Dune::Fem::ConjugateGradientSolver< Operator >::averageCommTime_

mutableprotected

◆ epsilon_

template<class Operator >

const RealType Dune::Fem::ConjugateGradientSolver< Operator >::epsilon_

protected

◆ errorMeasure_

template<class Operator >

int Dune::Fem::ConjugateGradientSolver< Operator >::errorMeasure_

protected

◆ maxIterations_

template<class Operator >

unsigned int Dune::Fem::ConjugateGradientSolver< Operator >::maxIterations_

protected

◆ realCount_

template<class Operator >

unsigned int Dune::Fem::ConjugateGradientSolver< Operator >::realCount_

mutableprotected

◆ verbose_

template<class Operator >

const bool Dune::Fem::ConjugateGradientSolver< Operator >::verbose_

protected

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

cginverseoperator.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class Operator> class Dune::Fem::ConjugateGradientSolver< Operator >

Member Typedef Documentation

◆ DomainFieldType

◆ DomainFunctionType

◆ OperatorType

◆ PreconditionerType

◆ RangeFieldType

◆ RangeFunctionType

◆ RealType

Constructor & Destructor Documentation

◆ ConjugateGradientSolver() [1/3]

◆ ConjugateGradientSolver() [2/3]

◆ ConjugateGradientSolver() [3/3]

Member Function Documentation

◆ averageCommTime()

◆ iterations()

◆ setMaxIterations()

◆ solve() [1/2]

◆ solve() [2/2]

Member Data Documentation

◆ averageCommTime_

◆ epsilon_

◆ errorMeasure_

◆ maxIterations_

◆ realCount_

◆ verbose_

template<class Operator>
class Dune::Fem::ConjugateGradientSolver< Operator >