LOCA::EigenvalueSort::LargestRealInverseCayley Class Reference

Largest-Real Cayley sorting strategy. More...

#include <LOCA_EigenvalueSort_Strategies.H>

Inheritance diagram for LOCA::EigenvalueSort::LargestRealInverseCayley:

Inheritance graph
[legend]
Collaboration diagram for LOCA::EigenvalueSort::LargestRealInverseCayley:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 LargestRealInverseCayley (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams)
 Constructor.
 ~LargestRealInverseCayley ()
 Destructor.
virtual
NOX::Abstract::Group::ReturnType 
sort (int n, double *evals, std::vector< int > *perm=NULL) const
 Sort real eigenvalues.
virtual
NOX::Abstract::Group::ReturnType 
sort (int n, double *r_evals, double *i_evals, std::vector< int > *perm=NULL) const
 Sort complex eigenvalues.

Protected Member Functions

double realLambda (double er, double ei) const
 Compute the part of the inverse of the Cayley transformation.

Protected Attributes

double sigma
 Cayley pole.
double mu
 Cayley zero.

Private Member Functions

 LargestRealInverseCayley (const LargestRealInverseCayley &)
 Private to prohibit copying.
LargestRealInverseCayleyoperator= (const LargestRealInverseCayley &)
 Private to prohibit copying.


Detailed Description

Largest-Real Cayley sorting strategy.

Sorts eigenvalues in decreasing order according to the real part of their inverse-Cayley transformation. This method references the "CayleyPole" and "CayleyZero" parameters in the eigensolver parameter list.

Definition at line 396 of file LOCA_EigenvalueSort_Strategies.H.


Constructor & Destructor Documentation

LOCA::EigenvalueSort::LargestRealInverseCayley::LargestRealInverseCayley ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams 
)

Constructor.

Parameters:
global_data [in] Global data object
eigenParams [in] Eigensolver parameters.

Definition at line 414 of file LOCA_EigenvalueSort_Strategies.C.

References mu, and sigma.

LOCA::EigenvalueSort::LargestRealInverseCayley::~LargestRealInverseCayley (  )  [inline]

Destructor.

Definition at line 410 of file LOCA_EigenvalueSort_Strategies.H.

LOCA::EigenvalueSort::LargestRealInverseCayley::LargestRealInverseCayley ( const LargestRealInverseCayley  )  [private]

Private to prohibit copying.


Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::EigenvalueSort::LargestRealInverseCayley::sort ( int  n,
double *  evals,
std::vector< int > *  perm = NULL 
) const [virtual]

Sort real eigenvalues.

Implements LOCA::EigenvalueSort::AbstractStrategy.

Definition at line 425 of file LOCA_EigenvalueSort_Strategies.C.

References NOX::Abstract::Group::Ok, and realLambda().

NOX::Abstract::Group::ReturnType LOCA::EigenvalueSort::LargestRealInverseCayley::sort ( int  n,
double *  r_evals,
double *  i_evals,
std::vector< int > *  perm = NULL 
) const [virtual]

Sort complex eigenvalues.

Implements LOCA::EigenvalueSort::AbstractStrategy.

Definition at line 458 of file LOCA_EigenvalueSort_Strategies.C.

References NOX::Abstract::Group::Ok, and realLambda().

double LOCA::EigenvalueSort::LargestRealInverseCayley::realLambda ( double  er,
double  ei 
) const [protected]

Compute the part of the inverse of the Cayley transformation.

Definition at line 492 of file LOCA_EigenvalueSort_Strategies.C.

References mu, and sigma.

Referenced by sort().

LargestRealInverseCayley& LOCA::EigenvalueSort::LargestRealInverseCayley::operator= ( const LargestRealInverseCayley  )  [private]

Private to prohibit copying.


Member Data Documentation

Cayley pole.

Definition at line 437 of file LOCA_EigenvalueSort_Strategies.H.

Referenced by LargestRealInverseCayley(), and realLambda().

Cayley zero.

Definition at line 440 of file LOCA_EigenvalueSort_Strategies.H.

Referenced by LargestRealInverseCayley(), and realLambda().


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

Generated on Wed Oct 21 14:28:29 2009 for Nonlinear Solver Project by  doxygen 1.5.9