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

LinearAlgebraDistribution *	distribution_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)

void	build_distribution (const LinearAlgebraDistribution &dist)

Private Types
typedef double	ST

typedef Teuchos::ScalarTraits< ST >	SCT

typedef SCT::magnitudeType	MT

typedef Anasazi::MultiVec< ST >	MV

typedef Anasazi::Operator< ST >	OP

typedef Anasazi::MultiVecTraits< ST, MV >	MVT

typedef Anasazi::OperatorTraits< ST, MV, OP >	OPT

Private Attributes
Anasazi::OutputManager< ST > *	Output_manager_pt
	Pointer to output manager. More...

LinearSolver *	Linear_solver_pt
	Pointer to a linear solver. More...

LinearSolver *	Default_linear_solver_pt
	Pointer to a default linear solver. More...

int	Spectrum

int	NArnoldi
	Number of Arnoldi vectors to compute. More...

double	Sigma
	Set the shifted value. More...

bool	Small

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 ()

Protected Attributes inherited from oomph::EigenSolver
double	Sigma_real

Detailed Description

Class for the Anasazi eigensolver.

Member Typedef Documentation

◆ MT

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

private

◆ MV

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

private

◆ MVT

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

private

◆ OP

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

private

◆ OPT

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

private

◆ SCT

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

private

◆ ST

typedef double oomph::ANASAZI::ST

private

Constructor & Destructor Documentation

◆ ANASAZI() [1/2]

oomph::ANASAZI::ANASAZI ( )

inline

Constructor.

       : Linear_solver_pt(0),
         Default_linear_solver_pt(0),
         Spectrum(0),
         NArnoldi(10),
         Sigma(0.0),
         Compute_eigenvectors(true)
     {
       Output_manager_pt = new Anasazi::BasicOutputManager<ST>();
       // Set verbosity level
       int verbosity =
         Anasazi::Warnings + Anasazi::FinalSummary + Anasazi::TimingDetails;
       Output_manager_pt->setVerbosity(verbosity);
  
       // print greeting
       Output_manager_pt->stream(Anasazi::Warnings)
         << Anasazi::Anasazi_Version() << std::endl
         << std::endl;
     }

References Output_manager_pt.

◆ ANASAZI() [2/2]

oomph::ANASAZI::ANASAZI ( const ANASAZI & )

inline

Empty copy constructor.

632 : Sigma(0.0) {}

◆ ~ANASAZI()

virtual oomph::ANASAZI::~ANASAZI ( )

inlinevirtual

Destructor, delete the linear solver.

635 {}

Member Function Documentation

◆ disable_compute_eigenvectors()

void oomph::ANASAZI::disable_compute_eigenvectors ( )

inline

Set to disable the computation of the eigenvectors.

     {
       Compute_eigenvectors = false;
     }

References Compute_eigenvectors.

◆ enable_compute_eigenvectors()

void oomph::ANASAZI::enable_compute_eigenvectors ( )

inline

Set to enable the computation of the eigenvectors (default)

     {
       Compute_eigenvectors = true;
     }

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.

     {
       Small = true;
     }

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.

     {
       Small = false;
     }

References Small.

◆ linear_solver_pt() [1/2]

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

inline

Return a pointer to the linear solver object.

     {
       return Linear_solver_pt;
     }

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)

     {
       return Linear_solver_pt;
     }

References Linear_solver_pt.

◆ narnoldi() [1/2]

int& oomph::ANASAZI::narnoldi ( )

inline

Access function for the number of Arnoldi vectors.

     {
       return NArnoldi;
     }

References NArnoldi.

◆ narnoldi() [2/2]

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

inline

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

     {
       return NArnoldi;
     }

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

Solve the eigen problem.

Implements oomph::EigenSolver.

     {
       // No access to sigma, so set from sigma real
       Sigma = Sigma_real;
  
       // Initially be dumb here
       Linear_solver_pt = problem_pt->linear_solver_pt();
  
       // Let's make the initial vector
       Teuchos::RCP<DoubleMultiVector> initial = Teuchos::rcp(
         new DoubleMultiVector(1, problem_pt->dof_distribution_pt()));
       Anasazi::MultiVecTraits<double, DoubleMultiVector>::MvRandom(*initial);
  
       // Make the operator
       Teuchos::RCP<DoubleMultiVectorOperator> Op_pt =
         Teuchos::rcp(new ProblemBasedShiftInvertOperator(
           problem_pt, this->linear_solver_pt(), Sigma));
  
       // Create the basic problem
       Teuchos::RCP<Anasazi::BasicEigenproblem<double,
                                               DoubleMultiVector,
                                               DoubleMultiVectorOperator>>
         anasazi_pt = Teuchos::rcp(
           new Anasazi::BasicEigenproblem<double,
                                          DoubleMultiVector,
                                          DoubleMultiVectorOperator>(Op_pt,
                                                                     initial));
  
       // Think I have it?
       anasazi_pt->setHermitian(false);
  
       // set the number of eigenvalues requested
       anasazi_pt->setNEV(n_eval);
  
       // Inform the eigenproblem that you are done passing it information
       if (anasazi_pt->setProblem() != true)
       {
         oomph_info << "Anasazi::BasicEigenproblem::setProblem() had an error."
                    << std::endl
                    << "End Result: TEST FAILED" << std::endl;
       }
  
       // Create the solver manager
       // No need to have ncv specificed, Triliinos has a sensible default
       //  int ncv = 10;
       MT tol = 1.0e-10;
       int verbosity =
         Anasazi::Warnings + Anasazi::FinalSummary + Anasazi::TimingDetails;
  
       Teuchos::ParameterList MyPL;
       MyPL.set("Which", "LM");
       MyPL.set("Block Size", 1);
       //  MyPL.set( "Num Blocks", ncv );
       MyPL.set("Maximum Restarts", 500);
       MyPL.set("Orthogonalization", "DGKS");
       MyPL.set("Verbosity", verbosity);
       MyPL.set("Convergence Tolerance", tol);
       Anasazi::BlockKrylovSchurSolMgr<double,
                                       DoubleMultiVector,
                                       DoubleMultiVectorOperator>
         BKS(anasazi_pt, MyPL);
  
       // Solve the problem to the specified tolerances or length
       Anasazi::ReturnType ret = BKS.solve();
       bool testFailed = false;
       if (ret != Anasazi::Converged)
       {
         testFailed = true;
       }
  
       if (testFailed)
       {
         oomph_info << "Eigensolver not converged\n";
       }
  
       // Get the eigenvalues and eigenvectors from the eigenproblem
       Anasazi::Eigensolution<double, DoubleMultiVector> sol =
         anasazi_pt->getSolution();
       std::vector<Anasazi::Value<double>> evals = sol.Evals;
       Teuchos::RCP<DoubleMultiVector> evecs = sol.Evecs;
  
       eigenvalue.resize(evals.size());
       eigenvector.resize(evals.size());
  
       for (unsigned i = 0; i < evals.size(); i++)
       {
         // Undo shift and invert
         double a = evals[i].realpart;
         double b = evals[i].imagpart;
         double det = a * a + b * b;
         eigenvalue[i] = std::complex<double>(a / det + Sigma, -b / det);
  
         // Now set the eigenvectors, I hope
         eigenvector[i].build(evecs->distribution_pt());
         unsigned nrow_local = evecs->nrow_local();
         // Would be faster with pointers, but I'll sort that out later!
         for (unsigned n = 0; n < nrow_local; n++)
         {
           eigenvector[i][n] = (*evecs)(i, n);
         }
       }
     }

References a, b, oomph::Problem::dof_distribution_pt(), i, oomph::Problem::linear_solver_pt(), Linear_solver_pt, linear_solver_pt(), n, oomph::DistributableLinearAlgebraObject::nrow_local(), oomph::oomph_info, ret, Sigma, and oomph::EigenSolver::Sigma_real.

◆ track_eigenvalue_imaginary_part()

void oomph::ANASAZI::track_eigenvalue_imaginary_part ( )

inline

Set the imaginary part fo the quantity of interest.

     {
       Spectrum = -1;
     }

References Spectrum.

◆ track_eigenvalue_magnitude()

void oomph::ANASAZI::track_eigenvalue_magnitude ( )

inline

Set the magnitude to be the quantity of interest.

     {
       Spectrum = 0;
     }

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)

     {
       Spectrum = 1;
     }

References Spectrum.

Member Data Documentation

◆ Compute_eigenvectors

bool oomph::ANASAZI::Compute_eigenvectors

private

Boolean to indicate whether or not to compute the eigenvectors.

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.

◆ Linear_solver_pt

LinearSolver* oomph::ANASAZI::Linear_solver_pt

private

Pointer to a linear solver.

Referenced by linear_solver_pt(), and solve_eigenproblem().

◆ NArnoldi

int oomph::ANASAZI::NArnoldi

private

Number of Arnoldi vectors to compute.

Referenced by narnoldi().

◆ Output_manager_pt

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

private

Pointer to output manager.

Referenced by ANASAZI().

◆ Sigma

double oomph::ANASAZI::Sigma

private

Set the shifted value.

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.

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.

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:

trilinos_eigen_solver.h

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MT

◆ MV

◆ MVT

◆ OP

◆ OPT

◆ SCT

◆ ST

Constructor & Destructor Documentation

◆ ANASAZI() [1/2]

◆ ANASAZI() [2/2]

◆ ~ANASAZI()

Member Function Documentation

◆ disable_compute_eigenvectors()

◆ enable_compute_eigenvectors()

◆ get_eigenvalues_left_of_shift()

◆ get_eigenvalues_right_of_shift()

◆ linear_solver_pt() [1/2]

◆ linear_solver_pt() [2/2]

◆ narnoldi() [1/2]

◆ narnoldi() [2/2]

◆ solve_eigenproblem()

◆ track_eigenvalue_imaginary_part()

◆ track_eigenvalue_magnitude()

◆ track_eigenvalue_real_part()

Member Data Documentation

◆ Compute_eigenvectors

◆ Default_linear_solver_pt

◆ Linear_solver_pt

◆ NArnoldi

◆ Output_manager_pt

◆ Sigma

◆ Small

◆ Spectrum