XC::EigenSolver Class Reference

Eigenvalue SOE solver. More...

#include <EigenSolver.h>

Inheritance diagram for XC::EigenSolver:

Collaboration diagram for XC::EigenSolver:

Public Member Functions
virtual int	solve (void)=0
	Causes the solver to compute the solution of the system of equations. More...
virtual int	solve (int numModes)
const int &	getNumModes (void) const
bool	getFindSmallest (void) const
void	setFindSmallest (const bool &b)
virtual const Vector &	getEigenvector (int mode) const =0
Vector	getNormalizedEigenvector (int mode) const
	Returns the autovector of the i-th mode normalized so the maximal component is 1 (infinity norm). More...
Matrix	getEigenvectors (void) const
	Returns a matrix of eigenvectors disposed in columns.
Matrix	getNormalizedEigenvectors (void) const
	Returns a matrix with the normalized eigenvectors disposed in columns (infinity norm). More...
virtual const double &	getEigenvalue (int mode) const =0
double	getAngularFrequency (int mode) const
	Return the angular frequency for the i-th mode.
double	getPeriod (int mode) const
	Returns the period for the i-th mode.
double	getFrequency (int mode) const
	Return the frequency for the i-th mode.
Vector	getEigenvalues (void) const
	Returns a vector con los eigenvalues calculados.
Vector	getAngularFrequencies (void) const
	Returns a vector with the computed angular frequencies for each mode. More...
Vector	getPeriods (void) const
	Returns a vector with the computed periods for each mode. More...
Vector	getFrequencies (void) const
	Returns a vector with the computed frequencies for each mode. More...
virtual int	setSize (void)=0
virtual const int &	getSize (void) const =0
Public Member Functions inherited from XC::Solver
virtual double	getDeterminant (void)
	Return the determinant of the system matrix.
virtual double	getRCond (const char &)
	Estimates the reciprocal of the condition number of the matrix A, in either the 1-norm or the infinity-norm, using the LU factorization computed by DGBTRF. More...
Public Member Functions inherited from XC::MovableObject
	MovableObject (int classTag, int dbTag)
	Constructor. More...
	MovableObject (int classTag)
	Constructor. More...
	MovableObject (const MovableObject &)
	Copy constructor. Doesn't copy the dbTag.
MovableObject &	operator= (const MovableObject &)
	Assignment operator. Doesn't copy the dbTag.
int	getClassTag (void) const
	Return the class identifier.
int	getDbTag (void) const
	Return the object identifier in the database.
int	getDbTag (Communicator &)
	Return the object identifier in the database.
void	setDbTag (int dbTag)
	Sets the object identifier in the database.
void	setDbTag (Communicator &)
	Sets the object identifier in the database if not already set. More...
virtual int	sendSelf (Communicator &comm)=0
	Send the object. More...
virtual int	recvSelf (const Communicator &comm)=0
	Receive the object. More...
virtual int	setParameter (const std::vector< std::string > &argv, Parameter &param)
	Sets the value param to the parameter argv.
virtual int	updateParameter (int parameterID, Information &info)
	Updates the parameter identified by parameterID with info.
virtual int	activateParameter (int parameterID)
	Activates the parameter identified by parameterID.
virtual int	setVariable (const std::string &variable, Information &)
	Set the value of the variable idenfified by var.
virtual int	getVariable (const std::string &variable, Information &)
	Return the value of the variable idenfified by var.
Public Member Functions inherited from XC::DistributedBase
	DistributedBase (void)
	Constructor.
virtual	~DistributedBase (void)
	Destructor.
virtual DbTagData &	getDbTagData (void) const
	Returns a vector to store class dbTags.
const int &	getDbTagDataPos (const int &i) const
	Returns the data at the i-th position.
void	setDbTagDataPos (const int &i, const int &v)
	Sets the data at the i-th position.
void	inicComm (const int &dataSize) const
	Initializes communication.
Public Member Functions inherited from CommandEntity
	CommandEntity (CommandEntity *owr=nullptr)
	Default constructor.
CommandEntity *	Owner (void)
	Return a pointer to the object owner.
const CommandEntity *	Owner (void) const
	Return un puntero al objeto propietario de ESTE.
const StandardOutputWrapper &	getStandardOutputWrapper (void) const
	Return the regular output stream wrapper.
StandardOutputWrapper &	getStandardOutputWrapper (void)
	Return the regular output stream wrapper.
const std::string &	getLogFileName (void) const
	Returns log file name.
void	setLogFileName (const std::string &)
	Sets log file name.
const std::string &	getErrFileName (void) const
	Returns err file name.
void	setErrFileName (const std::string &)
	Sets error file name.
const std::string &	getOutputFileName (void) const
	Returns regular output file name.
void	setOutputFileName (const std::string &)
	Sets regular output file name.
boost::python::object	evalPy (boost::python::object dict, const std::string &)
	Return the Python object that results from evaluating the argument.
boost::python::object	execPy (boost::python::object dict, const std::string &)
	Return the Python objects that results from executing the code in the string argument.
boost::python::object	execFilePy (boost::python::object dict, const std::string &)
	Return the Python object that results from executing the code in the file.
Public Member Functions inherited from EntityWithProperties
	EntityWithProperties (EntityWithProperties *owr=nullptr)
	Default constructor.
void	clearPyProps (void)
	Clear python properties map.
bool	hasPyProp (const std::string &)
	Returns true if property exists.
boost::python::object	getPyProp (const std::string &str)
	Return the Python object with the name being passed as parameter.
void	setPyProp (std::string str, boost::python::object val)
	Sets/appends a value tho the Python object's dictionary.
void	copyPropsFrom (const EntityWithProperties &)
	Copy the properties from the argument.
boost::python::list	getPropNames (void) const
	Return the names of the object properties weightings.
const PythonDict &	getPropertiesDict (void) const
	Return a std::map container with the properties of the object.
boost::python::dict	getPyDict (void) const
	Return a Python dictionary containing the object members values.
void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.
Public Member Functions inherited from EntityWithOwner
	EntityWithOwner (EntityWithOwner *owr=nullptr)
	Default constructor.
	EntityWithOwner (const EntityWithOwner &)
	Copy constructor.
EntityWithOwner &	operator= (const EntityWithOwner &)
	Assignment operator.
virtual bool	operator== (const EntityWithOwner &) const
	Comparison operator.
virtual	~EntityWithOwner (void)
	Virtual destructor.
virtual std::string	getClassName (void) const
	Returns demangled class name.
void	set_owner (EntityWithOwner *owr)
	Assigns the owner of the object.
EntityWithOwner *	Owner (void)
const EntityWithOwner *	Owner (void) const

Protected Member Functions
virtual EigenSolver *	getCopy (void) const =0
virtual bool	setEigenSOE (EigenSOE *theSOE)=0
	EigenSolver (const int &classTag, const int &nModes=0)
	Constructor.
std::string	getWhich (const bool &shiftInvertMode=true) const
	Return a string identified which eigen values to compute; LM: compute the largest eigenvalues, SM: compute the smallest eigenvalues. More...
Protected Member Functions inherited from XC::Solver
	Solver (int classTag)
	Constructor. More...
Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const
Protected Member Functions inherited from EntityWithProperties
bool	isEqual (const EntityWithProperties &) const
	Return true if both objects are equal.
Protected Member Functions inherited from EntityWithOwner
virtual bool	isEqual (const EntityWithOwner &) const
	Return true if both objects are equal.

Protected Attributes
int	numModes
	number of eigenvalues to compute.
bool	generalized
	if true, generalized eigenvalue problem otherwise standard eigenvalue problem.
bool	findSmallest
	if true find the smallest eigenvalues.

Friends
class	EigenSOE

Additional Inherited Members
Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object >	PythonDict
Static Public Member Functions inherited from CommandEntity
static void	resetStandardOutput (void)
	Reset the standard output streams to its defaults buffers.
Static Public Member Functions inherited from EntityWithOwner
static int	getVerbosityLevel (void)
	Get the value of the verbosity level.
static void	setVerbosityLevel (const int &)
	Set the value of the verbosity level.
Static Protected Member Functions inherited from CommandEntity
static CommandEntity *	entcmd_cast (boost::any &data)
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Eigenvalue SOE solver.

Member Function Documentation

getAngularFrequencies()

XC::Vector XC::EigenSolver::getAngularFrequencies

(

void

)

const

Returns a vector with the computed angular frequencies for each mode.

getFrequencies()

XC::Vector XC::EigenSolver::getFrequencies

(

void

)

const

Returns a vector with the computed frequencies for each mode.

getNormalizedEigenvector()

XC::Vector XC::EigenSolver::getNormalizedEigenvector

(

int

i

)

const

Returns the autovector of the i-th mode normalized so the maximal component is 1 (infinity norm).

getNormalizedEigenvectors()

XC::Matrix XC::EigenSolver::getNormalizedEigenvectors

(

void

)

const

Returns a matrix with the normalized eigenvectors disposed in columns (infinity norm).

getPeriods()

XC::Vector XC::EigenSolver::getPeriods

(

void

)

const

Returns a vector with the computed periods for each mode.

getWhich()

std::string XC::EigenSolver::getWhich ( const bool &  shiftInvertMode = true ) const

protected

Return a string identified which eigen values to compute; LM: compute the largest eigenvalues, SM: compute the smallest eigenvalues.

Parameters

shiftInvertMode

if true use shift invert mode to compute eigenvalues.

solve()

virtual int XC::EigenSolver::solve ( void  )

pure virtual

Causes the solver to compute the solution of the system of equations.

Return $0$ if successful , negative number if not; the actual value depending on the type of Solver.

Implements XC::Solver.

Implemented in XC::BandArpackSolver, XC::FullGenEigenSolver, XC::ArpackSolver, XC::SymBandEigenSolver, XC::SymArpackSolver, XC::BandArpackppSolver, and XC::SpectraSolver.

---

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

• src/solution/system_of_eqn/eigenSOE/EigenSolver.h
• src/solution/system_of_eqn/eigenSOE/EigenSolver.cpp