Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | List of all members
Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP > Class Template Reference

#include <Belos_PseudoBlockGmresIter_MP_Vector.hpp>

Inherits Iteration< Sacado::MP::Vector< Storage >, MV, OP >.

Public Types

typedef Sacado::MP::Vector< StorageScalarType
 
typedef MultiVecTraits< ScalarType, MV > MVT
 
typedef OperatorTraits< ScalarType, MV, OP > OPT
 
typedef Teuchos::ScalarTraits< ScalarTypeSCT
 
typedef SCT::magnitudeType MagnitudeType
 
typedef Teuchos::ScalarTraits< typename Storage::value_type > SVT
 

Accessor methods

const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > lp_
 
const Teuchos::RCP< OutputManager< ScalarType > > om_
 
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > stest_
 
const Teuchos::RCP< OrthoManager< ScalarType, MV > > ortho_
 
int numRHS_
 
int numBlocks_
 
Mask< MagnitudeTypelucky_breakdown_
 
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > > sn_
 
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, MagnitudeType > > > cs_
 
Teuchos::RCP< MV > U_vec_
 
Teuchos::RCP< MV > AU_vec_
 
Teuchos::RCP< MV > cur_block_rhs_
 
Teuchos::RCP< MV > cur_block_sol_
 
bool initialized_
 
int curDim_
 
int iter_
 
std::vector< Teuchos::RCP< MV > > V_
 
std::vector< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > H_
 
std::vector< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > R_
 
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > > Z_
 
SVT::magnitudeType breakDownTol_
 
const LinearProblem< ScalarType, MV, OP > & getProblem () const
 Get a constant reference to the linear problem.
 
int getBlockSize () const
 Get the blocksize to be used by the iterative solver in solving this linear problem.
 
void setBlockSize (int blockSize)
 Set the blocksize.
 
int getNumBlocks () const
 Get the maximum number of blocks used by the iterative solver in solving this linear problem.
 
void setNumBlocks (int numBlocks)
 Set the maximum number of blocks used by the iterative solver.
 
bool isInitialized ()
 States whether the solver has been initialized or not.
 

Constructors/Destructor

 PseudoBlockGmresIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > &ortho, Teuchos::ParameterList &params)
 PseudoBlockGmresIter constructor with linear problem, solver utilities, and parameter list of solver options.
 
virtual ~PseudoBlockGmresIter ()=default
 Destructor.
 

Solver methods

void iterate ()
 This method performs block Gmres iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
 
void initialize (const PseudoBlockGmresIterState< ScalarType, MV > &newstate)
 Initialize the solver to an iterate, providing a complete state.
 
void initialize ()
 Initialize the solver with the initial vectors from the linear problem or random data.
 
PseudoBlockGmresIterState< ScalarType, MV > getState () const
 Get the current state of the linear solver.
 

Status methods

int getNumIters () const
 Get the current iteration count.
 
void resetNumIters (int iter=0)
 Reset the iteration count.
 
Teuchos::RCP< const MV > getNativeResiduals (std::vector< MagnitudeType > *norms) const
 Get the norms of the "native" residual vectors.
 
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system.
 
void updateLSQR (int dim=-1)
 Method for updating QR factorization of upper Hessenberg matrix.
 
int getCurSubspaceDim () const
 Get the dimension of the search subspace used to generate the current solution to the linear problem.
 
int getMaxSubspaceDim () const
 Get the maximum dimension allocated for the search subspace.
 

Detailed Description

template<class Storage, class MV, class OP>
class Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >

Definition at line 72 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

Member Typedef Documentation

◆ ScalarType

template<class Storage , class MV , class OP >
typedef Sacado::MP::Vector<Storage> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::ScalarType

Definition at line 80 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ MVT

template<class Storage , class MV , class OP >
typedef MultiVecTraits<ScalarType,MV> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::MVT

Definition at line 81 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ OPT

template<class Storage , class MV , class OP >
typedef OperatorTraits<ScalarType,MV,OP> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::OPT

Definition at line 82 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ SCT

template<class Storage , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::SCT

Definition at line 83 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ MagnitudeType

template<class Storage , class MV , class OP >
typedef SCT::magnitudeType Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::MagnitudeType

Definition at line 84 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ SVT

template<class Storage , class MV , class OP >
typedef Teuchos::ScalarTraits<typename Storage::value_type> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::SVT

Definition at line 85 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

Constructor & Destructor Documentation

◆ PseudoBlockGmresIter()

template<class Storage , class MV , class OP >
Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::PseudoBlockGmresIter ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & problem,
const Teuchos::RCP< OutputManager< ScalarType > > & printer,
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & tester,
const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > & ortho,
Teuchos::ParameterList & params )

PseudoBlockGmresIter constructor with linear problem, solver utilities, and parameter list of solver options.

This constructor takes pointers required by the linear solver, in addition to a parameter list of options for the linear solver. These options include the following:

  • "Block Size" - an int specifying the block size used by the algorithm. This can also be specified using the setBlockSize() method. Default: 1
  • "Num Blocks" - an int specifying the maximum number of blocks allocated for the solver basis. Default: 25
  • "Restart Timers" = a bool specifying whether the timers should be restarted each time iterate() is called. Default: false

◆ ~PseudoBlockGmresIter()

template<class Storage , class MV , class OP >
virtual Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::~PseudoBlockGmresIter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ iterate()

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::iterate ( )

This method performs block Gmres iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

iterate() will first determine whether the solver is inintialized; if not, it will call initialize() using default arguments. After initialization, the solver performs block Gmres iterations until the status test evaluates as ::Passed, at which point the method returns to the caller.

The block Gmres iteration proceeds as follows:

  1. The operator problem->applyOp() is applied to the newest blockSize vectors in the Krylov basis.
  2. The resulting vectors are orthogonalized against the previous basis vectors, and made orthonormal.
  3. The Hessenberg matrix is updated.
  4. The least squares system is updated.

The status test is queried at the beginning of the iteration.

Possible exceptions thrown include the PseudoBlockGmresIterOrthoFailure.

◆ initialize() [1/2]

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::initialize ( const PseudoBlockGmresIterState< ScalarType, MV > & newstate)

Initialize the solver to an iterate, providing a complete state.

The PseudoBlockGmresIter contains a certain amount of state, consisting of the current Krylov basis and the associated Hessenberg matrix.

initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below. All notions of orthogonality and orthonormality are derived from the inner product specified by the orthogonalization manager.

Postcondition
isInitialized() == true (see post-conditions of isInitialize())

The user has the option of specifying any component of the state using initialize(). However, these arguments are assumed to match the post-conditions specified under isInitialized(). Any necessary component of the state not given to initialize() will be generated.

Note
For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

◆ initialize() [2/2]

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::initialize ( )
inline

Initialize the solver with the initial vectors from the linear problem or random data.

Definition at line 161 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getState()

template<class Storage , class MV , class OP >
PseudoBlockGmresIterState< ScalarType, MV > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getState ( ) const
inline

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns
A PseudoBlockGmresIterState object containing const pointers to the current solver state.

Definition at line 174 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getNumIters()

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getNumIters ( ) const
inline

Get the current iteration count.

Definition at line 199 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ resetNumIters()

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::resetNumIters ( int iter = 0)
inline

Reset the iteration count.

Definition at line 202 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getNativeResiduals()

template<class Storage , class MV , class OP >
Teuchos::RCP< const MV > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getNativeResiduals ( std::vector< MagnitudeType > * norms) const

Get the norms of the "native" residual vectors.

If norms != NULL, fill *norms with the native residual norms. There are numRHS_ of them. *norms will be resized if it has too few entries to hold the data.

For an explanation of "native" vs. "exact" (also known as "implicit" vs. "explicit") residuals, see the documentation of PseudoBlockGmresSolMgr::isLOADetected(). In brief: "Native" residuals are cheaper to compute than "exact" residuals, but the two may differ, especially when using a left preconditioner.

Returns
Teuchos::null (always, regardless whether norms == NULL). We only return something in order to satisfy the Iteration interface. PseudoBlockGmresSolMgr knows that this method always returns null.

◆ getCurrentUpdate()

template<class Storage , class MV , class OP >
Teuchos::RCP< MV > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getCurrentUpdate ( ) const

Get the current update to the linear system.

Note
Some solvers, like GMRES, do not compute updates to the solution every iteration. This method forces its computation. Other solvers, like CG, update the solution each iteration, so this method will return a zero vector indicating that the linear problem contains the current solution.

◆ updateLSQR()

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::updateLSQR ( int dim = -1)

Method for updating QR factorization of upper Hessenberg matrix.

Note
If dim >= getCurSubspaceDim() and dim < getMaxSubspaceDim(), then the dim-th equations of the least squares problem will be updated.

◆ getCurSubspaceDim()

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getCurSubspaceDim ( ) const
inline

Get the dimension of the search subspace used to generate the current solution to the linear problem.

Definition at line 238 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getMaxSubspaceDim()

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getMaxSubspaceDim ( ) const
inline

Get the maximum dimension allocated for the search subspace.

Definition at line 244 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getProblem()

template<class Storage , class MV , class OP >
const LinearProblem< ScalarType, MV, OP > & Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getProblem ( ) const
inline

Get a constant reference to the linear problem.

Definition at line 253 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getBlockSize()

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getBlockSize ( ) const
inline

Get the blocksize to be used by the iterative solver in solving this linear problem.

Definition at line 256 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ setBlockSize()

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::setBlockSize ( int blockSize)
inline

Set the blocksize.

Definition at line 259 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ getNumBlocks()

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::getNumBlocks ( ) const
inline

Get the maximum number of blocks used by the iterative solver in solving this linear problem.

Definition at line 265 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ setNumBlocks()

template<class Storage , class MV , class OP >
void Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::setNumBlocks ( int numBlocks)

Set the maximum number of blocks used by the iterative solver.

◆ isInitialized()

template<class Storage , class MV , class OP >
bool Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::isInitialized ( )
inline

States whether the solver has been initialized or not.

Definition at line 271 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

Member Data Documentation

◆ lp_

template<class Storage , class MV , class OP >
const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::lp_
private

Definition at line 280 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ om_

template<class Storage , class MV , class OP >
const Teuchos::RCP<OutputManager<ScalarType> > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::om_
private

Definition at line 281 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ stest_

template<class Storage , class MV , class OP >
const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::stest_
private

Definition at line 282 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ ortho_

template<class Storage , class MV , class OP >
const Teuchos::RCP<OrthoManager<ScalarType,MV> > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::ortho_
private

Definition at line 283 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ numRHS_

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::numRHS_
private

Definition at line 289 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ numBlocks_

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::numBlocks_
private

Definition at line 291 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ lucky_breakdown_

template<class Storage , class MV , class OP >
Mask<MagnitudeType> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::lucky_breakdown_
private

Definition at line 294 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ sn_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<Teuchos::SerialDenseVector<int,ScalarType> > > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::sn_
private

Definition at line 297 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ cs_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<Teuchos::SerialDenseVector<int,MagnitudeType> > > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::cs_
private

Definition at line 298 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ U_vec_

template<class Storage , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::U_vec_
private

Definition at line 301 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ AU_vec_

template<class Storage , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::AU_vec_
private

Definition at line 301 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ cur_block_rhs_

template<class Storage , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::cur_block_rhs_
private

Definition at line 304 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ cur_block_sol_

template<class Storage , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::cur_block_sol_
private

Definition at line 304 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ initialized_

template<class Storage , class MV , class OP >
bool Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::initialized_
private

Definition at line 312 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ curDim_

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::curDim_
private

Definition at line 315 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ iter_

template<class Storage , class MV , class OP >
int Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::iter_
private

Definition at line 315 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ V_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<MV> > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::V_
private

Definition at line 320 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ H_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::H_
private

Definition at line 325 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ R_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::R_
private

Definition at line 330 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ Z_

template<class Storage , class MV , class OP >
std::vector<Teuchos::RCP<Teuchos::SerialDenseVector<int,ScalarType> > > Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::Z_
private

Definition at line 331 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.

◆ breakDownTol_

template<class Storage , class MV , class OP >
SVT::magnitudeType Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::breakDownTol_
private

Definition at line 334 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.


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