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

Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation. More...

#include <BelosBlockCGIter.hpp>

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

Public Types

using MVT = MultiVecTraits< ScalarType, MV >
 
using OPT = OperatorTraits< ScalarType, MV, OP >
 
using SCT = Teuchos::ScalarTraits< ScalarType >
 
using MagnitudeType = typename SCT::magnitudeType
 

Public Member Functions

Constructors/Destructor
 BlockCGIter (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)
 BlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options. More...
 
virtual ~BlockCGIter ()=default
 Destructor. More...
 
Solver methods
void iterate ()
 This method performs BlockCG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More...
 
void initializeCG (Teuchos::RCP< CGIterationStateBase< ScalarType, MV > > newstate, Teuchos::RCP< MV > R_0)
 Initialize the solver to an iterate, providing a complete state. More...
 
void initialize ()
 Initialize the solver with the initial vectors from the linear problem or random data. More...
 
Teuchos::RCP
< CGIterationStateBase
< ScalarType, MV > > 		getState () const
 Get the current state of the linear solver. More...
 
void setState (Teuchos::RCP< CGIterationStateBase< ScalarType, MV > > state)
 
Status methods
int getNumIters () const
 Get the current iteration count. More...
 
void resetNumIters (int iter=0)
 Reset the iteration count. More...
 
Teuchos::RCP< const MV > getNativeResiduals (std::vector< MagnitudeType > *) const
 Get the norms of the residuals native to the solver. More...
 
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system. More...
 
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 		getProblem () const
 Get a constant reference to the linear problem. More...
 
int getBlockSize () const
 Get the block size to be used by the iterative solver in solving this linear problem. More...
 
void setBlockSize (int blockSize)
 Set the block size to be used by the iterative solver in solving this linear problem. More...
 
bool isInitialized ()
 States whether the solver has been initialized or not. More...
 
void setDoCondEst (bool)
 Sets whether or not to store the diagonal for condition estimation. More...
 
Teuchos::ArrayView< MagnitudeType > getDiag ()
 Gets the diagonal for condition estimation (NOT_IMPLEMENTED) More...
 
Teuchos::ArrayView< MagnitudeType > getOffDiag ()
 Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED) More...
 
State methods
- Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP >
 Iteration ()
 Default Constructor. More...
 
virtual ~Iteration ()
 Destructor. More...
 
virtual Teuchos::RCP< const MV > getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0
 Get the residuals native to the solver. More...
 

Detailed Description

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

Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation.

This is the (non-stub) actual implementation of BlockCGIter.

Definition at line 167 of file BelosBlockCGIter.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >
using Belos::BlockCGIter< ScalarType, MV, OP, true >::MVT = MultiVecTraits<ScalarType, MV>

Definition at line 174 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
using Belos::BlockCGIter< ScalarType, MV, OP, true >::OPT = OperatorTraits<ScalarType, MV, OP>

Definition at line 175 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
using Belos::BlockCGIter< ScalarType, MV, OP, true >::SCT = Teuchos::ScalarTraits<ScalarType>

Definition at line 176 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
using Belos::BlockCGIter< ScalarType, MV, OP, true >::MagnitudeType = typename SCT::magnitudeType

Definition at line 177 of file BelosBlockCGIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::BlockCGIter< ScalarType, MV, OP, true >::BlockCGIter ( 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 
)

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

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

Definition at line 370 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::BlockCGIter< ScalarType, MV, OP, true >::~BlockCGIter ( )
virtualdefault

Destructor.

Member Function Documentation

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::iterate ( )
virtual

This method performs BlockCG 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 initialized; if not, it will call initialize() using default arguments. After initialization, the solver performs BlockCG iterations until the status test evaluates as Passed, at which point the method returns to the caller.

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

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

Definition at line 465 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::initializeCG ( Teuchos::RCP< CGIterationStateBase< ScalarType, MV > >  newstate,
Teuchos::RCP< MV >  R_0 
)
virtual

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

The BlockCGIter contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.

initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.

Postcondition
isInitialized() == true (see post-conditions of isInitialize())
Note
For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

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

Definition at line 409 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::initialize ( )
inlinevirtual

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

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

Definition at line 234 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<CGIterationStateBase<ScalarType,MV> > Belos::BlockCGIter< ScalarType, MV, OP, true >::getState ( ) const
inlinevirtual

Get the current state of the linear solver.

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

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

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

Definition at line 245 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::setState ( Teuchos::RCP< CGIterationStateBase< ScalarType, MV > >  state)
inlinevirtual

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

Definition at line 254 of file BelosBlockCGIter.hpp.

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

Get the current iteration count.

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

Definition at line 269 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::resetNumIters ( int  iter = 0)
inlinevirtual

Reset the iteration count.

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

Definition at line 272 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const MV> Belos::BlockCGIter< ScalarType, MV, OP, true >::getNativeResiduals ( std::vector< MagnitudeType > *  ) const
inline

Get the norms of the residuals native to the solver.

Returns
A std::vector of length blockSize containing the native residuals.

Definition at line 276 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::BlockCGIter< ScalarType, MV, OP, true >::getCurrentUpdate ( ) const
inlinevirtual

Get the current update to the linear system.

Note
This method returns a null pointer because the linear problem is current.

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

Definition at line 281 of file BelosBlockCGIter.hpp.

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

Get a constant reference to the linear problem.

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

Definition at line 289 of file BelosBlockCGIter.hpp.

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

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

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

Definition at line 292 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::setBlockSize ( int  blockSize)
virtual

Set the block size to be used by the iterative solver in solving this linear problem.

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

Definition at line 390 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::BlockCGIter< ScalarType, MV, OP, true >::isInitialized ( )
inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 298 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP, true >::setDoCondEst ( bool  )
inlinevirtual

Sets whether or not to store the diagonal for condition estimation.

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

Definition at line 301 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayView<MagnitudeType> Belos::BlockCGIter< ScalarType, MV, OP, true >::getDiag ( )
inlinevirtual

Gets the diagonal for condition estimation (NOT_IMPLEMENTED)

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

Definition at line 304 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayView<MagnitudeType> Belos::BlockCGIter< ScalarType, MV, OP, true >::getOffDiag ( )
inlinevirtual

Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED)

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

Definition at line 310 of file BelosBlockCGIter.hpp.

The documentation for this class was generated from the following file:
Generated on Thu Mar 20 2025 09:24:53 for Belos by doxygen 1.8.5