LOCA::EigenvalueSort::SmallestMagnitude Class Reference
Smallest-magnitude sorting strategy. More...
#include <LOCA_EigenvalueSort_Strategies.H>
Public Member Functions | |
| SmallestMagnitude (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams) | |
| Constructor. | |
| ~SmallestMagnitude () | |
| 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. | |
Private Member Functions | |
| SmallestMagnitude (const SmallestMagnitude &) | |
| Private to prohibit copying. | |
| SmallestMagnitude & | operator= (const SmallestMagnitude &) |
| Private to prohibit copying. | |
Detailed Description
Smallest-magnitude sorting strategy.
Sorts eigenvalues in increasing order according to their magnitude. This method requires no parameters in the eigenParams argument to the constructor
Definition at line 190 of file LOCA_EigenvalueSort_Strategies.H.
Constructor & Destructor Documentation
| LOCA::EigenvalueSort::SmallestMagnitude::SmallestMagnitude | ( | const Teuchos::RCP< LOCA::GlobalData > & | global_data, | |
| const Teuchos::RCP< Teuchos::ParameterList > & | eigenParams | |||
| ) | [inline] |
Constructor.
- Parameters:
-
global_data [in] Global data object eigenParams [in] Eigensolver parameters.
Definition at line 199 of file LOCA_EigenvalueSort_Strategies.H.
| LOCA::EigenvalueSort::SmallestMagnitude::~SmallestMagnitude | ( | ) | [inline] |
| LOCA::EigenvalueSort::SmallestMagnitude::SmallestMagnitude | ( | const SmallestMagnitude & | ) | [private] |
Private to prohibit copying.
Member Function Documentation
| NOX::Abstract::Group::ReturnType LOCA::EigenvalueSort::SmallestMagnitude::sort | ( | int | n, | |
| double * | evals, | |||
| std::vector< int > * | perm = NULL | |||
| ) | const [virtual] |
Sort real eigenvalues.
Implements LOCA::EigenvalueSort::AbstractStrategy.
Definition at line 120 of file LOCA_EigenvalueSort_Strategies.C.
References NOX::Abstract::Group::Ok.
| NOX::Abstract::Group::ReturnType LOCA::EigenvalueSort::SmallestMagnitude::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 155 of file LOCA_EigenvalueSort_Strategies.C.
References NOX::Abstract::Group::Ok.
| SmallestMagnitude& LOCA::EigenvalueSort::SmallestMagnitude::operator= | ( | const SmallestMagnitude & | ) | [private] |
Private to prohibit copying.
The documentation for this class was generated from the following files:
