Public Member Functions | Private Types | Private Attributes | List of all members
oomph::ANASAZI Class Reference

Class for the Anasazi eigensolver. More...

#include <trilinos_eigen_solver.h>

+ Inheritance diagram for oomph::ANASAZI:

Public Member Functions

 ANASAZI ()
 Constructor. More...
 
 ANASAZI (const ANASAZI &)
 Empty copy constructor. More...
 
virtual ~ANASAZI ()
 Destructor, delete the linear solver. More...
 
int & narnoldi ()
 Access function for the number of Arnoldi vectors. More...
 
const int & narnoldi () const
 Access function for the number of Arnoldi vectors (const version) More...
 
void enable_compute_eigenvectors ()
 Set to enable the computation of the eigenvectors (default) More...
 
void disable_compute_eigenvectors ()
 Set to disable the computation of the eigenvectors. More...
 
void solve_eigenproblem (Problem *const &problem_pt, const int &n_eval, Vector< std::complex< double > > &eigenvalue, Vector< DoubleVector > &eigenvector)
 Solve the eigen problem. More...
 
void get_eigenvalues_left_of_shift ()
 Set the desired eigenvalues to be left of the shift. More...
 
void get_eigenvalues_right_of_shift ()
 Set the desired eigenvalues to be right of the shift. More...
 
void track_eigenvalue_real_part ()
 Set the real part to be the quantity of interest (default) More...
 
void track_eigenvalue_imaginary_part ()
 Set the imaginary part fo the quantity of interest. More...
 
void track_eigenvalue_magnitude ()
 Set the magnitude to be the quantity of interest. More...
 
LinearSolver *& linear_solver_pt ()
 Return a pointer to the linear solver object. More...
 
LinearSolver *const & linear_solver_pt () const
 Return a pointer to the linear solver object (const version) More...
 
- Public Member Functions inherited from oomph::EigenSolver
 EigenSolver ()
 Empty constructor. More...
 
 EigenSolver (const EigenSolver &)
 Empty copy constructor. More...
 
virtual ~EigenSolver ()
 Empty destructor. More...
 
void set_shift (const double &shift_value)
 Set the value of the shift. More...
 
const double & get_shift () const
 Return the value of the shift (const version) More...
 
- Public Member Functions inherited from oomph::DistributableLinearAlgebraObject
 DistributableLinearAlgebraObject ()
 Default constructor - create a distribution. More...
 
 DistributableLinearAlgebraObject (const DistributableLinearAlgebraObject &matrix)=delete
 Broken copy constructor. More...
 
void operator= (const DistributableLinearAlgebraObject &)=delete
 Broken assignment operator. More...
 
virtual ~DistributableLinearAlgebraObject ()
 Destructor. More...
 
LinearAlgebraDistributiondistribution_pt () const
 access to the LinearAlgebraDistribution More...
 
unsigned nrow () const
 access function to the number of global rows. More...
 
unsigned nrow_local () const
 access function for the num of local rows on this processor. More...
 
unsigned nrow_local (const unsigned &p) const
 access function for the num of local rows on this processor. More...
 
unsigned first_row () const
 access function for the first row on this processor More...
 
unsigned first_row (const unsigned &p) const
 access function for the first row on this processor More...
 
bool distributed () const
 distribution is serial or distributed More...
 
bool distribution_built () const
 if the communicator_pt is null then the distribution is not setup then false is returned, otherwise return true More...
 
void build_distribution (const LinearAlgebraDistribution *const dist_pt)
 setup the distribution of this distributable linear algebra object More...
 
void build_distribution (const LinearAlgebraDistribution &dist)
 setup the distribution of this distributable linear algebra object More...
 

Private Types

typedef double ST
 
typedef Teuchos::ScalarTraits< STSCT
 
typedef SCT::magnitudeType MT
 
typedef Anasazi::MultiVec< STMV
 
typedef Anasazi::Operator< STOP
 
typedef Anasazi::MultiVecTraits< ST, MVMVT
 
typedef Anasazi::OperatorTraits< ST, MV, OPOPT
 

Private Attributes

Anasazi::OutputManager< ST > * Output_manager_pt
 Pointer to output manager. More...
 
LinearSolverLinear_solver_pt
 Pointer to a linear solver. More...
 
LinearSolverDefault_linear_solver_pt
 Pointer to a default linear solver. More...
 
int Spectrum
 Integer to set whether the real, imaginary or magnitude is required to be small or large. More...
 
int NArnoldi
 Number of Arnoldi vectors to compute. More...
 
double Sigma
 Set the shifted value. More...
 
bool Small
 Boolean to set which part of the spectrum left (default) or right of the shifted value. More...
 
bool Compute_eigenvectors
 Boolean to indicate whether or not to compute the eigenvectors. More...
 

Additional Inherited Members

- Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void clear_distribution ()
 clear the distribution of this distributable linear algebra object More...
 
- Protected Attributes inherited from oomph::EigenSolver
double Sigma_real
 Double value that represents the real part of the shift in shifted eigensolvers. More...
 

Detailed Description

Class for the Anasazi eigensolver.

Definition at line 570 of file trilinos_eigen_solver.h.

Member Typedef Documentation

◆ MT

typedef SCT::magnitudeType oomph::ANASAZI::MT
private

Definition at line 575 of file trilinos_eigen_solver.h.

◆ MV

typedef Anasazi::MultiVec<ST> oomph::ANASAZI::MV
private

Definition at line 576 of file trilinos_eigen_solver.h.

◆ MVT

typedef Anasazi::MultiVecTraits<ST, MV> oomph::ANASAZI::MVT
private

Definition at line 578 of file trilinos_eigen_solver.h.

◆ OP

typedef Anasazi::Operator<ST> oomph::ANASAZI::OP
private

Definition at line 577 of file trilinos_eigen_solver.h.

◆ OPT

typedef Anasazi::OperatorTraits<ST, MV, OP> oomph::ANASAZI::OPT
private

Definition at line 579 of file trilinos_eigen_solver.h.

◆ SCT

typedef Teuchos::ScalarTraits<ST> oomph::ANASAZI::SCT
private

Definition at line 574 of file trilinos_eigen_solver.h.

◆ ST

typedef double oomph::ANASAZI::ST
private

Definition at line 573 of file trilinos_eigen_solver.h.

Constructor & Destructor Documentation

◆ ANASAZI() [1/2]

oomph::ANASAZI::ANASAZI ( )
inline

Constructor.

Definition at line 611 of file trilinos_eigen_solver.h.

References Output_manager_pt.

◆ ANASAZI() [2/2]

oomph::ANASAZI::ANASAZI ( const ANASAZI )
inline

Empty copy constructor.

Definition at line 632 of file trilinos_eigen_solver.h.

◆ ~ANASAZI()

virtual oomph::ANASAZI::~ANASAZI ( )
inlinevirtual

Destructor, delete the linear solver.

Definition at line 635 of file trilinos_eigen_solver.h.

Member Function Documentation

◆ disable_compute_eigenvectors()

void oomph::ANASAZI::disable_compute_eigenvectors ( )
inline

Set to disable the computation of the eigenvectors.

Definition at line 656 of file trilinos_eigen_solver.h.

References Compute_eigenvectors.

◆ enable_compute_eigenvectors()

void oomph::ANASAZI::enable_compute_eigenvectors ( )
inline

Set to enable the computation of the eigenvectors (default)

Definition at line 650 of file trilinos_eigen_solver.h.

References Compute_eigenvectors.

◆ get_eigenvalues_left_of_shift()

void oomph::ANASAZI::get_eigenvalues_left_of_shift ( )
inline

Set the desired eigenvalues to be left of the shift.

Definition at line 769 of file trilinos_eigen_solver.h.

References Small.

◆ get_eigenvalues_right_of_shift()

void oomph::ANASAZI::get_eigenvalues_right_of_shift ( )
inline

Set the desired eigenvalues to be right of the shift.

Definition at line 775 of file trilinos_eigen_solver.h.

References Small.

◆ linear_solver_pt() [1/2]

LinearSolver *& oomph::ANASAZI::linear_solver_pt ( )
inline

Return a pointer to the linear solver object.

Definition at line 799 of file trilinos_eigen_solver.h.

References Linear_solver_pt.

Referenced by solve_eigenproblem().

◆ linear_solver_pt() [2/2]

LinearSolver *const & oomph::ANASAZI::linear_solver_pt ( ) const
inline

Return a pointer to the linear solver object (const version)

Definition at line 805 of file trilinos_eigen_solver.h.

References Linear_solver_pt.

◆ narnoldi() [1/2]

int & oomph::ANASAZI::narnoldi ( )
inline

Access function for the number of Arnoldi vectors.

Definition at line 638 of file trilinos_eigen_solver.h.

References NArnoldi.

◆ narnoldi() [2/2]

const int & oomph::ANASAZI::narnoldi ( ) const
inline

Access function for the number of Arnoldi vectors (const version)

Definition at line 644 of file trilinos_eigen_solver.h.

References NArnoldi.

◆ solve_eigenproblem()

void oomph::ANASAZI::solve_eigenproblem ( Problem *const &  problem_pt,
const int &  n_eval,
Vector< std::complex< double > > &  eigenvalue,
Vector< DoubleVector > &  eigenvector 
)
inlinevirtual

◆ track_eigenvalue_imaginary_part()

void oomph::ANASAZI::track_eigenvalue_imaginary_part ( )
inline

Set the imaginary part fo the quantity of interest.

Definition at line 787 of file trilinos_eigen_solver.h.

References Spectrum.

◆ track_eigenvalue_magnitude()

void oomph::ANASAZI::track_eigenvalue_magnitude ( )
inline

Set the magnitude to be the quantity of interest.

Definition at line 793 of file trilinos_eigen_solver.h.

References Spectrum.

◆ track_eigenvalue_real_part()

void oomph::ANASAZI::track_eigenvalue_real_part ( )
inline

Set the real part to be the quantity of interest (default)

Definition at line 781 of file trilinos_eigen_solver.h.

References Spectrum.

Member Data Documentation

◆ Compute_eigenvectors

bool oomph::ANASAZI::Compute_eigenvectors
private

Boolean to indicate whether or not to compute the eigenvectors.

Definition at line 606 of file trilinos_eigen_solver.h.

Referenced by disable_compute_eigenvectors(), and enable_compute_eigenvectors().

◆ Default_linear_solver_pt

LinearSolver* oomph::ANASAZI::Default_linear_solver_pt
private

Pointer to a default linear solver.

Definition at line 588 of file trilinos_eigen_solver.h.

◆ Linear_solver_pt

LinearSolver* oomph::ANASAZI::Linear_solver_pt
private

Pointer to a linear solver.

Definition at line 585 of file trilinos_eigen_solver.h.

Referenced by linear_solver_pt(), and solve_eigenproblem().

◆ NArnoldi

int oomph::ANASAZI::NArnoldi
private

Number of Arnoldi vectors to compute.

Definition at line 596 of file trilinos_eigen_solver.h.

Referenced by narnoldi().

◆ Output_manager_pt

Anasazi::OutputManager<ST>* oomph::ANASAZI::Output_manager_pt
private

Pointer to output manager.

Definition at line 582 of file trilinos_eigen_solver.h.

Referenced by ANASAZI().

◆ Sigma

double oomph::ANASAZI::Sigma
private

Set the shifted value.

Definition at line 599 of file trilinos_eigen_solver.h.

Referenced by solve_eigenproblem().

◆ Small

bool oomph::ANASAZI::Small
private

Boolean to set which part of the spectrum left (default) or right of the shifted value.

Definition at line 603 of file trilinos_eigen_solver.h.

Referenced by get_eigenvalues_left_of_shift(), and get_eigenvalues_right_of_shift().

◆ Spectrum

int oomph::ANASAZI::Spectrum
private

Integer to set whether the real, imaginary or magnitude is required to be small or large.

Definition at line 593 of file trilinos_eigen_solver.h.

Referenced by track_eigenvalue_imaginary_part(), track_eigenvalue_magnitude(), and track_eigenvalue_real_part().


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