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

The Belos::BlockCGSolMgr provides a powerful and fully-featured solver manager over the CG and BlockCG linear solver. More...

#include <BelosBlockCGSolMgr.hpp>

Inheritance diagram for Belos::BlockCGSolMgr< 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 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 maxIters_
int numIters_
int blockSize_
int verbosity_
int outputStyle_
int outputFreq_
bool adaptiveBlockSize_
bool showMaxResNormOnly_
std::string orthoType_
std::string label_
Teuchos::RCP< Teuchos::TimetimerSolve_
bool isSet_

BlockCGSolMgr Exceptions

static const MagnitudeType convtol_default_ = 1e-8
static const MagnitudeType orthoKappa_default_ = -1.0
static const int maxIters_default_ = 1000
static const bool adaptiveBlockSize_default_ = true
static const bool showMaxResNormOnly_default_ = false
static const int blockSize_default_ = 1
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

 BlockCGSolMgr ()
 Empty constructor for BlockCGSolMgr. 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. The solver values can be changed using setParameters().
 BlockCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for BlockCGSolMgr.
virtual ~BlockCGSolMgr ()
 Destructor.

Accessor methods

const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Return a reference to the linear problem being solved by this solver manager.
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 ()
 This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

Overridden from Teuchos::Describable

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

Detailed Description

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

The Belos::BlockCGSolMgr provides a powerful and fully-featured solver manager over the CG and BlockCG linear solver.

Author:
Heidi Thornquist, Chris Baker, and Teri Barth

Definition at line 111 of file BelosBlockCGSolMgr.hpp.


Member Typedef Documentation

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

Definition at line 114 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 115 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 116 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 117 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 118 of file BelosBlockCGSolMgr.hpp.


Constructor & Destructor Documentation

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

Empty constructor for BlockCGSolMgr. 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. The solver values can be changed using setParameters().

Definition at line 345 of file BelosBlockCGSolMgr.hpp.

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

Basic constructor for BlockCGSolMgr.

This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:

  • "Block Size" - an int specifying the block size to be used by the underlying block conjugate-gradient solver. Default: 1
  • "Adaptive Block Size" - a bool specifying whether the block size can be modified throughout the solve. Default: true
  • "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 std::string specifying the desired orthogonalization: DGKS ,ICGS, and IMGS. Default: "DGKS"
  • "Orthogonalization Constant" - a MagnitudeType used by DGKS orthogonalization to determine whether another step of classical Gram-Schmidt is necessary. Default: -1 (use DGKS default)
  • "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
  • "Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 364 of file BelosBlockCGSolMgr.hpp.

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

Destructor.

Definition at line 164 of file BelosBlockCGSolMgr.hpp.


Member Function Documentation

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

Return a reference to the linear problem being solved by this solver manager.

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

Definition at line 170 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::BlockCGSolMgr< 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 621 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<const Teuchos::ParameterList> Belos::BlockCGSolMgr< 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 180 of file BelosBlockCGSolMgr.hpp.

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 187 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::BlockCGSolMgr< 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 192 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::BlockCGSolMgr< 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 198 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::BlockCGSolMgr< 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 206 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGSolMgr< 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 391 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::BlockCGSolMgr< 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 219 of file BelosBlockCGSolMgr.hpp.

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

This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

This method calls BlockCGIter::iterate() or CGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

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

  • the maximum number of iterations 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 670 of file BelosBlockCGSolMgr.hpp.

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

Method to return description of the block CG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 907 of file BelosBlockCGSolMgr.hpp.


Member Data Documentation

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

Definition at line 257 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 260 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 261 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 264 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 265 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 266 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 267 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 270 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 273 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 276 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 277 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 278 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const bool Belos::BlockCGSolMgr< ScalarType, MV, OP >::adaptiveBlockSize_default_ = true [static, private]

Definition at line 279 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const bool Belos::BlockCGSolMgr< ScalarType, MV, OP >::showMaxResNormOnly_default_ = false [static, private]

Definition at line 280 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::BlockCGSolMgr< ScalarType, MV, OP >::blockSize_default_ = 1 [static, private]

Definition at line 281 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 282 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 283 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 284 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 285 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 286 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 287 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 290 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 290 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 291 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 291 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::BlockCGSolMgr< ScalarType, MV, OP >::blockSize_ [private]

Definition at line 292 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 292 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 292 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 292 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::BlockCGSolMgr< ScalarType, MV, OP >::adaptiveBlockSize_ [private]

Definition at line 293 of file BelosBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::BlockCGSolMgr< ScalarType, MV, OP >::showMaxResNormOnly_ [private]

Definition at line 293 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 294 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 297 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 298 of file BelosBlockCGSolMgr.hpp.

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

Definition at line 301 of file BelosBlockCGSolMgr.hpp.


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