#include <AnasaziGenOrthoManager.hpp>
Public Member Functions | |
Constructor/Destructor | |
GenOrthoManager (Teuchos::RCP< const OP > Op=Teuchos::null) | |
Default constructor. | |
virtual | ~GenOrthoManager () |
Destructor. | |
Orthogonalization methods | |
virtual void | projectGen (MV &S, Teuchos::Array< Teuchos::RCP< const MV > > X, Teuchos::Array< Teuchos::RCP< const MV > > Y, bool isBiOrtho, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C=Teuchos::tuple(Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >(Teuchos::null)), Teuchos::RCP< MV > MS=Teuchos::null, Teuchos::Array< Teuchos::RCP< const MV > > MX=Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)), Teuchos::Array< Teuchos::RCP< const MV > > MY=Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null))) const =0 |
Applies a series of generic projectors. | |
virtual int | projectAndNormalizeGen (MV &S, Teuchos::Array< Teuchos::RCP< const MV > > X, Teuchos::Array< Teuchos::RCP< const MV > > Y, bool isBiOrtho, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C=Teuchos::tuple(Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >(Teuchos::null)), Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B=Teuchos::null, Teuchos::RCP< MV > MS=Teuchos::null, Teuchos::Array< Teuchos::RCP< const MV > > MX=Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)), Teuchos::Array< Teuchos::RCP< const MV > > MY=Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null))) const =0 |
Applies a series of generic projectors and returns an orthonormal basis for the residual data. |
Such a projector modifies the input in the range on in order to make the output orthogonal to the range of
.
Definition at line 59 of file AnasaziGenOrthoManager.hpp.
Anasazi::GenOrthoManager< ScalarType, MV, OP >::GenOrthoManager | ( | Teuchos::RCP< const OP > | Op = Teuchos::null |
) | [inline] |
virtual Anasazi::GenOrthoManager< ScalarType, MV, OP >::~GenOrthoManager | ( | ) | [inline, virtual] |
virtual int Anasazi::GenOrthoManager< ScalarType, MV, OP >::projectAndNormalizeGen | ( | MV & | S, | |
Teuchos::Array< Teuchos::RCP< const MV > > | X, | |||
Teuchos::Array< Teuchos::RCP< const MV > > | Y, | |||
bool | isBiOrtho, | |||
Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > | C = Teuchos::tuple(Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >(Teuchos::null)) , |
|||
Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > | B = Teuchos::null , |
|||
Teuchos::RCP< MV > | MS = Teuchos::null , |
|||
Teuchos::Array< Teuchos::RCP< const MV > > | MX = Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)) , |
|||
Teuchos::Array< Teuchos::RCP< const MV > > | MY = Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)) | |||
) | const [pure virtual] |
Applies a series of generic projectors and returns an orthonormal basis for the residual data.
Given a list of bases X[i]
and Y[i]
(a projection pair), this method takes a multivector S
and applies the projectors
These operation project S
onto the space orthogonal to the range of the Y[i]
, along the range of X
[i]. The inner product specified by is given by innerProd().
The method returns in S
an orthonormal basis for the residual
where B
contains the (not necessarily triangular) coefficients of the residual with respect to the new basis.
The method also returns the coefficients C[i]
and B
associated with each projection pair, so that
and
Lastly, for reasons of efficiency, the user must specify whether the projection pairs are bi-orthonormal with respect to innerProd(), i.e., whether . Furthermore, the user may optionally specifiy the image of
S
and the projection pairs under the inner product operator getOp().
S | [in/out] The multivector to be modified. On output, the columns of S will be orthogonal to each Y[i] , satisfying
Also,
where | |
X | [in] Multivectors for bases under which ![]() | |
Y | [in] Multivectors for bases to which ![]() | |
isBiortho | [in] A flag specifying whether the bases X[i] and Y[i] are biorthonormal, i.e,. whether ![]() | |
C | [out] Coefficients for reconstructing ![]() X[i] . 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] points to a Teuchos::SerialDenseMatrix with size inconsistent with S and , then a std::invalid_argument exception will be thrown.Otherwise, if C.size() < i or C[i] is a null pointer, the caller will not have access to the computed coefficients C[i] . | |
B | [out] The coefficients of the original S with respect to the computed basis. If B is a non-null pointer and B matches the dimensions of B , then the coefficients computed during the orthogonalization routine will be stored in B , similar to calling innerProd( Sout, Sin, B ); B points to a Teuchos::SerialDenseMatrix with size inconsistent with S , then a std::invalid_argument exception will be thrown.Otherwise, if B is null, the caller will not have access to the computed coefficients. | |
MS | [in/out] If specified by the user, on input MS is required to be the image of S under the operator getOp(). On output, MS will be updated to reflect the changes in S . | |
MX | [in] If specified by the user, MX[i] is required to be the image of X[i] under the operator getOp(). | |
MY | [in] If specified by the user, MY[i] is required to be the image of Y[i] under the operator getOp(). |
B
is not necessarily triangular (as in a QR factorization); see the documentation of specific orthogonalization managers.X[i] != Teuchos::null
or Y[i] != Teuchos::null
, then X[i]
and Y[i]
are required to have the same number of columns, and each should have the same number of rows as S
. i != j
, biOrtho == true
, biOrtho == false
, then X[i]
and Y[i]
have S
has C[i]
if specified must be S
has B
if specified must be Implemented in Anasazi::ICGSOrthoManager< ScalarType, MV, OP >.
virtual void Anasazi::GenOrthoManager< ScalarType, MV, OP >::projectGen | ( | MV & | S, | |
Teuchos::Array< Teuchos::RCP< const MV > > | X, | |||
Teuchos::Array< Teuchos::RCP< const MV > > | Y, | |||
bool | isBiOrtho, | |||
Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > | C = Teuchos::tuple(Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > >(Teuchos::null)) , |
|||
Teuchos::RCP< MV > | MS = Teuchos::null , |
|||
Teuchos::Array< Teuchos::RCP< const MV > > | MX = Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)) , |
|||
Teuchos::Array< Teuchos::RCP< const MV > > | MY = Teuchos::tuple(Teuchos::RCP< const MV >(Teuchos::null)) | |||
) | const [pure virtual] |
Applies a series of generic projectors.
Given a list of bases X[i]
and Y[i]
(a projection pair), this method takes a multivector S
and applies the projectors
This operation projects S
onto the space orthogonal to the Y[i]
, along the range of the X[i]
. The inner product specified by is given by innerProd().
projectGen(S, tuple(X1,X2), tuple(Y1,Y2))
projectGen(S, tuple(X2,X1), tuple(Y2,Y1))
C[i]
associated with each projection pair, so that
and therefore
Lastly, for reasons of efficiency, the user must specify whether the projection pairs are bi-orthonormal with respect to innerProd(), i.e., whether . In the case that the bases are specified to be biorthogonal, the inverse
will not be computed. Furthermore, the user may optionally specifiy the image of
S
and the projection pairs under the inner product operator getOp().
S | [in/out] The multivector to be modified. On output, the columns of S will be orthogonal to each Y[i] , satisfying
Also,
| |
X | [in] Multivectors for bases under which ![]() | |
Y | [in] Multivectors for bases to which ![]() | |
isBiortho | [in] A flag specifying whether the bases X[i] and Y[i] are biorthonormal, i.e,. whether ![]() | |
C | [out] Coefficients for reconstructing ![]() X[i] . If C[i] is a non-null pointer and C[i] matches the dimensions of S and X[i] , then the coefficients computed during the orthogonalization routine will be stored in the matrix C[i] .If C[i] points to a Teuchos::SerialDenseMatrix with size inconsistent with S and , then a std::invalid_argument exception will be thrown.Otherwise, if C.size() < i or C[i] is a null pointer, the caller will not have access to the computed coefficients C[i] . | |
MS | [in/out] If specified by the user, on input MS is required to be the image of S under the operator getOp(). On output, MS will be updated to reflect the changes in S . | |
MX | [in] If specified by the user, MX[i] is required to be the image of X[i] under the operator getOp(). | |
MY | [in] If specified by the user, MY[i] is required to be the image of Y[i] under the operator getOp(). |
X[i] != Teuchos::null
or Y[i] != Teuchos::null
, then X[i]
and Y[i]
are required to have the same number of columns, and each should have the same number of rows as S
. i != j
, biOrtho == true
, biOrtho == false
, then X[i]
and Y[i]
have S
has C[i]
if specified must be Implemented in Anasazi::ICGSOrthoManager< ScalarType, MV, OP >.