EquiSolnAlgo is an abstract base class, i.e. More...

#include <EquiSolnAlgo.h>

Inheritance diagram for XC::EquiSolnAlgo:

Public Member Functions
virtual int	solveCurrentStep (void)=0
	steps taken in order to get the system into an equilibrium state. More...

virtual ConvergenceTest *	getConvergenceTestPtr (void)
	Returns a pointer to the convergence test.

virtual const ConvergenceTest *	getConvergenceTestPtr (void) const
	Returns a pointer to the convergence test.

virtual void	Print (std::ostream &, int flag=0)
	Send information to the stream based on the integer `flag`.

IncrementalIntegrator *	getIncrementalIntegratorPtr (void)
	Returns a pointer to the incremental integrator.

Public Member Functions inherited from XC::SolutionAlgorithm
virtual int	domainChanged (void)
	Perform the appropiate modifications as a result of a change in the domain. More...

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

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

virtual Integrator *	getIntegratorPtr (void)
	Return a pointer to the integrator.

virtual const Integrator *	getIntegratorPtr (void) const
	Return a const pointer to the integrator.

virtual LinearSOE *	getLinearSOEPtr (void)
	Return a pointer to the linear system of equations.

virtual const LinearSOE *	getLinearSOEPtr (void) const
	Return a const pointer to the linear system of equations.

virtual EigenSOE *	getEigenSOEPtr (void)
	Return a pointer to the eigen system of equations.

virtual const EigenSOE *	getEigenSOEPtr (void) const
	Return a const pointer to the eigen system of equations.

virtual const DomainSolver *	getDomainSolverPtr (void) const
	Return a const pointer to the DomainSolver.

virtual DomainSolver *	getDomainSolverPtr (void)
	Return a pointer to the DomainSolver.

virtual const Subdomain *	getSubdomainPtr (void) const
	Return a const pointer to the subdomain.

virtual Subdomain *	getSubdomainPtr (void)
	Return a pointer to the subdomain.

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 (CommParameters &)
	Return the object identifier in the database.

void	setDbTag (int dbTag)
	Sets the object identifier in the database.

void	setDbTag (CommParameters &)
	Sets the object identifier in the database if not already set. More...

virtual int	sendSelf (CommParameters &cp)=0
	Send the object. More...

virtual int	recvSelf (const CommParameters &cp)=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 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 XC::ObjWithRecorders
	ObjWithRecorders (CommandEntity owr, DataOutputHandler::map_output_handlers oh=nullptr)

virtual	~ObjWithRecorders (void)
	Destructor.

Recorder *	newRecorder (const std::string &, DataOutputHandler *oh=nullptr)
	Read a Recorder object from file.

virtual int	addRecorder (Recorder &theRecorder)
	Adds a recorder. More...

recorder_iterator	recorder_begin (void)

const_recorder_iterator	recorder_begin (void) const

recorder_iterator	recorder_end (void)

const_recorder_iterator	recorder_end (void) const

virtual int	record (int track, double timeStamp=0.0)
	To invoke {record(cTag, timeStamp)} on any Recorder objects which have been added. More...

void	restart (void)
	To invoke {restart()} on any Recorder objects which have been added. More...

virtual int	removeRecorders (void)
	Remove the recorders.

void	setLinks (Domain *dom)
	Asigna el domain a los recorders.

void	SetOutputHandlers (DataOutputHandler::map_output_handlers *oh)
	Set the outputhandlers container.

Protected Member Functions
	EquiSolnAlgo (AnalysisAggregation *, int clasTag)
	Constructor. More...

Protected Member Functions inherited from XC::SolutionAlgorithm
AnalysisAggregation *	getAnalysisAggregation (void)
	Return a pointer to the solution method which owns this object.

const AnalysisAggregation *	getAnalysisAggregation (void) const
	Return a pointer to the solution method which owns this object.

virtual Domain *	get_domain_ptr (void)
	Return a pointer to the domain.

int	sendData (CommParameters &)
	Send object members through the channel passed as parameter.

int	recvData (const CommParameters &)
	Receive object members through the channel passed as parameter.

	SolutionAlgorithm (AnalysisAggregation *, int classTag)
	Constructor.

virtual SolutionAlgorithm *	getCopy (void) const =0

Protected Member Functions inherited from XC::ObjWithRecorders
int	sendData (CommParameters &cp)

int	recvData (const CommParameters &cp)

size_t	getNumRecorders (void) const
	Returns the number of recorders already defined.

Additional Inherited Members
Public Types inherited from XC::ObjWithRecorders
typedef std::list< Recorder * >	lista_recorders

typedef lista_recorders::iterator	recorder_iterator

typedef lista_recorders::const_iterator	const_recorder_iterator

Detailed Description

EquiSolnAlgo is an abstract base class, i.e.

no objects of it's type can be created. An EquiSolnAlgo object defines the sequence of operations performed by the the Integrator and the LinearSOE objects in solving the equilibrium equation \(R(U) = 0\) given the current state of the domain at each time step in a direct integration analysis or load increment in a static analysis.

Constructor & Destructor Documentation

§ EquiSolnAlgo()

XC::EquiSolnAlgo::EquiSolnAlgo	(	AnalysisAggregation *	owr,
		int	classTag
	)

protected

Constructor.

Parameters

owr	AnalysisAggregation that owns this solution algorithm.
classTag	class identifier.

Member Function Documentation

§ solveCurrentStep()

virtual int XC::EquiSolnAlgo::solveCurrentStep ( void )

pure virtual

steps taken in order to get the system into an equilibrium state.

A method implemented by each subclass which specifies the steps taken in order to get the system into an equilibrium state. It is a pure virtual function, i.e. all subclasses or their descendents must implement this routine. To return \(0\) if algorithm succeeds, a negative value otherwise.

Implemented in XC::ModifiedNewton, XC::NewtonRaphson, XC::KrylovNewton, XC::Linear, XC::NewtonLineSearch, XC::BFGS, XC::Broyden, and XC::PeriodicNewton.

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

src/solution/analysis/algorithm/equiSolnAlgo/EquiSolnAlgo.h
src/solution/analysis/algorithm/equiSolnAlgo/EquiSolnAlgo.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ EquiSolnAlgo()

Member Function Documentation

§ solveCurrentStep()