xc
Public Member Functions | Friends | List of all members

base class for full (dense) matrix eigenvalue SOE solvers. More...

#include <FullGenEigenSolver.h>

Inheritance diagram for XC::FullGenEigenSolver:
XC::EigenSolver XC::Solver XC::MovableObject XC::DistributedBase

Public Member Functions

virtual int solve (void)
 Causes the solver to compute the solution of the system of equations. More...
 
virtual int solve (int numEigen)
 
virtual int setSize (void)
 
const int & getSize (void) const
 Return the eigenvectors dimension.
 
virtual bool setEigenSOE (FullGenEigenSOE &theSOE)
 Sets the eigenproblem to solve.
 
virtual const VectorgetEigenvector (int mode) const
 
virtual const double & getEigenvalue (int mode) const
 
int sendSelf (CommParameters &)
 Send the object. More...
 
int recvSelf (const CommParameters &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::EigenSolver
const int & getNumModes (void) const
 
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 getPeriodo (int mode) const
 Returns the period for the i-th mode.
 
double getFrecuencia (int mode) const
 Return the frecuency 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 getPeriodos (void) const
 Returns a vector with the computed periods for each mode. More...
 
Vector getFrecuencias (void) const
 Returns a vector with the computed frequencies for each mode. 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.
 
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 (CommParameters &)
 Return the object identifier in the database.
 
void setDbTag (int dbTag)
 Sets the object identifier in the database.
 
void setDbTag (CommParameters &)
 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 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.
 

Friends

class EigenSOE
 

Additional Inherited Members

- Protected Member Functions inherited from XC::EigenSolver
 EigenSolver (const int &classTag, const int &nModes=0)
 Constructor.
 
- Protected Member Functions inherited from XC::Solver
 Solver (int classTag)
 Constructor. More...
 
- Protected Attributes inherited from XC::EigenSolver
int numModes
 number of eigenvalues to compute.
 

Detailed Description

base class for full (dense) matrix eigenvalue SOE solvers.

Member Function Documentation

§ recvSelf()

int XC::FullGenEigenSolver::recvSelf ( const CommParameters cp)
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::FullGenEigenSolver::sendSelf ( CommParameters cp)
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::FullGenEigenSolver::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: