Base class for eigenproblem integrators. More...

#include <EigenIntegrator.h>

Inheritance diagram for XC::EigenIntegrator:

Collaboration diagram for XC::EigenIntegrator:

Public Member Functions
virtual int	formK (void)
	Stiffness matrix assembly.

virtual int	formM (void)
	Mass matrix assembly.

virtual int	formEleTangK (FE_Element *theEle)
	Asks the element being passed as parameter to build its tangent stiffness matrix. More...

virtual int	formEleTangM (FE_Element *theEle)
	Asks the element being passed as parameter to build its mass matrix. More...

virtual int	formNodTangM (DOF_Group *theDof)

virtual int	update (const Vector &deltaU)

virtual int	formEleTangent (FE_Element *theEle)
	Asks the element being passed as parameter to build its mass(flagK= false) or stiffness matrix (flagK= true). More...

virtual int	formNodTangent (DOF_Group *theDof)
	Called upon to determine the DOF_Group `theDofs` matrix contribution to the SystemOfEqn object. More...

virtual int	formEleResidual (FE_Element *theEle)
	Called upon to determine the FE_Element `theEles` vector contribution to the SystemOfEqn object. More...

virtual int	formNodUnbalance (DOF_Group *theDof)
	Called upon to determine the DOF_Group `theDofs` vector contribution to the SystemOfEqn object. More...

virtual int	newStep (void)

virtual int	getLastResponse (Vector &result, const ID &id)
	Called upon to get the result quantities for the components specified in the ID `id` and to place them in the Vector `result`. More...

virtual int	sendSelf (Communicator &)
	Send the object. More...

virtual int	recvSelf (const Communicator &)
	Receive the object. More...

Public Member Functions inherited from XC::Integrator
virtual int	domainChanged (void)
	Make required changes when a change in the domain occurs. More...

double	getCurrentModelTime (void) const

void	setCurrentModelTime (const double &t)

virtual void	Print (std::ostream &s, int flag=0) const
	The Integrator is to send information to the stream based on the integer `flag`. 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.

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	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 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
EigenSOE *	getEigenSOEPtr (void)
	Returns a pointer to the system of equations de eigenvalues.

const EigenSOE *	getEigenSOEPtr (void) const
	Returns a pointer to the system of equations de eigenvalues.

	EigenIntegrator (SolutionStrategy *)
	Constructor.

Integrator *	getCopy (void) const

Protected Member Functions inherited from XC::Integrator
SolutionStrategy *	getSolutionStrategy (void)
	Returns a pointer to the solution method that owns this object.

const SolutionStrategy *	getSolutionStrategy (void) const
	Returns a const pointer to the solution method that owns this object.

void	applyLoadModel (double newTime)

int	updateModel (void)

int	updateModel (double newTime, double dT)

int	commitModel (void)

void	setRayleighDampingFactors (const RayleighDampingFactors &rF)

int	sendData (Communicator &)
	Send object members through the communicator argument.

int	recvData (const Communicator &)
	Receives object members through the communicator argument.

virtual AnalysisModel *	getAnalysisModelPtr (void)
	Returns a pointer to the analysis model. More...

virtual const AnalysisModel *	getAnalysisModelPtr (void) const
	Returns a pointer to the analysis model. More...

	Integrator (SolutionStrategy *, int classTag)
	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	flagK

Friends
class	SolutionStrategy

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

Base class for eigenproblem integrators.

Member Function Documentation

◆ formEleResidual()

int XC::EigenIntegrator::formEleResidual ( FE_Element * theEle )

virtual

Called upon to determine the FE_Element theEles vector contribution to the SystemOfEqn object.

To return \(0\) if successful, a negative number otherwise.

Implements XC::Integrator.

◆ formEleTangent()

int XC::EigenIntegrator::formEleTangent ( FE_Element * theEle )

virtual

Asks the element being passed as parameter to build its mass(flagK= false) or stiffness matrix (flagK= true).

Implements XC::Integrator.

◆ formEleTangK()

int XC::EigenIntegrator::formEleTangK ( FE_Element * theEle )

virtual

Asks the element being passed as parameter to build its tangent stiffness matrix.

◆ formEleTangM()

int XC::EigenIntegrator::formEleTangM ( FE_Element * theEle )

virtual

Asks the element being passed as parameter to build its mass matrix.

Reimplemented in XC::KEigenIntegrator.

◆ formNodTangent()

int XC::EigenIntegrator::formNodTangent ( DOF_Group * theDof )

virtual

Called upon to determine the DOF_Group theDofs matrix contribution to the SystemOfEqn object.

To return \(0\) if successful, a negative number otherwise.

Implements XC::Integrator.

◆ formNodUnbalance()

int XC::EigenIntegrator::formNodUnbalance ( DOF_Group * theDof )

virtual

Called upon to determine the DOF_Group theDofs vector contribution to the SystemOfEqn object.

To return \(0\) if successful, a negative number otherwise.

Implements XC::Integrator.

◆ getLastResponse()

int XC::EigenIntegrator::getLastResponse	(	Vector &	result,
		const ID &	id
	)

virtual

Called upon to get the result quantities for the components specified in the ID id and to place them in the Vector result.

This is provided for domain decomposition methods. To return \(0\) if successful, a negative number otherwise.

Implements XC::Integrator.

◆ recvSelf()

int XC::EigenIntegrator::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::EigenIntegrator::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:

src/solution/analysis/integrator/EigenIntegrator.h
src/solution/analysis/integrator/EigenIntegrator.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ formEleResidual()

◆ formEleTangent()

◆ formEleTangK()

◆ formEleTangM()

◆ formNodTangent()

◆ formNodUnbalance()

◆ getLastResponse()

◆ recvSelf()

◆ sendSelf()