Class documentation of Concepts

Loading...
Searching...
No Matches
eigensolver::ArPackFabric Class Referenceabstract

#include <arpackFabric.hh>

Inheritance diagram for eigensolver::ArPackFabric:
eigensolver::SolverFabric< F > concepts::OutputOperator

Public Member Functions

 ArPackFabric (int kmax=1, Real tol=0.0, const int maxiter=300, enum ArPackSymm::which target=ArPackSymm::SM, enum ArPackSymm::modus mode=ArPackSymm::REGINV, const Real sigma=0.0, const concepts::Vector< Real > *start=0)
 
virtual ArPackSymmoperator() (concepts::Operator< Real > &stiff, concepts::Operator< Real > &mass)
 
virtual EigenSolver< F > & operator() (concepts::Operator< F > &stiff, concepts::Operator< Real > &mass)=0
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

Fabric class for ARPACK eigenvalue solver for a constrained problem.

Author
Philipp Frauenfelder, 2002
Test:

test::GolubExample

test::GolubExampleSum

test::MaxwellTransmissionEVP

Definition at line 24 of file arpackFabric.hh.

Constructor & Destructor Documentation

◆ ArPackFabric()

eigensolver::ArPackFabric::ArPackFabric ( int  kmax = 1,
Real  tol = 0.0,
const int  maxiter = 300,
enum ArPackSymm::which  target = ArPackSymm::SM,
enum ArPackSymm::modus  mode = ArPackSymm::REGINV,
const Real  sigma = 0.0,
const concepts::Vector< Real > *  start = 0 
)
inline

Constructor.

Parameters
kmaxNumber of eigenpairs to be computed
tolConvergence tolerance for the eigenpairs. The default value 0.0 is replaced by DLAMCH('EPS') from LAPACK.
maxiterMaximum number of Arnoldi iterations allowed
targetWhat sort of eigenvalues to compute
modeMode in which ARPACK should be used
sigmaShift for the shift-invert, Buckling or Cayley mode
startStarting vector, if not given ARPACK invents one

Definition at line 36 of file arpackFabric.hh.

Member Function Documentation

◆ info()

virtual std::ostream & eigensolver::ArPackFabric::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

◆ operator()()

template<typename F >
virtual EigenSolver< F > & eigensolver::SolverFabric< F >::operator() ( concepts::Operator< F > &  stiff,
concepts::Operator< Real > &  mass 
)
pure virtualinherited

Creates an eigenvalue solver which solves the abstract eigenvalue problem defined by stiff and mass. This fabric should only by used once as subsequent uses would invalidate older solvers.

Returns
Pointer to eigenvalue solver

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