Base class for the objects that performs the integration of physical properties over the domain to form the system stiffness matrix. More...

#include <Integrator.h>

Inheritance diagram for XC::Integrator:

[legend]

Collaboration diagram for XC::Integrator:

[legend]

Public Member Functions
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 int	formEleTangent (FE_Element *theEle)=0
	Called upon to determine the FE_Element `theEles` matrix contribution to the SystemOfEqn object. More...

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

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

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

virtual int	getLastResponse (Vector &result, const ID &id)=0
	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 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	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 &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.

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.

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
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...

virtual Integrator *	getCopy (void) const =0

Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const

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 the objects that performs the integration of physical properties over the domain to form the system stiffness matrix.

The Integrator class is an abstract base class. Its purpose is to define the interface common among all subclasses. An integrator method is responsible for defining how the system of equations are set up (this it does by specifying how the FE_Element and DOF_Group objects of the analysis model construct the vectors and matrices asked of them by the Analysis). It is also responsible for updating the response quantities at the DOFs with the appropriate values; the values are determined from the solution to the system of equations.

Constructor & Destructor Documentation

◆ Integrator()

XC::Integrator::Integrator	(	SolutionStrategy *	owr,
		int	clasTag
	)

protected

Constructor.

Parameters

owr	set of objects used to perform the analysis.

Member Function Documentation

◆ domainChanged()

int XC::Integrator::domainChanged ( void )

virtual

Make required changes when a change in the domain occurs.

Is called by the Analysis object. Refer to the Analysis classes to see when it is invoked. To return \(0\) if successful, a negative number if not. This base class returns \(0\).

Reimplemented in XC::DisplacementControl, XC::MinUnbalDispNorm, XC::DistributedDisplacementControl, XC::EQPath, and XC::ProtoArcLength.

◆ formEleResidual()

virtual int XC::Integrator::formEleResidual ( FE_Element * theEle )

pure virtual

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

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

Implemented in XC::StaticIntegrator, XC::IncrementalIntegrator, XC::EigenIntegrator, and XC::StaticSensitivityIntegrator.

◆ formEleTangent()

virtual int XC::Integrator::formEleTangent ( FE_Element * theEle )

pure virtual

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

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

Implemented in XC::StaticIntegrator, XC::IncrementalIntegrator, and XC::EigenIntegrator.

◆ formNodTangent()

virtual int XC::Integrator::formNodTangent ( DOF_Group * theDof )

pure virtual

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

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

Implemented in XC::StaticIntegrator, XC::IncrementalIntegrator, and XC::EigenIntegrator.

◆ formNodUnbalance()

virtual int XC::Integrator::formNodUnbalance ( DOF_Group * theDof )

pure virtual

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

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

Implemented in XC::StaticIntegrator, XC::IncrementalIntegrator, and XC::EigenIntegrator.

◆ getAnalysisModelPtr() [1/2]

XC::AnalysisModel * XC::Integrator::getAnalysisModelPtr ( void )

protectedvirtual

Returns a pointer to the analysis model.

A member function which returns a pointer to the AnalysisModel associated with the Integrator object, i.e. theModel.

◆ getAnalysisModelPtr() [2/2]

const XC::AnalysisModel * XC::Integrator::getAnalysisModelPtr ( void ) const

protectedvirtual

Returns a pointer to the analysis model.

A const member function which returns a const pointer to the AnalysisModel associated with the Integrator object, i.e. theModel.

◆ getLastResponse()

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

pure 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.

Implemented in XC::IncrementalIntegrator, and XC::EigenIntegrator.

◆ Print()

void XC::Integrator::Print	(	std::ostream &	os,
		int	flag = `0`
	)		const

virtual

The Integrator is to send information to the stream based on the integer flag.

Reimplemented in XC::DisplacementControl, XC::LoadControl, XC::DistributedDisplacementControl, XC::StaticSensitivityIntegrator, XC::HSConstraint, XC::EQPath, and XC::LinearBucklingIntegrator.

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

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Integrator()

Member Function Documentation

◆ domainChanged()

◆ formEleResidual()

◆ formEleTangent()

◆ formNodTangent()

◆ formNodUnbalance()

◆ getAnalysisModelPtr() [1/2]

◆ getAnalysisModelPtr() [2/2]

◆ getLastResponse()

◆ Print()