LOCA::Epetra::CompactWYOp Class Reference

An Epetra operator for solving extended sets of equations using Householder transformations. More...

#include <LOCA_Epetra_CompactWYOp.H>

Inheritance diagram for LOCA::Epetra::CompactWYOp:

[legend]
Collaboration diagram for LOCA::Epetra::CompactWYOp:
[legend]
List of all members.

Public Member Functions

 CompactWYOp (const Teuchos::RefCountPtr< const Epetra_Operator > &jacOperator, const Teuchos::RefCountPtr< const Epetra_MultiVector > &A_multiVec, const Teuchos::RefCountPtr< const Epetra_MultiVector > &Y_x_multiVec, const Teuchos::RefCountPtr< const NOX::Abstract::MultiVector::DenseMatrix > &Y_p_matrix, const Teuchos::RefCountPtr< const NOX::Abstract::MultiVector::DenseMatrix > &T_matrix)
 Constructor.
virtual ~CompactWYOp ()
 Destructor.
virtual int SetUseTranspose (bool UseTranspose)
 The operator currently does not support a transpose.
virtual int Apply (const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 This method does nothing.
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix.
virtual const char * Label () const
 Returns a character string describing the operator.
virtual bool UseTranspose () const
 Returns the current UseTranspose setting. Always returns false.
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.
void init (const Epetra_MultiVector &x)
 Initialize operator. Call this before starting a linear solve. The Epetra_MultiVector argument x must be of the same size and distribution as arguments to Apply().
void finish ()
 Finish up solve. Call this after a linear solve is finished to inform the operator that the solve is completed.
void applyCompactWY (const Epetra_MultiVector &x, Epetra_MultiVector &result_x, Epetra_MultiVector &result_p) const
 Applies the operator Q with a zero parameter component on input.

Protected Attributes

string label
 Label for operator.
Epetra_LocalMap localMap
 Local map for generating temporary matrices.
Teuchos::RefCountPtr< const
Epetra_Operator
J
 Stores operator representing J.
Teuchos::RefCountPtr< const
Epetra_MultiVector
A
 Stores multivector representing A.
Teuchos::RefCountPtr< const
Epetra_MultiVector
Y_x
 Stores multivector representing solution component of Y.
Epetra_MultiVector Y_p
 Stores multivector representing parameter component of Y.
Epetra_MultiVector T
 Stores multivector representing T.
Epetra_MultiVectortmpMat1
 Temporary matrix.
Epetra_MultiVectortmpMV
 Temporary multivec.
Teuchos::BLAS< int, double > dblas
 BLAS wrappers, used for triangular matrix-matrix products.

Detailed Description

An Epetra operator for solving extended sets of equations using Householder transformations.

This class implements the $P$ operator as described in the LOCA::BorderedSystem::EpetraHouseholder documentation for solving an extended set of equations. It uses the $Q$ factor from a QR factorization using the compact WY representation.


Constructor & Destructor Documentation

LOCA::Epetra::CompactWYOp::CompactWYOp const Teuchos::RefCountPtr< const Epetra_Operator > &  jacOperator,
const Teuchos::RefCountPtr< const Epetra_MultiVector > &  A_multiVec,
const Teuchos::RefCountPtr< const Epetra_MultiVector > &  Y_x_multiVec,
const Teuchos::RefCountPtr< const NOX::Abstract::MultiVector::DenseMatrix > &  Y_p_matrix,
const Teuchos::RefCountPtr< const NOX::Abstract::MultiVector::DenseMatrix > &  T_matrix
 

Constructor.

Parameters:
jacOperator [in] Jacobian operator J
A_multiVec [in] Multivector representing A
Y_x_multiVec [in] Multivector representing the solution component of the Y matrix in the compact WY representation
Y_p_matrix [in] Matrix representing the parameter component of the Y matrix in the compact WY representation
T_matrix [in] Matrix representing the T matrix in the compact WY representation.


Member Function Documentation

double LOCA::Epetra::CompactWYOp::NormInf  )  const [virtual]
 

Returns an approximate infinity norm of the operator matrix.

This is defined only if NormInf() of the underlying operator $J$ is defined and is given by $\|J\|_\infty+\|A\|_\infty$.

Implements Epetra_Operator.

int LOCA::Epetra::CompactWYOp::SetUseTranspose bool  UseTranspose  )  [virtual]
 

The operator currently does not support a transpose.

Setting this to true throws an error.

Implements Epetra_Operator.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:40:44 2008 for NOX by doxygen 1.3.9.1