xc
Public Member Functions | Protected Member Functions | Friends | List of all members

Band symmetric matrix eigenvaules system of equations. More...

#include <SymBandEigenSOE.h>

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

Public Member Functions

virtual int setSize (Graph &theGraph)
 Sets the size of the system from the number of vertices in the graph.
 
virtual int addA (const Matrix &, const ID &, double fact=1.0)
 Assemblies into A the matrix being passed as parameter multimplied by the fact parameter. More...
 
virtual int addM (const Matrix &, const ID &, double fact=1.0)
 Assemblies into A the matrix being passed as parameter multimplied by the fact parameter. More...
 
virtual void zeroA (void)
 Zeroes the matrix A.
 
virtual void zeroM (void)
 Zeroes the matrix M.
 
virtual void identityM (void)
 Makes M the identity matrix (to find stiffness matrix eigenvalues).
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
virtual void save (void) const
 Save the SOE matrices and vectors to file. More...
 
virtual void restore (void)
 Restore the SOE matrices and vectors from file. More...
 
- Public Member Functions inherited from XC::EigenSOE
virtual ~EigenSOE (void)
 Destructor.
 
int getNumEqn (void) const
 Returns the number of equations.
 
virtual int solve (int numModes)
 Solve the eigenproblem con the number of modos passed as parameter.
 
virtual int solve (void)
 Do nothing.
 
virtual double getDeterminant (void)
 Returns the determinant of the system matrix.
 
virtual double getRCond (const char &norm='1')
 Returns the reciprocal of the condition number. More...
 
const int & getNumModes (void) const
 Returns the number of computed eigenvalues.
 
bool standardProblem (void) const
 
virtual const VectorgetEigenvector (int mode) const
 Return the autovector that correspond to the mode being passed as parameter. More...
 
Vector getNormalizedEigenvector (int mode) const
 Returns the normalized autovector that correspond to the mode being passed as parameter. More...
 
Matrix getEigenvectors (void) const
 Returns a matrix with the computed eigenvectors disposed by columns. More...
 
Matrix getNormalizedEigenvectors (void) const
 Returns a matrix whit the normalized eigenvectors disposed by columns (infinity norm). More...
 
virtual const double & getEigenvalue (int mode) const
 Returns the eigenvalue of the mode passed as parameter.
 
double getAngularFrequency (int mode) const
 Returns the angular frequency of the i-th mode.
 
double getPeriod (int mode) const
 Returns the period of the i-th mode.
 
double getFrequency (int mode) const
 Return the frequency of the i-th mode.
 
Vector getEigenvalues (const int &numModes) const
 Returns a vector with computed eigenvalues for each mode.
 
Vector getEigenvalues (void) const
 Returns a vector with computed eigenvalues for each mode.
 
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 double getModalParticipationFactor (int mode) const
 Returns the modal participation factor for the mode.
 
Vector getModalParticipationFactors (const int &numModes) const
 Returns the modal participation factors.
 
Vector getModalParticipationFactors (void) const
 Returns the modal participation factors.
 
Vector getDistributionFactor (int mode) const
 Returns the distribution factors for the i-th mode.
 
Matrix getDistributionFactors (void) const
 Returns a matrix with the computed distribution factors placed by columns. More...
 
double getEffectiveModalMass (int mode) const
 Return the effective modal mass for the i-th mode.
 
Vector getEffectiveModalMasses (void) const
 Returns the effective modal masses for each mode.
 
double getTotalMass (void) const
 Return the model total mass.
 
Vector getEquivalentStaticLoad (int mode, const double &) const
 Return the equivalent static force for the mode passed as parameter. More...
 
EigenSolvergetSolver (void)
 Return a pointer to the solver used to solve the eigenproblem.
 
EigenSolvernewSolver (const std::string &)
 Set the solver to use. More...
 
- Public Member Functions inherited from XC::SystemOfEqn
int checkSize (Graph &theGraph) const
 Check number of DOFs in the graph.
 
- 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
 

Protected Member Functions

bool setSolver (EigenSolver *)
 Sets the solver that will be used to solve the eigenvalue problem.
 
 SymBandEigenSOE (SolutionStrategy *)
 Constructor.
 
SystemOfEqngetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::EigenSOE
void free_mem (void)
 
void copy (const EigenSolver *)
 
void resize_mass_matrix_if_needed (const size_t &)
 
 EigenSOE (SolutionStrategy *, int classTag)
 Constructor.
 
- Protected Member Functions inherited from XC::SystemOfEqn
virtual AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the analysis model.
 
virtual const AnalysisModelgetAnalysisModelPtr (void) const
 Returns a const pointer to the analysis model.
 
 SystemOfEqn (SolutionStrategy *, int classTag)
 Constructor. More...
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 

Friends

class SolutionStrategy
 
class FEM_ObjectBroker
 
class SymBandEigenSolver
 

Additional Inherited Members

- Public Types inherited from XC::EigenSOE
typedef boost::numeric::ublas::mapped_matrix< double > sparse_matrix
 
- 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 CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::EigenSOE
int size
 order of A
 
bool factored
 
sparse_matrix massMatrix
 Mass matrix (used in getModalParticipationFactor).
 
EigenSolvertheSolver
 
- Protected Attributes inherited from XC::SystemOfEqn
std::string tmpFileName
 File name to store matrices.
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Band symmetric matrix eigenvaules system of equations.

Member Function Documentation

◆ addA()

int XC::SymBandEigenSOE::addA ( const Matrix m,
const ID id,
double  fact = 1.0 
)
virtual

Assemblies into A the matrix being passed as parameter multimplied by the fact parameter.

Implements XC::EigenSOE.

◆ addM()

int XC::SymBandEigenSOE::addM ( const Matrix m,
const ID id,
double  fact = 1.0 
)
virtual

Assemblies into A the matrix being passed as parameter multimplied by the fact parameter.

Implements XC::EigenSOE.

◆ recvSelf()

int XC::SymBandEigenSOE::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.

◆ restore()

void XC::SymBandEigenSOE::restore ( void  )
virtual

Restore the SOE matrices and vectors from file.

Normally it's used to restore those objects from disk after executing getRCond to avoid interferences with solve (different types of factorization...).

Reimplemented from XC::SystemOfEqn.

◆ save()

void XC::SymBandEigenSOE::save ( void  ) const
virtual

Save the SOE matrices and vectors to file.

Normally it's used to store temporarily those objects on disk while executing getRCond to avoid interferences with solve (different types of factorization...).

Reimplemented from XC::SystemOfEqn.

◆ sendSelf()

int XC::SymBandEigenSOE::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.


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