Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Belos::PCPGSolMgr< ScalarType, MV, OP, true > Class Template Reference

#include <BelosPCPGSolMgr.hpp>

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

Public Member Functions

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(). More...
 
 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: More...
 
virtual ~PCPGSolMgr ()
 Destructor. More...
 
virtual Teuchos::RCP
< SolverManager< ScalarType,
MV, OP > > 		clone () const
 clone for Inverted Injection (DII) More...
 
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 		getProblem () const
 Get current linear problem being solved for in this object. More...
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getValidParameters () const
 Get a parameter list containing the valid parameters for this object. More...
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getCurrentParameters () const
 Get a parameter list containing the current parameters for this object. More...
 
Teuchos::Array< Teuchos::RCP
< Teuchos::Time > > 		getTimers () const
 Return the timers for this object. More...
 
MagnitudeType achievedTol () const
 Tolerance achieved by the last solve() invocation. More...
 
int getNumIters () const
 Get the iteration count for the most recent call to solve(). More...
 
bool isLOADetected () const
 Return whether a loss of accuracy was detected by this solver during the most current solve. More...
 
Set methods
void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
 Set the linear problem that needs to be solved. More...
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver manager should use to solve the linear problem. More...
 
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. More...
 
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. More...
 
Overridden from Teuchos::Describable
std::string description () const
 Method to return description of the PCPG solver manager. More...
 
- Public Member Functions inherited from Belos::Details::SolverManagerRequiresRealLapack< ScalarType, MV, OP, true >
 SolverManagerRequiresRealLapack ()
 
virtual ~SolverManagerRequiresRealLapack ()
 
- Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
 SolverManager ()
 Empty constructor. More...
 
virtual ~SolverManager ()
 Destructor. More...
 
virtual void setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &=StatusTestCombo< ScalarType, MV, OP >::SEQ)
 Set user-defined convergence status test. More...
 
virtual void setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &)
 Set user-defined debug status test. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

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

Definition at line 181 of file BelosPCPGSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::PCPGSolMgr< ScalarType, MV, OP, true >::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 422 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Belos::PCPGSolMgr< ScalarType, MV, OP, true >::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: "ICGS" 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 443 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::PCPGSolMgr< ScalarType, MV, OP, true >::~PCPGSolMgr ( )
inlinevirtual

Destructor.

Definition at line 241 of file BelosPCPGSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual Teuchos::RCP<SolverManager<ScalarType, MV, OP> > Belos::PCPGSolMgr< ScalarType, MV, OP, true >::clone ( ) const
inlinevirtual

clone for Inverted Injection (DII)

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

Definition at line 244 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::PCPGSolMgr< ScalarType, MV, OP, true >::getProblem ( ) const
inlinevirtual

Get current linear problem being solved for in this object.

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

Definition at line 254 of file BelosPCPGSolMgr.hpp.

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

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

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

Definition at line 693 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::PCPGSolMgr< ScalarType, MV, OP, true >::getCurrentParameters ( ) const
inlinevirtual

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

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

Definition at line 264 of file BelosPCPGSolMgr.hpp.

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 271 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::PCPGSolMgr< ScalarType, MV, OP, true >::achievedTol ( ) const
inlinevirtual

Tolerance achieved by the last solve() invocation.

This is the maximum over all right-hand sides' achieved convergence tolerances, and is set whether or not the solve actually managed to achieve the desired convergence tolerance.

Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 280 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PCPGSolMgr< ScalarType, MV, OP, true >::getNumIters ( ) const
inlinevirtual

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

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

Definition at line 285 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::PCPGSolMgr< ScalarType, MV, OP, true >::isLOADetected ( ) const
inlinevirtual

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 291 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PCPGSolMgr< ScalarType, MV, OP, true >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem)
inlinevirtual

Set the linear problem that needs to be solved.

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

Definition at line 299 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PCPGSolMgr< ScalarType, MV, OP, true >::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 478 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PCPGSolMgr< ScalarType, MV, OP, true >::reset ( const ResetType  type)
inlinevirtual

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 312 of file BelosPCPGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::PCPGSolMgr< ScalarType, MV, OP, true >::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 736 of file BelosPCPGSolMgr.hpp.

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

Method to return description of the PCPG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1225 of file BelosPCPGSolMgr.hpp.

The documentation for this class was generated from the following file:
Generated on Thu Apr 25 2024 09:27:25 for Belos by doxygen 1.8.5