Base class for eigenproblem systems of equations. More...
#include <EigenSOE.h>
Inheritance diagram for XC::EigenSOE:
Collaboration diagram for XC::EigenSOE:
Public Types | |
| typedef boost::numeric::ublas::mapped_matrix< double > | sparse_matrix |
 Public Types inherited from EntityWithProperties | |
| typedef std::map< std::string, boost::python::object > | PythonDict |
Public Member Functions | |
| 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... | |
| virtual int | addA (const Matrix &, const ID &, double fact=1.0)=0 |
| virtual int | addM (const Matrix &, const ID &, double fact=1.0)=0 |
| virtual int | setSize (Graph &theGraph)=0 |
| virtual void | zeroA (void)=0 |
| virtual void | zeroM (void) |
| Anula la matrix M. | |
| virtual void | identityM (void) |
| Makes M the identity matrix (to find stiffness matrix eigenvalues). | |
| virtual boost::python::list | getMPy (void) const |
| Return the rows of the mass matrix in a Python list. | |
| const int & | getNumModes (void) const |
| Returns the number of computed eigenvalues. | |
| bool | standardProblem (void) const |
| virtual const Vector & | getEigenvector (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... | |
| EigenSolver * | getSolver (void) |
| Return a pointer to the solver used to solve the eigenproblem. | |
| EigenSolver & | newSolver (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. | |
| virtual void | save (void) const |
| Stores the matrices and vectors in a temporal file. | |
| virtual void | restore (void) |
| Restore the matrices and vectors from a temporal file. | |
| virtual boost::python::list | getAPy (void) const |
| Return a Python list containing the rows 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. | |
| 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 ¶m) |
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 | |
| void | free_mem (void) |
| void | copy (const EigenSolver *) |
| virtual bool | setSolver (EigenSolver *) |
| Set the solver. | |
| void | resize_mass_matrix_if_needed (const size_t &) |
| EigenSOE (SolutionStrategy *, int classTag) | |
| Constructor. | |
| Protected Member Functions inherited from XC::SystemOfEqn | |
| virtual AnalysisModel * | getAnalysisModelPtr (void) |
| Returns a pointer to the analysis model. | |
| virtual const AnalysisModel * | getAnalysisModelPtr (void) const |
| Returns a const pointer to the analysis model. | |
| SystemOfEqn (SolutionStrategy *, int classTag) | |
| Constructor. More... | |
| virtual SystemOfEqn * | getCopy (void) const =0 |
| Virtual constructor. | |
| 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 | size |
| order of A | |
| bool | factored |
| sparse_matrix | massMatrix |
| Mass matrix (used in getModalParticipationFactor). | |
| EigenSolver * | theSolver |
| Protected Attributes inherited from XC::SystemOfEqn | |
| std::string | tmpFileName |
| File name to store matrices. | |
Additional Inherited Members | |
| 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
Base class for eigenproblem systems of equations.
Member Function Documentation
◆ getAngularFrequencies()
| XC::Vector XC::EigenSOE::getAngularFrequencies | ( | void | ) | const |
Returns a vector with the computed angular frequencies for each mode.
◆ getDistributionFactors()
| XC::Matrix XC::EigenSOE::getDistributionFactors | ( | void | ) | const |
Returns a matrix with the computed distribution factors placed by columns.
◆ getEigenvector()
|
virtual |
Return the autovector that correspond to the mode being passed as parameter.
◆ getEigenvectors()
| XC::Matrix XC::EigenSOE::getEigenvectors | ( | void | ) | const |
Returns a matrix with the computed eigenvectors disposed by columns.
◆ getEquivalentStaticLoad()
| XC::Vector XC::EigenSOE::getEquivalentStaticLoad | ( | int | mode, |
| const double & | accel_mode | ||
| ) | const |
Return the equivalent static force for the mode passed as parameter.
◆ getFrequencies()
| XC::Vector XC::EigenSOE::getFrequencies | ( | void | ) | const |
Returns a vector with the computed frequencies for each mode.
◆ getNormalizedEigenvector()
| XC::Vector XC::EigenSOE::getNormalizedEigenvector | ( | int | mode | ) | const |
Returns the normalized autovector that correspond to the mode being passed as parameter.
The vector is normalized to make the maximum of the absolute values of its components to be 1 (infinity_norm(v)= 1).
◆ getNormalizedEigenvectors()
| XC::Matrix XC::EigenSOE::getNormalizedEigenvectors | ( | void | ) | const |
Returns a matrix whit the normalized eigenvectors disposed by columns (infinity norm).
◆ getPeriods()
| XC::Vector XC::EigenSOE::getPeriods | ( | void | ) | const |
Returns a vector with the computed periods for each mode.
◆ getRCond()
|
virtual |
Returns the reciprocal of the condition number.
Computes the reciprocal of the condition number using the norm specified by the char argument: if norm = '1' or 'O', then the routine estimates the condition number of matrix in 1-norm, if norm = 'I', then the routine estimates the condition number of matrix in infinity-norm.
◆ newSolver()
| XC::EigenSolver & XC::EigenSOE::newSolver | ( | const std::string & | type | ) |
Set the solver to use.
- Parameters
-
type solver type to use.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/eigenSOE/EigenSOE.h
- src/solution/system_of_eqn/eigenSOE/EigenSOE.cpp
