#include <sparsegeneigenvalsystemnm.h>

Inheritance diagram for oofem::SparseGeneralEigenValueSystemNM:

Collaboration diagram for oofem::SparseGeneralEigenValueSystemNM:

Public Member Functions
	SparseGeneralEigenValueSystemNM (Domain d, EngngModel m)
	Constructor.
virtual	~SparseGeneralEigenValueSystemNM ()
	Destructor.
virtual const char *	giveClassName () const =0
std::string	errorInfo (const char *func)
virtual ConvergedReason	solve (SparseMtrx &A, SparseMtrx &B, FloatArray &x, FloatMatrix &v, double rtol, int nroot)=0
Public Member Functions inherited from oofem::NumericalMethod
	NumericalMethod (Domain d, EngngModel m)
virtual	~NumericalMethod ()
	Destructor.
EngngModel *	giveEngngModel ()
virtual void	initializeFrom (InputRecord &ir)
virtual void	reinitialize ()
virtual void	setDomain (Domain *d)
virtual void	saveContext (DataStream &stream, ContextMode mode)
virtual void	restoreContext (DataStream &stream, ContextMode mode)

Additional Inherited Members
Protected Attributes inherited from oofem::NumericalMethod
Domain *	domain
	Pointer to domain.
EngngModel *	engngModel
	Pointer to engineering model.

Detailed Description

This base class is an abstraction for all numerical methods solving sparse linear system of equations. The purpose of this class is to declare the general interface to all numerical methods solving this kind of problem. This interface allows to use any suitable instance of the Numerical method class to the solve problem, and leave the whole engineering model code, including mapping, unchanged, because all instances of this class provide the common interface.

Definition at line 55 of file sparsegeneigenvalsystemnm.h.

Constructor & Destructor Documentation

◆ SparseGeneralEigenValueSystemNM()

oofem::SparseGeneralEigenValueSystemNM::SparseGeneralEigenValueSystemNM	(	Domain *	d,
		EngngModel *	m )

inline

Constructor.

Definition at line 59 of file sparsegeneigenvalsystemnm.h.

References oofem::NumericalMethod::NumericalMethod().

Referenced by oofem::InverseIteration::InverseIteration(), oofem::SLEPcSolver::SLEPcSolver(), and oofem::SubspaceIteration::SubspaceIteration().

◆ ~SparseGeneralEigenValueSystemNM()

virtual oofem::SparseGeneralEigenValueSystemNM::~SparseGeneralEigenValueSystemNM ( )

inlinevirtual

Destructor.

Definition at line 61 of file sparsegeneigenvalsystemnm.h.

Member Function Documentation

◆ errorInfo()

std::string oofem::SparseGeneralEigenValueSystemNM::errorInfo ( const char * func )

inline

Definition at line 64 of file sparsegeneigenvalsystemnm.h.

References giveClassName().

◆ giveClassName()

virtual const char * oofem::SparseGeneralEigenValueSystemNM::giveClassName ( ) const

pure virtual

Implemented in oofem::InverseIteration, oofem::SLEPcSolver, and oofem::SubspaceIteration.

Referenced by errorInfo().

◆ solve()

virtual ConvergedReason oofem::SparseGeneralEigenValueSystemNM::solve	(	SparseMtrx &	A,
		SparseMtrx &	B,
		FloatArray &	x,
		FloatMatrix &	v,
		double	rtol,
		int	nroot )

pure virtual

Solves the given sparse generalized eigen value system of equations \( Av = x^2 Bv \).

Parameters

A	coefficient matrix.
B	coefficient matrix.
v	eigen vector(s).
x	eigen value(s).
rtol	tolerance
nroot	number of required eigenvalues.

Returns: NM_Status value.