XC::EigenAnalysis Class Reference

Eigenproblem analysis. More...

#include <EigenAnalysis.h>

Inheritance diagram for XC::EigenAnalysis:

Collaboration diagram for XC::EigenAnalysis:

Public Member Functions
virtual int	analyze (int numModes)
	Performs the analysis. More...
void	clearAll (void)
	Clears all object members (constraint handler, analysis model,...).
virtual int	domainChanged (void)
	Make the changes derived of a change in the domain.
virtual int	setAlgorithm (EigenAlgorithm &theAlgo)
	Sets the algorithm to use in the analysis.
virtual int	setIntegrator (EigenIntegrator &theIntegrator)
	Sets the integrator to use in the analysis.
virtual int	setEigenSOE (EigenSOE &theSOE)
	Sets the system of eigenvalues to use in the analysis.
int	getDomainStamp (void) const
void	setDomainStamp (const int &i)
virtual const Vector &	getEigenvector (int mode) const
	Returns the autovector that corresponds 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...
boost::python::list	getNormalizedEigenvectorPy (int mode) const
	Return a Python list with the component of the eigenvector corrsponding to the given mode. More...
Matrix	getEigenvectors (void) const
	Returns a matrix with the computed eigenvectors as columns of the matrix. More...
Matrix	getNormalizedEigenvectors (void) const
	Returns a matrix with the normalized eigenvectors (infinity norm) as columns of the matrix. More...
boost::python::list	getNormalizedEigenvectorsPy (void) const
	Returns a Python list with the computed eigenvectors as lists.
virtual const double &	getEigenvalue (int mode) const
	Returns the eigenvalue that corresponds to the mode being passed as parameter. 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 with the computed eigenvalues for each mode.
boost::python::list	getEigenvaluesPy (void) const
	Returns a Python list with the computed eigenvalues for each mode.
Vector	getAngularFrequencies (void) const
	Returns a vector with the computed angular frequencies for each mode.
Vector	getPeriods (void) const
	Returns a vector with the computed vectors for each mode.
Vector	getFrequencies (void) const
	Returns a vector with the computed frequencies.
int	getNumModes (void) const
	Returns the number of computed eigenvalues.
virtual double	getModalParticipationFactor (int mode) const
	Returns the modal participation factor corresponding to i mode.
Vector	getModalParticipationFactors (void) const
	Returns the modal participation factors.
Vector	getDistributionFactor (int mode) const
	Returns the distribution factor correspondint to the mode being passed as parameter. More...
Matrix	getDistributionFactors (void) const
	Returns a matrix with the distribution factors by columns. More...
double	getEffectiveModalMass (int mode) const
	Return the masa modal efectiva correspondiente al modo i. More...
Vector	getEffectiveModalMasses (void) const
	Returns the masas modales efectivas.
double	getTotalMass (void) const
	Return the masa total del modelo.
Vector	getEquivalentStaticLoad (int mode, const double &) const
	Returns the equivalent static load for the mode being passed as parameter. More...
Public Member Functions inherited from XC::Analysis
SolutionStrategy *	getSolutionStrategyPtr (void)
	Returns the solution strategy to which this analysis belongs. More...
Domain *	getDomainPtr (void)
	Returns a pointer to the domain.
const Domain *	getDomainPtr (void) const
	Returns a pointer to the domain.
ConstraintHandler *	getConstraintHandlerPtr (void)
	Returns a pointer to the constraint handler.
DOF_Numberer *	getDOF_NumbererPtr (void) const
	Returns a pointer to the DOF numberer.
AnalysisModel *	getAnalysisModelPtr (void) const
	Returns a pointer to the analysis model.
LinearSOE *	getLinearSOEPtr (void) const
	Returns a pointer to the linear system of equations.
EigenSOE *	getEigenSOEPtr (void) const
	Returns a pointer to the system of equations de eigenvalues.
Integrator *	getIntegratorPtr (void)
	Returns, if possible, a pointer al integrator otherwise it returns nullptr.
const Integrator *	getIntegratorPtr (void) const
	Returns, if possible, a pointer al integrator otherwise it returns nullptr.
IncrementalIntegrator *	getIncrementalIntegratorPtr (void)
	Returns, if possible, a pointer al integrator incremental otherwise it returns nullptr.
EigenIntegrator *	getEigenIntegratorPtr (void)
	Returns, if possible, a pointer al EigenIntegrator otherwise it returns nullptr.
LinearBucklingIntegrator *	getLinearBucklingIntegratorPtr (void)
	Returns, if possible, a pointer al LinearBucklingIntegrator otherwise it returns nullptr.
TransientIntegrator *	getTransientIntegratorPtr (void)
	Returns, if possible, a pointer al EigenIntegrator otherwise it returns nullptr.
StaticIntegrator *	getStaticIntegratorPtr (void)
	Returns, if possible, a pointer al StaticIntegrator otherwise it returns nullptr.
SolutionAlgorithm *	getSolutionAlgorithmPtr (void)
EigenAlgorithm *	getEigenSolutionAlgorithmPtr (void)
	Return a pointer to the eigenproblem solution algorithm (if it's not defined it returns nullptr). More...
EquiSolnAlgo *	getEquiSolutionAlgorithmPtr (void)
	Return a pointer to the linear SOE solution algorithm (if it's not defined it returns nullptr). More...
DomainDecompAlgo *	getDomainDecompSolutionAlgorithmPtr (void)
	Return a pointer to the domain decomposition solution algorithm (if it's not defined it returns nullptr). More...
virtual ConvergenceTest *	getConvergenceTestPtr (void)
	Returns a pointer to the convergence test (only for suitable analysis).
virtual const ConvergenceTest *	getConvergenceTestPtr (void) const
	Returns a pointer to the convergence test (only for suitable analysis).
virtual const DomainSolver *	getDomainSolver (void) const
	Returns a pointer to the DomainSolver.
virtual DomainSolver *	getDomainSolver (void)
	Returns a pointer to the DomainSolver.
virtual const Subdomain *	getSubdomain (void) const
	Returns a pointer to the subdomain.
virtual Subdomain *	getSubdomain (void)
	Returns a pointer to the subdomain.
virtual int	setNumberer (DOF_Numberer &theNumberer)
	Sets the renumerador to use in the analysis.
virtual int	setLinearSOE (LinearSOE &theSOE)
	Sets the linear system of equations to use in the analysis.
virtual int	setIntegrator (Integrator &theNewIntegrator)
	Sets the integrator to use in the analysis.
virtual int	setAlgorithm (SolutionAlgorithm &theNewAlgorithm)
	Set the solution algorithm to be used in the analysis.
void	brokeConstraintHandler (const Communicator &, const ID &)
void	brokeNumberer (const Communicator &, const ID &)
void	brokeAnalysisModel (const Communicator &, const ID &)
void	brokeDDLinearSOE (const Communicator &, const ID &)
void	brokeLinearSOE (const Communicator &, const ID &)
void	brokeIncrementalIntegrator (const Communicator &, const ID &)
void	brokeStaticIntegrator (const Communicator &, const ID &)
void	brokeTransientIntegrator (const Communicator &, const ID &)
void	brokeDomainDecompAlgo (const Communicator &, const ID &)
void	brokeEquiSolnAlgo (const Communicator &, const ID &)
int	getAnalysisResult (void) const
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
	EigenAnalysis (SolutionStrategy *analysis_aggregation)
	Constructor.
Analysis *	getCopy (void) const
	Virtual constructor.
Protected Member Functions inherited from XC::Analysis
int	newStepDomain (AnalysisModel *theModel, const double &dT=0.0)
SolutionProcedure *	getSolutionProcedure (void)
const SolutionProcedure *	getSolutionProcedure (void) const
	Analysis (SolutionStrategy *analysis_aggregation)
	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	domainStamp
Protected Attributes inherited from XC::Analysis
int	analysis_result
	Equal to zero if success.
SolutionStrategy *	solution_strategy
	Solution strategy.

Friends
class	SolutionProcedure

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

Eigenproblem analysis.

Member Function Documentation

analyze()

int XC::EigenAnalysis::analyze ( int  numModes )

virtual

Performs the analysis.

Parameters

numModes

number of modes to compute.

getDistributionFactor()

XC::Vector XC::EigenAnalysis::getDistributionFactor

(

int

mode

)

const

Returns the distribution factor correspondint to the mode being passed as parameter.

getDistributionFactors()

XC::Matrix XC::EigenAnalysis::getDistributionFactors

(

void

)

const

Returns a matrix with the distribution factors by columns.

getEffectiveModalMass()

double XC::EigenAnalysis::getEffectiveModalMass

(

int

mode

)

const

Return the masa modal efectiva correspondiente al modo i.

getEigenvalue()

const double & XC::EigenAnalysis::getEigenvalue ( int  mode ) const

virtual

Returns the eigenvalue that corresponds to the mode being passed as parameter.

Reimplemented in XC::LinearBucklingEigenAnalysis.

getEigenvector()

const XC::Vector & XC::EigenAnalysis::getEigenvector ( int  mode ) const

virtual

Returns the autovector that corresponds to the mode being passed as parameter.

getEigenvectors()

XC::Matrix XC::EigenAnalysis::getEigenvectors

(

void

)

const

Returns a matrix with the computed eigenvectors as columns of the matrix.

getEquivalentStaticLoad()

XC::Vector XC::EigenAnalysis::getEquivalentStaticLoad	(	int	mode,
		const double &	accel_mode
	)		const

Returns the equivalent static load for the mode being passed as parameter.

getNormalizedEigenvector()

XC::Vector XC::EigenAnalysis::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).

getNormalizedEigenvectorPy()

boost::python::list XC::EigenAnalysis::getNormalizedEigenvectorPy

(

int

mode

)

const

Return a Python list with the component of the eigenvector corrsponding to the given mode.

getNormalizedEigenvectors()

XC::Matrix XC::EigenAnalysis::getNormalizedEigenvectors

(

void

)

const

Returns a matrix with the normalized eigenvectors (infinity norm) as columns of the matrix.

---

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

• src/solution/analysis/analysis/EigenAnalysis.h
• src/solution/analysis/analysis/EigenAnalysis.cpp