Belos Package Browser (Single Doxygen Collection) Development
Private Types | Private Member Functions | Private Attributes | Static Private Attributes
Belos::PCPGSolMgr< ScalarType, MV, OP > Class Template Reference

The Belos::PCPGSolMgr manages the PCPG linear solver. Three Hypotheses: First users must ensure that for each linear system has the same coefficient matrix! Second the seed space is invariant during an individual linear system solve. Third, due to finite precision arithmetic, the off-diaognal "P'AP" terms grow. More...

#include <BelosPCPGSolMgr.hpp>

Inheritance diagram for Belos::PCPGSolMgr< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

Private Types

typedef MultiVecTraits
< ScalarType, MV > 
MVT
typedef OperatorTraits
< ScalarType, MV, OP > 
OPT
typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
typedef Teuchos::ScalarTraits
< ScalarType >::magnitudeType 
MagnitudeType
typedef Teuchos::ScalarTraits
< MagnitudeType
MT

Private Member Functions

int ARRQR (int numVecs, int numOrthVecs, const Teuchos::SerialDenseMatrix< int, ScalarType > &D)

Private Attributes

Teuchos::RCP< LinearProblem
< ScalarType, MV, OP > > 
problem_
Teuchos::RCP< OutputManager
< ScalarType > > 
printer_
Teuchos::RCP< std::ostream > outputStream_
Teuchos::RCP< StatusTest
< ScalarType, MV, OP > > 
sTest_
Teuchos::RCP
< StatusTestMaxIters
< ScalarType, MV, OP > > 
maxIterTest_
Teuchos::RCP
< StatusTestGenResNorm
< ScalarType, MV, OP > > 
convTest_
Teuchos::RCP< StatusTestOutput
< ScalarType, MV, OP > > 
outputTest_
Teuchos::RCP< MatOrthoManager
< ScalarType, MV, OP > > 
ortho_
Teuchos::RCP< ParameterListparams_
MagnitudeType convtol_
MagnitudeType orthoKappa_
int numIters_
int maxIters_
int deflatedBlocks_
int savedBlocks_
int verbosity_
int outputStyle_
int outputFreq_
std::string orthoType_
Teuchos::RCP< MV > U_
Teuchos::RCP< MV > C_
Teuchos::RCP< MV > R_
int dimU_
std::string label_
Teuchos::RCP< Teuchos::TimetimerSolve_
bool isSet_

Static Private Attributes

static const MagnitudeType convtol_default_ = 1e-8
static const MagnitudeType orthoKappa_default_ = -1.0
static const int maxIters_default_ = 1000
static const int deflatedBlocks_default_ = 2
static const int savedBlocks_default_ = 16
static const int verbosity_default_ = Belos::Errors
static const int outputStyle_default_ = Belos::General
static const int outputFreq_default_ = -1
static const std::string label_default_ = "Belos"
static const std::string orthoType_default_ = "DGKS"
static const Teuchos::RCP
< std::ostream > 
outputStream_default_ = Teuchos::rcp(&std::cout,false)

Constructors/Destructor

 PCPGSolMgr ()
 Empty constructor for PCPGSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. In most instances, LinearProblem setProblem(...) methods are used. Solver values may be changed using setParameters().
 PCPGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for PCPGSolMgr. The constructor accepts a LinearProblem to be solved and a parameter list of these options:
virtual ~PCPGSolMgr ()
 Destructor.

Accessor methods

const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Get current linear problem being solved for in this object.
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 Get a parameter list containing the valid parameters for this object.
Teuchos::RCP< const
Teuchos::ParameterList
getCurrentParameters () const
 Get a parameter list containing the current parameters for this object.
Teuchos::Array< Teuchos::RCP
< Teuchos::Time > > 
getTimers () const
 Return the timers for this object.
int getNumIters () const
 Get the iteration count for the most recent call to solve().
bool isLOADetected () const
 Return whether a loss of accuracy was detected by this solver during the most current solve.

Set methods

void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
 Set the linear problem that needs to be solved.
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver manager should use to solve the linear problem.

Reset methods

void reset (const ResetType type)
 Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.

Solver application methods

ReturnType solve ()
 The method either solves the problem or decides to quit. On each call, a (possibly null) seed space is used to accelerate convergence.

Overridden from Teuchos::Describable

std::string description () const
 Method to return description of the PCPG solver manager.

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::PCPGSolMgr< ScalarType, MV, OP >

The Belos::PCPGSolMgr manages the PCPG linear solver. Three Hypotheses: First users must ensure that for each linear system has the same coefficient matrix! Second the seed space is invariant during an individual linear system solve. Third, due to finite precision arithmetic, the off-diaognal "P'AP" terms grow.

Author:
David Day

Definition at line 137 of file BelosPCPGSolMgr.hpp.


Member Typedef Documentation

template<class ScalarType, class MV, class OP>
typedef MultiVecTraits<ScalarType,MV> Belos::PCPGSolMgr< ScalarType, MV, OP >::MVT [private]

Definition at line 140 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef OperatorTraits<ScalarType,MV,OP> Belos::PCPGSolMgr< ScalarType, MV, OP >::OPT [private]

Definition at line 141 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType> Belos::PCPGSolMgr< ScalarType, MV, OP >::SCT [private]

Definition at line 142 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP >::MagnitudeType [private]

Definition at line 143 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<MagnitudeType> Belos::PCPGSolMgr< ScalarType, MV, OP >::MT [private]

Definition at line 144 of file BelosPCPGSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::PCPGSolMgr< ScalarType, MV, OP >::PCPGSolMgr ( )

Empty constructor for PCPGSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. In most instances, LinearProblem setProblem(...) methods are used. Solver values may be changed using setParameters().

Definition at line 385 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Belos::PCPGSolMgr< ScalarType, MV, OP >::PCPGSolMgr ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Teuchos::ParameterList > &  pl 
)

Basic constructor for PCPGSolMgr. The constructor accepts a LinearProblem to be solved and a parameter list of these options:

  • "Num Deflated Blocks" - a int specifying the number of blocks deflated from the linear system. Default: 2 The parameter distinguishes PCPG from CG.
  • "Num Saved Blocks" - a int specifying the maximum number of blocks saved from old Krylov bases. Default: 16 The parameter distinguishes PCPG from CG.
  • "Block Size" - an int specifying the block size to be used by the underlying block conjugate-gradient solver. In PCPC block size = one. Many parameters are meaningless in the unit block size case. Default: 1
  • "Adaptive Block Size" - a bool specifying whether the block size can be modified throughout the solve. Default: true Meaningless with unit block size
  • "Maximum Iterations" - an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000
  • "Convergence Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence. Default: 1e-8.
  • "Orthogonalization" - a string specifying the desired orthogonalization: DGKS, ICGS, IMGS. Default: "DGKS" Meaningless with unit block size
  • "Orthogonalization Constant" - a MagnitudeType used by DGKS orthogonalization to determine whether another step of classical Gram-Schmidt is necessary. Default: -1 (use DGKS default) Meaningless with unit block size
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
  • "Output Style" - a OutputType specifying the style of output. Default: Belos::General
  • "Output Stream" - a reference-counted pointer to the output stream where all solver output is sent. Default: Teuchos::rcp(&std::cout,false)
  • "Output Frequency" - an int specifying how often convergence information should be outputted. Default: -1 (never)
  • "Show Maximum Residual Norm Only" - a bool specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: false Meaningless with unit block size
  • "Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 403 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
virtual Belos::PCPGSolMgr< ScalarType, MV, OP >::~PCPGSolMgr ( ) [inline, virtual]

Destructor.

Definition at line 198 of file BelosPCPGSolMgr.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
const LinearProblem<ScalarType,MV,OP>& Belos::PCPGSolMgr< ScalarType, MV, OP >::getProblem ( ) const [inline, virtual]

Get current linear problem being solved for in this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 206 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::PCPGSolMgr< ScalarType, MV, OP >::getValidParameters ( ) const [virtual]

Get a parameter list containing the valid parameters for this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 653 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<const Teuchos::ParameterList> Belos::PCPGSolMgr< ScalarType, MV, OP >::getCurrentParameters ( ) const [inline, virtual]

Get a parameter list containing the current parameters for this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 216 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::PCPGSolMgr< ScalarType, MV, OP >::getTimers ( ) const [inline]

Return the timers for this object.

The timers are ordered as follows:

Definition at line 223 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::getNumIters ( ) const [inline, virtual]

Get the iteration count for the most recent call to solve().

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 228 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::PCPGSolMgr< ScalarType, MV, OP >::isLOADetected ( ) const [inline, virtual]

Return whether a loss of accuracy was detected by this solver during the most current solve.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 234 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::PCPGSolMgr< ScalarType, MV, OP >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem) [inline, virtual]

Set the linear problem that needs to be solved.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 242 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PCPGSolMgr< ScalarType, MV, OP >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params) [virtual]

Set the parameters the solver manager should use to solve the linear problem.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 430 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::PCPGSolMgr< ScalarType, MV, OP >::reset ( const ResetType  type) [inline, virtual]

Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 255 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::PCPGSolMgr< ScalarType, MV, OP >::solve ( ) [virtual]

The method either solves the problem or decides to quit. On each call, a (possibly null) seed space is used to accelerate convergence.

The method calls PCPGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown. The first Krylov vectors are appended to the seed space.

A return from PCPGIter::iterate() signifies one of the following scenarios:

  • the maximum number of restarts has been exceeded. In this scenario, the current solutions to the linear system will be placed in the linear problem and return Unconverged.
  • global convergence has been met. In this case, the current solutions to the linear system will be placed in the linear problem and the solver manager will return Converged
Returns:
ReturnType specifying:
  • Converged: the linear problem was solved to the specification required by the solver manager.
  • Unconverged: the linear problem was not solved to the specification desired by the solver manager.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 697 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
std::string Belos::PCPGSolMgr< ScalarType, MV, OP >::description ( ) const [virtual]

Method to return description of the PCPG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1155 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PCPGSolMgr< ScalarType, MV, OP >::ARRQR ( int  numVecs,
int  numOrthVecs,
const Teuchos::SerialDenseMatrix< int, ScalarType > &  D 
) [private]

Definition at line 1046 of file BelosPCPGSolMgr.hpp.


Member Data Documentation

template<class ScalarType, class MV, class OP>
Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::problem_ [private]

Definition at line 297 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<OutputManager<ScalarType> > Belos::PCPGSolMgr< ScalarType, MV, OP >::printer_ [private]

Definition at line 300 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<std::ostream> Belos::PCPGSolMgr< ScalarType, MV, OP >::outputStream_ [private]

Definition at line 301 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::sTest_ [private]

Definition at line 304 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestMaxIters<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::maxIterTest_ [private]

Definition at line 305 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestGenResNorm<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::convTest_ [private]

Definition at line 306 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::outputTest_ [private]

Definition at line 307 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<MatOrthoManager<ScalarType,MV,OP> > Belos::PCPGSolMgr< ScalarType, MV, OP >::ortho_ [private]

Definition at line 310 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<ParameterList> Belos::PCPGSolMgr< ScalarType, MV, OP >::params_ [private]

Definition at line 313 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const PCPGSolMgr< ScalarType, MV, OP >::MagnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP >::convtol_default_ = 1e-8 [static, private]

Definition at line 316 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const PCPGSolMgr< ScalarType, MV, OP >::MagnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP >::orthoKappa_default_ = -1.0 [static, private]

Definition at line 317 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::maxIters_default_ = 1000 [static, private]

Definition at line 318 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::deflatedBlocks_default_ = 2 [static, private]

Definition at line 319 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::savedBlocks_default_ = 16 [static, private]

Definition at line 320 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::verbosity_default_ = Belos::Errors [static, private]

Definition at line 321 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::outputStyle_default_ = Belos::General [static, private]

Definition at line 322 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::PCPGSolMgr< ScalarType, MV, OP >::outputFreq_default_ = -1 [static, private]

Definition at line 323 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const std::string Belos::PCPGSolMgr< ScalarType, MV, OP >::label_default_ = "Belos" [static, private]

Definition at line 324 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const std::string Belos::PCPGSolMgr< ScalarType, MV, OP >::orthoType_default_ = "DGKS" [static, private]

Definition at line 325 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const Teuchos::RCP< std::ostream > Belos::PCPGSolMgr< ScalarType, MV, OP >::outputStream_default_ = Teuchos::rcp(&std::cout,false) [static, private]

Definition at line 326 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
MagnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP >::convtol_ [private]

Definition at line 329 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
MagnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP >::orthoKappa_ [private]

Definition at line 329 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::numIters_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::maxIters_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::deflatedBlocks_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::savedBlocks_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::verbosity_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::outputStyle_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::outputFreq_ [private]

Definition at line 330 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::PCPGSolMgr< ScalarType, MV, OP >::orthoType_ [private]

Definition at line 331 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<MV> Belos::PCPGSolMgr< ScalarType, MV, OP >::U_ [private]

Definition at line 334 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<MV> Belos::PCPGSolMgr< ScalarType, MV, OP >::C_ [private]

Definition at line 334 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<MV> Belos::PCPGSolMgr< ScalarType, MV, OP >::R_ [private]

Definition at line 334 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PCPGSolMgr< ScalarType, MV, OP >::dimU_ [private]

Definition at line 337 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::PCPGSolMgr< ScalarType, MV, OP >::label_ [private]

Definition at line 340 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<Teuchos::Time> Belos::PCPGSolMgr< ScalarType, MV, OP >::timerSolve_ [private]

Definition at line 341 of file BelosPCPGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::PCPGSolMgr< ScalarType, MV, OP >::isSet_ [private]

Definition at line 344 of file BelosPCPGSolMgr.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines