Reference documentation for deal.II version GIT relicensing-1125-gadd8e16ae6 2024-07-19 10:00:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Member Functions | Public Attributes | List of all members
ArpackSolver::AdditionalData Struct Reference

#include <deal.II/lac/arpack_solver.h>

Public Member Functions

 AdditionalData (const unsigned int number_of_arnoldi_vectors=15, const WhichEigenvalues eigenvalue_of_interest=largest_magnitude, const bool symmetric=false)

Public Attributes

const unsigned int number_of_arnoldi_vectors
const WhichEigenvalues eigenvalue_of_interest
const bool symmetric

Detailed Description

Standardized data struct to pipe additional data to the solver.

Definition at line 225 of file arpack_solver.h.

Constructor & Destructor Documentation

◆ AdditionalData()

ArpackSolver::AdditionalData::AdditionalData ( const unsigned int  number_of_arnoldi_vectors = 15,
const WhichEigenvalues  eigenvalue_of_interest = largest_magnitude,
const bool  symmetric = false 

Constructor. By default, set the number of Arnoldi vectors (Lanczos vectors if the problem is symmetric) to 15. Set the solver to find the eigenvalues of largest magnitude for a non-symmetric problem).

Definition at line 455 of file arpack_solver.h.

Member Data Documentation

◆ number_of_arnoldi_vectors

const unsigned int ArpackSolver::AdditionalData::number_of_arnoldi_vectors

Number of Arnoldi/Lanczos vectors. This number should be less than the size of the problem but greater than 2 times the number of eigenvalues (or n_eigenvalues if it is set) plus one.

Definition at line 242 of file arpack_solver.h.

◆ eigenvalue_of_interest

const WhichEigenvalues ArpackSolver::AdditionalData::eigenvalue_of_interest

Specify the eigenvalues of interest.

Definition at line 247 of file arpack_solver.h.

◆ symmetric

const bool ArpackSolver::AdditionalData::symmetric

Specify if the problem is symmetric or not.

Definition at line 252 of file arpack_solver.h.

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