#include <Belos_IMGS_OrthoManager_MP_Vector.hpp>

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

Private Types
typedef Sacado::MP::Vector< Storage >	ScalarType

typedef Teuchos::ScalarTraits< ScalarType >::magnitudeType	MagnitudeType

typedef Teuchos::ScalarTraits< MagnitudeType >	MGT

typedef Teuchos::ScalarTraits< ScalarType >	SCT

typedef MultiVecTraits< ScalarType, MV >	MVT

typedef OperatorTraits< ScalarType, MV, OP >	OPT

Private Member Functions
int	findBasis (MV &X, Teuchos::RCP< MV > MX, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > C, bool completeBasis, int howMany=-1) const
	Routine to find an orthonormal basis for X. More...

bool	blkOrtho1 (MV &X, Teuchos::RCP< MV > MX, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
	Routine to compute the block orthogonalization. More...

bool	blkOrtho (MV &X, Teuchos::RCP< MV > MX, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
	Routine to compute the block orthogonalization. More...

int	blkOrthoSing (MV &X, Teuchos::RCP< MV > MX, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B, Teuchos::ArrayView< Teuchos::RCP< const MV > > QQ) const

Private Attributes
int	max_ortho_steps_
	Max number of (re)orthogonalization steps, including the first. More...

MagnitudeType	blk_tol_
	Block reorthogonalization tolerance. More...

MagnitudeType	sing_tol_
	Singular block detection threshold. More...

std::string	label_
	Label for timers. More...

Teuchos::RCP< Teuchos::ParameterList >	defaultParams_
	Default parameter list. More...

Constructor/Destructor
	IMGSOrthoManager (const std::string &label="Belos", Teuchos::RCP< const OP > Op=Teuchos::null, const int max_ortho_steps=max_ortho_steps_default_, const MagnitudeType blk_tol=blk_tol_default_, const MagnitudeType sing_tol=sing_tol_default_)
	Constructor specifying re-orthogonalization tolerance. More...

	IMGSOrthoManager (const Teuchos::RCP< Teuchos::ParameterList > &plist, const std::string &label="Belos", Teuchos::RCP< const OP > Op=Teuchos::null)
	Constructor that takes a list of parameters. More...

	~IMGSOrthoManager ()
	Destructor. More...

Implementation of Teuchos::ParameterListAcceptorDefaultBase interface
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &plist)

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

Accessor routines
void	setBlkTol (const MagnitudeType blk_tol)
	Set parameter for block re-orthogonalization threshhold. More...

void	setSingTol (const MagnitudeType sing_tol)
	Set parameter for singular block detection. More...

MagnitudeType	getBlkTol () const
	Return parameter for block re-orthogonalization threshhold. More...

MagnitudeType	getSingTol () const
	Return parameter for singular block detection. More...

Orthogonalization methods
void	project (MV &X, Teuchos::RCP< MV > MX, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
	Given a list of (mutually and internally) orthonormal bases `Q`, this method takes a multivector `X` and projects it onto the space orthogonal to the individual `Q[i]`, optionally returning the coefficients of `X` for the individual `Q[i]`. All of this is done with respect to the inner product innerProd(). More...

void	project (MV &X, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
	This method calls project(X,Teuchos::null,C,Q); see documentation for that function. More...

int	normalize (MV &X, Teuchos::RCP< MV > MX, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B) const
	This method takes a multivector `X` and attempts to compute an orthonormal basis for , with respect to innerProd(). More...

int	normalize (MV &X, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B) const
	This method calls normalize(X,Teuchos::null,B); see documentation for that function. More...

virtual int	projectAndNormalizeWithMxImpl (MV &X, Teuchos::RCP< MV > MX, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
	Given a set of bases `Q[i]` and a multivector `X`, this method computes an orthonormal basis for $colspan(X) - \sum_i colspan(Q[i])$ . More...

Error methods
Teuchos::ScalarTraits< ScalarType >::magnitudeType	orthonormError (const MV &X) const
	This method computes the error in orthonormality of a multivector, measured as the Frobenius norm of the difference `innerProd(X,Y) - I`. More...

Teuchos::ScalarTraits< ScalarType >::magnitudeType	orthonormError (const MV &X, Teuchos::RCP< const MV > MX) const
	This method computes the error in orthonormality of a multivector, measured as the Frobenius norm of the difference `innerProd(X,Y) - I`. The method has the option of exploiting a caller-provided `MX`. More...

Teuchos::ScalarTraits< ScalarType >::magnitudeType	orthogError (const MV &X1, const MV &X2) const
	This method computes the error in orthogonality of two multivectors, measured as the Frobenius norm of `innerProd(X,Y)`. More...

Teuchos::ScalarTraits< ScalarType >::magnitudeType	orthogError (const MV &X1, Teuchos::RCP< const MV > MX1, const MV &X2) const
	This method computes the error in orthogonality of two multivectors, measured as the Frobenius norm of `innerProd(X,Y)`. The method has the option of exploiting a caller-provided `MX`. More...

Label methods
void	setLabel (const std::string &label)
	This method sets the label used by the timers in the orthogonalization manager. More...

const std::string &	getLabel () const
	This method returns the label being used by the timers in the orthogonalization manager. More...

Default orthogonalization constants
static const int	max_ortho_steps_default_
	Max number of (re)orthogonalization steps, including the first (default). More...

static const MagnitudeType	blk_tol_default_
	Block reorthogonalization threshold (default). More...

static const MagnitudeType	sing_tol_default_
	Singular block detection threshold (default). More...

static const int	max_ortho_steps_fast_
	Max number of (re)orthogonalization steps, including the first (fast). More...

static const MagnitudeType	blk_tol_fast_
	Block reorthogonalization threshold (fast). More...

static const MagnitudeType	sing_tol_fast_
	Singular block detection threshold (fast). More...

Detailed Description

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

Definition at line 60 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

Member Typedef Documentation

◆ ScalarType

template<class Storage , class MV , class OP >

typedef Sacado::MP::Vector<Storage> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::ScalarType

private

Definition at line 64 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ MagnitudeType

template<class Storage , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::MagnitudeType

private

Definition at line 65 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ MGT

template<class Storage , class MV , class OP >

typedef Teuchos::ScalarTraits<MagnitudeType> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::MGT

private

Definition at line 66 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ SCT

template<class Storage , class MV , class OP >

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

private

Definition at line 67 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ MVT

template<class Storage , class MV , class OP >

typedef MultiVecTraits<ScalarType,MV> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::MVT

private

Definition at line 68 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ OPT

template<class Storage , class MV , class OP >

typedef OperatorTraits<ScalarType,MV,OP> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::OPT

private

Definition at line 69 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

Constructor & Destructor Documentation

◆ IMGSOrthoManager() [1/2]

template<class Storage , class MV , class OP >

Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::IMGSOrthoManager	(	const std::string &	label = `"Belos"`,
		Teuchos::RCP< const OP >	Op = `Teuchos::null`,
		const int	max_ortho_steps = `max_ortho_steps_default_`,
		const MagnitudeType	blk_tol = `blk_tol_default_`,
		const MagnitudeType	sing_tol = `sing_tol_default_`
	)

inline

Constructor specifying re-orthogonalization tolerance.

Definition at line 76 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ IMGSOrthoManager() [2/2]

template<class Storage , class MV , class OP >

Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::IMGSOrthoManager	(	const Teuchos::RCP< Teuchos::ParameterList > &	plist,
		const std::string &	label = `"Belos"`,
		Teuchos::RCP< const OP >	Op = `Teuchos::null`
	)

inline

Constructor that takes a list of parameters.

Definition at line 106 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ ~IMGSOrthoManager()

template<class Storage , class MV , class OP >

Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::~IMGSOrthoManager ( )

inline

Destructor.

Definition at line 136 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

Member Function Documentation

◆ setParameterList()

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > & plist )

inline

Definition at line 142 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ getValidParameters()

template<class Storage , class MV , class OP >

Teuchos::RCP<const Teuchos::ParameterList> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::getValidParameters ( ) const

inline

Definition at line 214 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ setBlkTol()

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::setBlkTol ( const MagnitudeType blk_tol )

inline

Set parameter for block re-orthogonalization threshhold.

Definition at line 229 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ setSingTol()

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::setSingTol ( const MagnitudeType sing_tol )

inline

Set parameter for singular block detection.

Definition at line 232 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ getBlkTol()

template<class Storage , class MV , class OP >

MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::getBlkTol ( ) const

inline

Return parameter for block re-orthogonalization threshhold.

Definition at line 235 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ getSingTol()

template<class Storage , class MV , class OP >

MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::getSingTol ( ) const

inline

Return parameter for singular block detection.

Definition at line 238 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ project() [1/2]

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::project	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	Q
	)		const

Given a list of (mutually and internally) orthonormal bases Q, this method takes a multivector X and projects it onto the space orthogonal to the individual Q[i], optionally returning the coefficients of X for the individual Q[i]. All of this is done with respect to the inner product innerProd().

After calling this routine, X will be orthogonal to each of the Q[i].

The method uses either one or two steps of modified Gram-Schmidt. The algebraically equivalent projection matrix is $P_Q = I - Q Q^H Op$ , if Op is the matrix specified for use in the inner product. Note, this is not an orthogonal projector.

Parameters

X	[in/out] The multivector to be modified. On output, `X` will be orthogonal to `Q[i]` with respect to innerProd().
MX	[in/out] The image of `X` under the operator `Op`. If : On input, this is expected to be consistent with `X`. On output, this is updated consistent with updates to `X`. If or : `MX` is not referenced.
C	[out] The coefficients of `X` in the `Q`[i], with respect to innerProd(). If `C[i]` is a non-null pointer and `C`[i] matches the dimensions of `X` and `Q`[i], then the coefficients computed during the orthogonalization routine will be stored in the matrix `C`[i]. If `C[i]` is a non-null pointer whose size does not match the dimensions of `X` and `*Q`[i], then a std::invalid_argument std::exception will be thrown. Otherwise, if `C.size() < i` or `C[i]` is a null pointer, then the orthogonalization manager will declare storage for the coefficients and the user will not have access to them.
Q	[in] A list of multivector bases specifying the subspaces to be orthogonalized against. Each `Q[i]` is assumed to have orthonormal columns, and the `Q[i]` are assumed to be mutually orthogonal.

◆ project() [2/2]

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::project	(	MV &	X,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	Q
	)		const

inline

This method calls project(X,Teuchos::null,C,Q); see documentation for that function.

Definition at line 280 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ normalize() [1/2]

template<class Storage , class MV , class OP >

int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::normalize	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >	B
	)		const

This method takes a multivector X and attempts to compute an orthonormal basis for $colspan(X)$ , with respect to innerProd().

The method uses modified Gram-Schmidt, so that the coefficient matrix B is upper triangular.

This routine returns an integer rank stating the rank of the computed basis. If X does not have full rank and the normalize() routine does not attempt to augment the subspace, then rank may be smaller than the number of columns in X. In this case, only the first rank columns of output X and first rank rows of B will be valid.

The method attempts to find a basis with dimension the same as the number of columns in X. It does this by augmenting linearly dependant vectors in X with random directions. A finite number of these attempts will be made; therefore, it is possible that the dimension of the computed basis is less than the number of vectors in X.

Parameters

X	[in/out] The multivector to the modified. On output, `X` will have some number of orthonormal columns (with respect to innerProd()).
MX	[in/out] The image of `X` under the operator `Op`. If : On input, this is expected to be consistent with `X`. On output, this is updated consistent with updates to `X`. If or : `MX` is not referenced.
B	[out] The coefficients of the original `X` with respect to the computed basis. The first rows in `B` corresponding to the valid columns in `X` will be upper triangular.

Returns: Rank of the basis computed by this method.

◆ normalize() [2/2]

template<class Storage , class MV , class OP >

int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::normalize	(	MV &	X,
		Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >	B
	)		const

inline

This method calls normalize(X,Teuchos::null,B); see documentation for that function.

Definition at line 318 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ projectAndNormalizeWithMxImpl()

template<class Storage , class MV , class OP >

virtual int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::projectAndNormalizeWithMxImpl	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >	B,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	Q
	)		const

protectedvirtual

Given a set of bases Q[i] and a multivector X, this method computes an orthonormal basis for $colspan(X) - \sum_i colspan(Q[i])$ .

This routine returns an integer rank stating the rank of the computed basis. If the subspace $colspan(X) - \sum_i colspan(Q[i])$ does not have dimension as large as the number of columns of X and the orthogonalization manager doe not attempt to augment the subspace, then rank may be smaller than the number of columns of X. In this case, only the first rank columns of output X and first rank rows of B will be valid.

The method attempts to find a basis with dimension the same as the number of columns in X. It does this by augmenting linearly dependant vectors with random directions. A finite number of these attempts will be made; therefore, it is possible that the dimension of the computed basis is less than the number of vectors in X.

Parameters

X	[in/out] The multivector to the modified. On output, the relevant rows of `X` will be orthogonal to the `Q[i]` and will have orthonormal columns (with respect to innerProd()).
MX	[in/out] The image of `X` under the operator `Op`. If : On input, this is expected to be consistent with `X`. On output, this is updated consistent with updates to `X`. If or : `MX` is not referenced.
C	[out] The coefficients of the original `X` in the `Q`[i], with respect to innerProd(). If `C[i]` is a non-null pointer and `C`[i] matches the dimensions of `X` and `Q`[i], then the coefficients computed during the orthogonalization routine will be stored in the matrix `C`[i]. If `C[i]` is a non-null pointer whose size does not match the dimensions of `X` and `Q`[i], then C[i] will first be resized to the correct size. This will destroy the original contents of the matrix. (This is a change from previous behavior, in which a std::invalid_argument exception was thrown if *C[i] was of the wrong size.) Otherwise, if `C.size() < i<> or C[i] is a null pointer, then the orthogonalization manager will declare storage for the coefficients and the user will not have access to them.`
B	`[out] The coefficients of the original X with respect to the computed basis. The first rows in B corresponding to the valid columns in X will be upper triangular.`
Q	`[in] A list of multivector bases specifying the subspaces to be orthogonalized against. Each Q[i] is assumed to have orthonormal columns, and the Q[i] are assumed to be mutually orthogonal.`

Returns: Rank of the basis computed by this method.

◆ orthonormError() [1/2]

template<class Storage , class MV , class OP >

Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::orthonormError ( const MV & X ) const

inline

This method computes the error in orthonormality of a multivector, measured as the Frobenius norm of the difference innerProd(X,Y) - I.

Definition at line 380 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ orthonormError() [2/2]

template<class Storage , class MV , class OP >

Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::orthonormError	(	const MV &	X,
		Teuchos::RCP< const MV >	MX
	)		const

This method computes the error in orthonormality of a multivector, measured as the Frobenius norm of the difference innerProd(X,Y) - I. The method has the option of exploiting a caller-provided MX.

◆ orthogError() [1/2]

template<class Storage , class MV , class OP >

Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::orthogError	(	const MV &	X1,
		const MV &	X2
	)		const

inline

This method computes the error in orthogonality of two multivectors, measured as the Frobenius norm of innerProd(X,Y).

Definition at line 395 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ orthogError() [2/2]

template<class Storage , class MV , class OP >

Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::orthogError	(	const MV &	X1,
		Teuchos::RCP< const MV >	MX1,
		const MV &	X2
	)		const

This method computes the error in orthogonality of two multivectors, measured as the Frobenius norm of innerProd(X,Y). The method has the option of exploiting a caller-provided MX.

◆ setLabel()

template<class Storage , class MV , class OP >

void Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::setLabel ( const std::string & label )

This method sets the label used by the timers in the orthogonalization manager.

◆ getLabel()

template<class Storage , class MV , class OP >

const std::string& Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::getLabel ( ) const

inline

This method returns the label being used by the timers in the orthogonalization manager.

Definition at line 417 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ findBasis()

template<class Storage , class MV , class OP >

int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::findBasis	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >	C,
		bool	completeBasis,
		int	howMany = `-1`
	)		const

private

Routine to find an orthonormal basis for X.

◆ blkOrtho1()

template<class Storage , class MV , class OP >

bool Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blkOrtho1	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	Q
	)		const

private

Routine to compute the block orthogonalization.

◆ blkOrtho()

template<class Storage , class MV , class OP >

bool Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blkOrtho	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	Q
	)		const

private

Routine to compute the block orthogonalization.

◆ blkOrthoSing()

template<class Storage , class MV , class OP >

int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blkOrthoSing	(	MV &	X,
		Teuchos::RCP< MV >	MX,
		Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > >	C,
		Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >	B,
		Teuchos::ArrayView< Teuchos::RCP< const MV > >	QQ
	)		const

private

Project X against QQ and normalize X, one vector at a time

Note: QQ is called QQ, rather than Q, because we convert it internally from an ArrayView to an Array (named Q inside). This is because the C++ compiler doesn't know how to do type inference (Array has a constructor that takes an ArrayView input). This routine wants an Array rather than an ArrayView internally, because it likes to add (via push_back()) and remove (via resize()) elements to the Q array. Remember that Arrays can be passed by value, just like std::vector objects, so this routine can add whatever it likes to the Q array without changing it from the caller's perspective.

Member Data Documentation

◆ max_ortho_steps_default_

template<class Storage , class MV , class OP >

const int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::max_ortho_steps_default_

static

Max number of (re)orthogonalization steps, including the first (default).

Definition at line 425 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ blk_tol_default_

template<class Storage , class MV , class OP >

const MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blk_tol_default_

static

Block reorthogonalization threshold (default).

Definition at line 427 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ sing_tol_default_

template<class Storage , class MV , class OP >

const MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::sing_tol_default_

static

Singular block detection threshold (default).

Definition at line 429 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ max_ortho_steps_fast_

template<class Storage , class MV , class OP >

const int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::max_ortho_steps_fast_

static

Max number of (re)orthogonalization steps, including the first (fast).

Definition at line 432 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ blk_tol_fast_

template<class Storage , class MV , class OP >

const MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blk_tol_fast_

static

Block reorthogonalization threshold (fast).

Definition at line 434 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ sing_tol_fast_

template<class Storage , class MV , class OP >

const MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::sing_tol_fast_

static

Singular block detection threshold (fast).

Definition at line 436 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ max_ortho_steps_

template<class Storage , class MV , class OP >

int Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::max_ortho_steps_

private

Max number of (re)orthogonalization steps, including the first.

Definition at line 443 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ blk_tol_

template<class Storage , class MV , class OP >

MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::blk_tol_

private

Block reorthogonalization tolerance.

Definition at line 445 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ sing_tol_

template<class Storage , class MV , class OP >

MagnitudeType Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::sing_tol_

private

Singular block detection threshold.

Definition at line 447 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ label_

template<class Storage , class MV , class OP >

std::string Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::label_

private

Label for timers.

Definition at line 450 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

◆ defaultParams_

template<class Storage , class MV , class OP >

Teuchos::RCP<Teuchos::ParameterList> Belos::IMGSOrthoManager< Sacado::MP::Vector< Storage >, MV, OP >::defaultParams_

mutableprivate

Default parameter list.

Definition at line 456 of file Belos_IMGS_OrthoManager_MP_Vector.hpp.

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

Belos_IMGS_OrthoManager_MP_Vector.hpp

Private Types

Private Member Functions

Private Attributes

Constructor/Destructor

Implementation of Teuchos::ParameterListAcceptorDefaultBase interface

Accessor routines

Orthogonalization methods

Error methods

Label methods

Default orthogonalization constants

Detailed Description

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

Member Typedef Documentation

◆ ScalarType

◆ MagnitudeType

◆ MGT

◆ SCT

◆ MVT

◆ OPT

Constructor & Destructor Documentation

◆ IMGSOrthoManager() [1/2]

◆ IMGSOrthoManager() [2/2]

◆ ~IMGSOrthoManager()

Member Function Documentation

◆ setParameterList()

◆ getValidParameters()

◆ setBlkTol()

◆ setSingTol()

◆ getBlkTol()

◆ getSingTol()

◆ project() [1/2]

◆ project() [2/2]

◆ normalize() [1/2]

◆ normalize() [2/2]

◆ projectAndNormalizeWithMxImpl()

◆ orthonormError() [1/2]

◆ orthonormError() [2/2]

◆ orthogError() [1/2]

◆ orthogError() [2/2]

◆ setLabel()

◆ getLabel()

◆ findBasis()

◆ blkOrtho1()

◆ blkOrtho()

◆ blkOrthoSing()

Member Data Documentation

◆ max_ortho_steps_default_

◆ blk_tol_default_

◆ sing_tol_default_

◆ max_ortho_steps_fast_

◆ blk_tol_fast_

◆ sing_tol_fast_

◆ max_ortho_steps_

◆ blk_tol_

◆ sing_tol_

◆ label_

◆ defaultParams_

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