MFEM  v4.6.0
Finite element discretization library
Public Member Functions | List of all members
mfem::HypreAME Class Reference

#include <hypre.hpp>

Public Member Functions

 HypreAME (MPI_Comm comm)
 ~HypreAME ()
void SetTol (double tol)
void SetRelTol (double rel_tol)
void SetMaxIter (int max_iter)
void SetPrintLevel (int logging)
void SetNumModes (int num_eigs)
void SetPreconditioner (HypreSolver &precond)
void SetOperator (const HypreParMatrix &A)
void SetMassMatrix (const HypreParMatrix &M)
void Solve ()
 Solve the eigenproblem. More...
void GetEigenvalues (Array< double > &eigenvalues) const
 Collect the converged eigenvalues. More...
const HypreParVectorGetEigenvector (unsigned int i) const
 Extract a single eigenvector. More...
HypreParVector ** StealEigenvectors ()
 Transfer ownership of the converged eigenvectors. More...

Detailed Description

AME eigenvalue solver in hypre

The Auxiliary space Maxwell Eigensolver (AME) is designed to find the lowest eigenmodes of the generalized eigenvalue problem: Curl Curl x = lambda M x where the Curl Curl operator is discretized using Nedelec finite element basis functions. Properties of this discretization are essential to eliminating the large null space of the Curl Curl operator.

This eigensolver relies upon the LOBPCG eigensolver internally. It is also expected that the preconditioner supplied to this method will be the HypreAMS preconditioner defined above.

As with LOBPCG, the operator set in the preconditioner need not be the same as A. This flexibility may be useful in solving eigenproblems which bare a strong resemblance to the Curl Curl problems for which AME is designed.

Unlike LOBPCG, this eigensolver requires that the mass matrix be set. It is possible to circumvent this by passing an identity operator as the mass matrix but it seems unlikely that this would be useful so it is not the default behavior.

Definition at line 2048 of file hypre.hpp.

Constructor & Destructor Documentation

◆ HypreAME()

mfem::HypreAME::HypreAME ( MPI_Comm  comm)

Definition at line 6369 of file hypre.cpp.

◆ ~HypreAME()

mfem::HypreAME::~HypreAME ( )

Definition at line 6386 of file hypre.cpp.

Member Function Documentation

◆ GetEigenvalues()

void mfem::HypreAME::GetEigenvalues ( Array< double > &  eigenvalues) const

Collect the converged eigenvalues.

Definition at line 6490 of file hypre.cpp.

◆ GetEigenvector()

const HypreParVector & mfem::HypreAME::GetEigenvector ( unsigned int  i) const

Extract a single eigenvector.

Definition at line 6514 of file hypre.cpp.

◆ SetMassMatrix()

void mfem::HypreAME::SetMassMatrix ( const HypreParMatrix M)

Definition at line 6471 of file hypre.cpp.

◆ SetMaxIter()

void mfem::HypreAME::SetMaxIter ( int  max_iter)

Definition at line 6435 of file hypre.cpp.

◆ SetNumModes()

void mfem::HypreAME::SetNumModes ( int  num_eigs)

Definition at line 6411 of file hypre.cpp.

◆ SetOperator()

void mfem::HypreAME::SetOperator ( const HypreParMatrix A)

Definition at line 6456 of file hypre.cpp.

◆ SetPreconditioner()

void mfem::HypreAME::SetPreconditioner ( HypreSolver precond)

Definition at line 6450 of file hypre.cpp.

◆ SetPrintLevel()

void mfem::HypreAME::SetPrintLevel ( int  logging)

Definition at line 6441 of file hypre.cpp.

◆ SetRelTol()

void mfem::HypreAME::SetRelTol ( double  rel_tol)

Definition at line 6425 of file hypre.cpp.

◆ SetTol()

void mfem::HypreAME::SetTol ( double  tol)

Definition at line 6419 of file hypre.cpp.

◆ Solve()

void mfem::HypreAME::Solve ( )

Solve the eigenproblem.

Definition at line 6478 of file hypre.cpp.

◆ StealEigenvectors()

HypreParVector ** mfem::HypreAME::StealEigenvectors ( )

Transfer ownership of the converged eigenvectors.

Definition at line 6525 of file hypre.cpp.

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