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

Class for the ARPACK eigensolver. More...

#include <eigen_solver.h>

+ Inheritance diagram for oomph::ARPACK:

Public Member Functions

 ARPACK ()
 Constructor. More...
 
 ARPACK (const ARPACK &)
 Empty copy constructor. More...
 
virtual ~ARPACK ()
 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 ()
 Use the eigensolver to find the eigenvalues of a given matrix. 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)
 Broken copy constructor. More...
 
void operator= (const DistributableLinearAlgebraObject &)
 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
 
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 Attributes

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...
 
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 ARPACK eigensolver.

Definition at line 103 of file eigen_solver.h.

Constructor & Destructor Documentation

oomph::ARPACK::ARPACK ( )

Constructor.

Constructor, set default values and set the initial linear solver to be superlu

Definition at line 53 of file eigen_solver.cc.

References Default_linear_solver_pt, and Linear_solver_pt.

oomph::ARPACK::ARPACK ( const ARPACK )
inline

Empty copy constructor.

Definition at line 136 of file eigen_solver.h.

oomph::ARPACK::~ARPACK ( )
virtual

Destructor, delete the linear solver.

Destructor, delete the default linear solver.

Definition at line 60 of file eigen_solver.cc.

References Default_linear_solver_pt.

Member Function Documentation

void oomph::ARPACK::disable_compute_eigenvectors ( )
inline

Set to disable the computation of the eigenvectors.

Definition at line 151 of file eigen_solver.h.

References Compute_eigenvectors.

void oomph::ARPACK::enable_compute_eigenvectors ( )
inline

Set to enable the computation of the eigenvectors (default)

Definition at line 148 of file eigen_solver.h.

References Compute_eigenvectors.

void oomph::ARPACK::get_eigenvalues_left_of_shift ( )
inline

Use the eigensolver to find the eigenvalues of a given matrix.

Set the desired eigenvalues to be left of the shift

Definition at line 166 of file eigen_solver.h.

References Small.

void oomph::ARPACK::get_eigenvalues_right_of_shift ( )
inline

Set the desired eigenvalues to be right of the shift.

Definition at line 169 of file eigen_solver.h.

References Small.

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

Return a pointer to the linear solver object.

Definition at line 181 of file eigen_solver.h.

References Linear_solver_pt.

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

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

Definition at line 184 of file eigen_solver.h.

References Linear_solver_pt.

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

Access function for the number of Arnoldi vectors.

Definition at line 142 of file eigen_solver.h.

References NArnoldi.

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

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

Definition at line 145 of file eigen_solver.h.

References NArnoldi.

void oomph::ARPACK::solve_eigenproblem ( Problem *const &  problem_pt,
const int &  n_eval,
Vector< std::complex< double > > &  eigenvalue,
Vector< DoubleVector > &  eigenvector 
)
virtual
void oomph::ARPACK::track_eigenvalue_imaginary_part ( )
inline

Set the imaginary part fo the quantity of interest.

Definition at line 175 of file eigen_solver.h.

References Spectrum.

void oomph::ARPACK::track_eigenvalue_magnitude ( )
inline

Set the magnitude to be the quantity of interest.

Definition at line 178 of file eigen_solver.h.

References Spectrum.

void oomph::ARPACK::track_eigenvalue_real_part ( )
inline

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

Definition at line 172 of file eigen_solver.h.

References Spectrum.

Member Data Documentation

bool oomph::ARPACK::Compute_eigenvectors
private

Boolean to indicate whether or not to compute the eigenvectors.

Definition at line 127 of file eigen_solver.h.

Referenced by disable_compute_eigenvectors(), enable_compute_eigenvectors(), and solve_eigenproblem().

LinearSolver* oomph::ARPACK::Default_linear_solver_pt
private

Pointer to a default linear solver.

Definition at line 111 of file eigen_solver.h.

Referenced by ARPACK(), and ~ARPACK().

LinearSolver* oomph::ARPACK::Linear_solver_pt
private

Pointer to a linear solver.

Definition at line 108 of file eigen_solver.h.

Referenced by ARPACK(), linear_solver_pt(), and solve_eigenproblem().

int oomph::ARPACK::NArnoldi
private

Number of Arnoldi vectors to compute.

Definition at line 119 of file eigen_solver.h.

Referenced by narnoldi(), and solve_eigenproblem().

bool oomph::ARPACK::Small
private

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

Definition at line 124 of file eigen_solver.h.

Referenced by get_eigenvalues_left_of_shift(), get_eigenvalues_right_of_shift(), and solve_eigenproblem().

int oomph::ARPACK::Spectrum
private

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

Definition at line 115 of file eigen_solver.h.

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


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