NOX Development
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LOCA::EigenvalueSort::LargestReal Class Reference

Largest-real sorting strategy. More...

#include <LOCA_EigenvalueSort_Strategies.H>

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

Public Member Functions

 LargestReal (const Teuchos::RCP< LOCA::GlobalData > &, const Teuchos::RCP< Teuchos::ParameterList > &)
 Constructor.
 
 ~LargestReal ()
 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.
 
- Public Member Functions inherited from LOCA::EigenvalueSort::AbstractStrategy
 AbstractStrategy ()
 Constructor.
 
virtual ~AbstractStrategy ()
 Destructor.
 
virtual NOX::Abstract::Group::ReturnType sort (int n, double *evals, std::vector< int > *perm=NULL) const =0
 Sort real eigenvalues optionally returning a permutation vector.
 
virtual NOX::Abstract::Group::ReturnType sort (int n, double *r_evals, double *i_evals=NULL, std::vector< int > *perm=NULL) const =0
 Sort complex eigenvalues optionally returning a permutation vector.
 

Detailed Description

Largest-real sorting strategy.

Sorts eigenvalues in decreasing order according to their real part. This method requires no parameters in the eigenParams argument to the constructor

Constructor & Destructor Documentation

◆ LargestReal()

LOCA::EigenvalueSort::LargestReal::LargestReal ( const Teuchos::RCP< LOCA::GlobalData > &  ,
const Teuchos::RCP< Teuchos::ParameterList > &   
)
inline

Constructor.

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

Member Function Documentation

◆ sort() [1/2]

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

Sort real eigenvalues.

Implements LOCA::EigenvalueSort::AbstractStrategy.

References NOX::Abstract::Group::Ok.

◆ sort() [2/2]

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

Sort complex eigenvalues.

Implements LOCA::EigenvalueSort::AbstractStrategy.

References NOX::Abstract::Group::Ok.


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