Implements conjugate gradient algorithm for energy-minimization. More...

#include <MueLu_CGSolver_decl.hpp>

Inheritance diagram for MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Iterate methods.
size_t	nIts_
	Number of performed iterations.

void	Iterate (const Matrix &A, const Constraint &C, const Matrix &P0, RCP< Matrix > &P) const
	Iterate.

Constructors / destructors
	CGSolver (size_t Its)

Additional Inherited Members
Public Member Functions inherited from MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	SolverBase ()

virtual	~SolverBase ()

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor.

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor.

VerbLevel	GetVerbLevel () const
	Get the verbosity level.

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object.

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose.

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing.

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type.

Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type.

Teuchos::FancyOStream &	GetBlackHole () const

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor.

virtual void	describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const

virtual std::string	description () const
	Return a simple one-line description of this object.

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object.

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace.

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level.

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level.

static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP< Teuchos::FancyOStream >	GetMueLuOStream ()

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Implements conjugate gradient algorithm for energy-minimization.

This is CG applied to the problem

\[ \min_P \frac12 \sum_i (p_i)^T A p_i \]

subject to

\[ P(i,j) = 0 \quad \mbox{if} \; (i,j) \mbox{ is not in SparsityPattern} \]

and

\[ P cnull = fnull. \]

Note: For now we assume, that matrices have real values. The case of complex values is not explored.

Definition at line 43 of file MueLu_CGSolver_decl.hpp.

Constructor & Destructor Documentation

◆ CGSolver()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CGSolver ( size_t Its )

Constructor

Parameters

Its	– Number of performed iterations

Definition at line 26 of file MueLu_CGSolver_def.hpp.

Member Function Documentation

◆ Iterate()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Iterate	(	const Matrix &	A,
		const Constraint &	C,
		const Matrix &	P0,
		RCP< Matrix > &	P
	)		const

virtual

Iterate.

Implements MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 30 of file MueLu_CGSolver_def.hpp.

Member Data Documentation

◆ nIts_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

size_t MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nIts_

private

Number of performed iterations.

Definition at line 67 of file MueLu_CGSolver_decl.hpp.

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

Iterate methods.

Constructors / destructors