NOX Development
Public Member Functions | Protected Attributes
LOCA::AnasaziOperator::ShiftInvert Class Reference

Anasazi operator for computing generalized eigenvalues using shift-invert. More...

#include <LOCA_AnasaziOperator_ShiftInvert.H>

Inheritance diagram for LOCA::AnasaziOperator::ShiftInvert:
Inheritance graph
Collaboration diagram for LOCA::AnasaziOperator::ShiftInvert:
Collaboration graph

List of all members.

Public Member Functions

 ShiftInvert (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, const Teuchos::RCP< LOCA::TimeDependent::AbstractGroup > &grp)
virtual ~ShiftInvert ()
virtual const string & label () const
 Return name of this operator.
virtual void apply (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &output) const
 Apply the operator.
virtual void transformEigenvalue (double &ev_r, double &ev_i) const
 Transform eigenvalue.
rayleighQuotient (NOX::Abstract::Vector &evec_r, NOX::Abstract::Vector &evec_i, double &rq_r, double &rq_i) const
 Compute Rayleigh quotient.

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 Global data.
string myLabel
 Name of this operator.
< Teuchos::ParameterList
 Stores parameters relating to the operator.
< Teuchos::ParameterList
 Stores linear solver parameters.
< LOCA::TimeDependent::AbstractGroup
 Stores group representing Jacobian and Mass matrix.
< NOX::Abstract::MultiVector
 Stores a temporary vector for computing Rayleigh quotients.
< NOX::Abstract::MultiVector
 Stores a temporary vector for computing Rayleigh quotients.
double shift
 Stores shift value.

Detailed Description

Anasazi operator for computing generalized eigenvalues using shift-invert.

This class implements the LOCA::AnasaziOperator::AbstractStrategy interface for computing generalized eigenvalues $\lambda$ and eigenvectors $z$ of the system

\[ J z = \lambda M z *\]

where $J$ is the Jacobian matrix and $M$ is the mass matrix. The right-most eigenvalues are computed using shift-invert, i.e. solving

\[ (J - \omega M) z = \lambda M z \]

where $\omega$ is a real scalar. The resulting eigenvalue is $\lambda + \omega$.

The parameters used by this class supplied in the constructor are:

Also the grp argument to the constructor must be a child of LOCA::TimeDependent::AbstractGroup for the shift-invert operations.

Constructor & Destructor Documentation

LOCA::AnasaziOperator::ShiftInvert::ShiftInvert ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
const Teuchos::RCP< LOCA::TimeDependent::AbstractGroup > &  grp 


Argument grp must be of type LOCA::TimeDependent::AbstractGroup. See class description for a list of eigenParams.

References eigenParams, Teuchos::RCP< T >::get(), and shift.

Member Function Documentation

void LOCA::AnasaziOperator::ShiftInvert::apply ( const NOX::Abstract::MultiVector input,
NOX::Abstract::MultiVector output 
) const [virtual]

Apply the operator.

Applies the inverse of the shifted operator, i.e., solves

\[ (J-\omega I)z = M r \]

for $z$, where $r = \mbox{input}$ and $z = \mbox{output}$.

Implements LOCA::AnasaziOperator::AbstractStrategy.

References NOX::Abstract::MultiVector::clone(), NOX::Abstract::MultiVector::numVectors(), NOX::Abstract::Group::Ok, and NOX::ShapeCopy.

NOX::Abstract::Group::ReturnType LOCA::AnasaziOperator::ShiftInvert::rayleighQuotient ( NOX::Abstract::Vector evec_r,
NOX::Abstract::Vector evec_i,
double &  rq_r,
double &  rq_i 
) const [virtual]
void LOCA::AnasaziOperator::ShiftInvert::transformEigenvalue ( double &  ev_r,
double &  ev_i 
) const [virtual]

Transform eigenvalue.

Transforms the given eigenvalue to the eigenvalue of the Jacobian-mass matrix system by shifting and inverting it.

Implements LOCA::AnasaziOperator::AbstractStrategy.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends