emsunfold::TrlanDiagnostics Class Reference

#include <trlanEigensystem.hh>

Public Member Functions
	TrlanDiagnostics ()
	TrlanDiagnostics (double tailFraction, const int ipar[32])
double	finalTailFraction () const
int	status () const
int	nConverged () const
int	nLocked () const
int	nMatVec () const
int	nRestart () const
int	nOrth () const
int	nRand () const
int	tTotal () const
int	tMatVec () const
int	tOrth () const
int	tRestart () const

Detailed Description

TRLAN diagnostic information, in a slightly more convenient form than that provided by the Fortran 77 interface "trlan77".

Constructor & Destructor Documentation

TrlanDiagnostics() [1/2]

emsunfold::TrlanDiagnostics::TrlanDiagnostics

(

)

Default constructor creates a dummy object which is supposed to be overwritten later.

TrlanDiagnostics() [2/2]

emsunfold::TrlanDiagnostics::TrlanDiagnostics	(	double	tailFraction,
		const int	ipar[32]
	)

The arguments of this constructor are as follows:

tailFraction – The fraction of eigenvalues not found. This is (trace - (sum of eigenvalues found))/trace.

ipar – input/output parameters of the trlan77 routine.

Member Function Documentation

finalTailFraction()

double emsunfold::TrlanDiagnostics::finalTailFraction ( ) const

inline

((matrix trace) - (sum of eigenvalues found))/(matrix trace). For the diagnostics object created by the default constructor, this method returns -1.0.

nConverged()

int emsunfold::TrlanDiagnostics::nConverged ( ) const

inline

Number of eigenpairs actually determined. Note that it could be less than the number requested.

nLocked()

int emsunfold::TrlanDiagnostics::nLocked ( ) const

inline

Number of Ritz pairs locked (with small residual norms)

nMatVec()

int emsunfold::TrlanDiagnostics::nMatVec ( ) const

inline

Actual number of matrix-vector multiplications performed

nOrth()

int emsunfold::TrlanDiagnostics::nOrth ( ) const

inline

Number of times the Gram-Schmidt orthogonalization has been applied

nRand()

int emsunfold::TrlanDiagnostics::nRand ( ) const

inline

Number of times initial random vectors were generated

nRestart()

int emsunfold::TrlanDiagnostics::nRestart ( ) const

inline

Number of restarting loops

status()

int emsunfold::TrlanDiagnostics::status ( ) const

inline

Error code returned by TRLAN. 0 means no error. For the list of error codes, consult the TRLAN user guide.

tMatVec()

int emsunfold::TrlanDiagnostics::tMatVec ( ) const

inline

Time spent multiplying matrix by vectors, in ms

tOrth()

int emsunfold::TrlanDiagnostics::tOrth ( ) const

inline

Time spent re-orthogonalizing, in ms

tRestart()

int emsunfold::TrlanDiagnostics::tRestart ( ) const

inline

Time spent in restarting and Rayleigh-Ritz projections, in ms

tTotal()

int emsunfold::TrlanDiagnostics::tTotal ( ) const

inline

Total TRLAN run time, in milliseconds

---

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

• emsunfold/trlanEigensystem.hh