MueLu  Version of the Day
MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <MueLu_GMRESSolver_decl.hpp>

Inheritance diagram for MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Private Member Functions

void givapp (SC *c, SC *s, SC *v, int k) const
 

Private Attributes

size_t nIts_
 Number of performed iterations. More...
 

Constructors / destructors

 GMRESSolver (size_t Its)
 

Iterate methods.

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

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. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
VerbLevel GetVerbLevel () const
 Get the verbosity level. More...
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object. More...
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose. More...
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing. More...
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type. More...
 
Teuchos::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStream & GetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
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. More...
 
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. More...
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Implements conjugate gradient algorithm for energy-minimization.

This is GMRES 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 77 of file MueLu_GMRESSolver_decl.hpp.

Constructor & Destructor Documentation

◆ GMRESSolver()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GMRESSolver ( size_t  Its)

Constructor

Parameters
Its– Number of performed iterations

Definition at line 65 of file MueLu_GMRESSolver_def.hpp.

Member Function Documentation

◆ Iterate()

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

◆ givapp()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::givapp ( SC *  c,
SC *  s,
SC *  v,
int  k 
) const
private

Definition at line 70 of file MueLu_GMRESSolver_def.hpp.

Member Data Documentation

◆ nIts_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
size_t MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nIts_
private

Number of performed iterations.

Definition at line 104 of file MueLu_GMRESSolver_decl.hpp.


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