xc
Public Member Functions | Friends | List of all members

Base class for symmetric band matrix eigenvalue SOE solvers. More...

#include <SymBandEigenSolver.h>

Inheritance diagram for XC::SymBandEigenSolver:
Inheritance graph
[legend]
Collaboration diagram for XC::SymBandEigenSolver:
Collaboration graph
[legend]

Public Member Functions

virtual int solve (void)
 Causes the solver to compute the solution of the system of equations. More...
 
virtual int setSize (void)
 
const int & getSize (void) const
 Return the eigenvectors dimension.
 
virtual bool setEigenSOE (SymBandEigenSOE &theSOE)
 Sets the eigenproblem to solve.
 
virtual const VectorgetEigenvector (int mode) const
 
virtual const double & getEigenvalue (int mode) const
 
double getRCond (const char &)
 Estimates the reciprocal of the condition number of a real general band matrix A, in either the 1-norm or the infinity-norm, using the LU factorization computed by DGBTRF. More...
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::EigenSolver
virtual int solve (int numModes)
 
const int & getNumModes (void) const
 
bool getFindSmallest (void) const
 
void setFindSmallest (const bool &b)
 
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...
 
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...
 
- Public Member Functions inherited from XC::Solver
virtual double getDeterminant (void)
 Return the determinant of the system matrix.
 
- 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.
 
MovableObjectoperator= (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 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 DbTagDatagetDbTagData (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.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

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.
 
- Protected Member Functions inherited from XC::EigenSolver
 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
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::EigenSolver
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.
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Base class for symmetric band matrix eigenvalue SOE solvers.

Member Function Documentation

◆ getRCond()

double XC::SymBandEigenSolver::getRCond ( const char &  c)
virtual

Estimates the reciprocal of the condition number of a real general band matrix A, in either the 1-norm or the infinity-norm, using the LU factorization computed by DGBTRF.

Parameters
cSpecifies whether the 1-norm condition number or the infinity-norm condition number is required: = '1' or 'O': 1-norm; = 'I': Infinity-norm.

Reimplemented from XC::Solver.

◆ recvSelf()

int XC::SymBandEigenSolver::recvSelf ( const Communicator comm)
virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

◆ sendSelf()

int XC::SymBandEigenSolver::sendSelf ( Communicator comm)
virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.

◆ solve()

int XC::SymBandEigenSolver::solve ( void  )
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::EigenSolver.


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