Description

Class for passing basic settings to the Solve() function of the various solvers.

#include <ChEigenvalueSolver.h>

Public Member Functions
	ChEigenvalueSolverSettings (int m_nmodes, int max_iters=500, double mtolerance=1e-10, bool mverbose=false, std::complex< double > msigma=1e-5)

Public Attributes
int	n_modes = 10

double	tolerance = 1e-10
	tolerance for the iterative solver.

std::complex< double >	sigma = 1e-5
	for shift&invert. Too small gives ill conditioning (no convergence). Too large misses rigid body modes.

int	max_iterations = 500
	upper limit for the number of iterations. If too low might not converge.

bool	verbose = false
	turn to true to see some diagnostic.

Constructor & Destructor Documentation

chrono::modal::ChEigenvalueSolverSettings::ChEigenvalueSolverSettings	(	int	m_nmodes,
		int	max_iters = `500`,
		double	mtolerance = `1e-10`,
		bool	mverbose = `false`,
		std::complex< double >	msigma = `1e-5`
	)

inline

Parameters

m_nmodes	optional: n. of desired lower eigenvalues. If =0, return all eigenvalues.
max_iters	upper limit for the number of iterations. If too low might not converge.
mtolerance	tolerance for the iterative solver.
mverbose	turn to true to see some diagnostic.
msigma	for shift&invert. Too small gives ill conditioning (no convergence). Too large misses rigid body modes.

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